全部产品
云市场
云游戏

调用方式

更新时间:2020-07-31 16:32:08

调用方式

介绍产品调用API请求的请求和返回模式。 示例:负载均衡接口调用是向负载均衡API的服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。

请求结构

此处以调用负载均衡的DescribeLoadBalancers为例描述了RPC风格的API,请根据实际产品修改对应的描述和参数。XX产品的API是RPC风格,您可以通过发送HTTP GET请求调用 XX产品API。

其请求结构如下:

http://Endpoint/?Action=xx&Parameters

其中: 公共云和专有云的API请求结构类似,只是Endpoint不一样,所以Endpoint和请求结构上需要做区分。

Endpoint: XX产品API的服务接入地址为slb.aliyuncs.com。 请根据实际产品,修改服务接入地址。

Endpoint: XX产品API的服务接入地址为slb.example.com。 请根据实际产品,修改服务接入地址。(platform = public)

说明:example.com是项目自定义的访问域名,请联系管理员获取该域名。(platform = priviate)

Action:要执行的操作,如调用DescribeLoadBalancers查询已创建的负载均衡实例。 示例功能需要修改为对应产品的API

Version:要使用的API版本,负载均衡的API版本是2014-05-15。 云产品使用的API版本需要跟PD确认,修改正确的API版本

Parameters:请求参数,每个参数之间用“&”分隔。

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

下面是一个调用DescribeLoadBalancers接口查询已创建的负载均衡实例的示例: 根据实际产品,修改请求示例。

说明: 为了便于用户查看,本文档中的示例都做了格式化处理。

  1. https://slb.aliyuncs.com/?Action=DescribeLoadBalancers
  2. &Format=xml
  3. &Version=2014-05-15
  4. &Signature=xxxx%xxxx%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &TimeStamp=2012-06-01T12:00:00Z
  1. https://slb.example.com/?Action=DescribeLoadBalancers
  2. &Format=xml
  3. &Version=2014-05-15
  4. &Signature=xxxx%xxxx%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &TimeStamp=2012-06-01T12:00:00Z