堡垒机接口调用是向堡垒机API的服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。

请求结构

堡垒机的API是RPC风格,您可以通过发送HTTP GET请求调用堡垒机API。

其请求结构如下:
http://Endpoint/?Action=xx&Parameters
其中:
  • Endpoint:堡垒机API的服务接入地址为yundun-bastionhost.aliyuncs.com
    说明 堡垒机API的服务接入地址以DescribeRegions返回的对应Region的RegionEndpoint为主。
  • Action:要执行的操作,如调用TagResources查询已创建的堡垒机实例。
  • Version:要使用的API版本,堡垒机的API版本是2019-12-09
  • Parameters:请求参数,每个参数之间用“&”分隔。

    请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详情请参见公共参数

下面是一个调用TagResources接口查询已创建的堡垒机实例的示例:
说明 为了便于用户查看,本文档中的示例都做了格式化处理。
https://yundun-bastionhost.aliyuncs.com/?Action=DescribeLoadBalancers
&Format=xml
&Version=2019-12-09
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2012-06-01T12:00:00Z
…