弹性公网IP和专有网络使用同一个服务地址(endpoint)。接口调用是向弹性公网IP API的服务端地址发送HTTP或HTTPS GET请求。您需要按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。
请求结构
弹性公网IP的API是RPC风格,您可以通过发送HTTP或HTTPS GET请求调用弹性公网IP API。
其请求结构如下:
http(s)://Endpoint/?Action=xx&Parameters
其中:
- Endpoint:弹性公网IP API的服务接入地址为
vpc.aliyuncs.com
。 - Action:要执行的操作,如使用AllocateEipAddress申请弹性公网IP。
- Version:要使用的API版本,弹性公网IP的API版本是2016-04-28。
- Parameters:请求参数,每个参数之间用&分隔。
请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息。更多信息,请参见公共参数。
下面是调用AllocateEipAddress接口申请弹性公网IP的示例:
说明 为了便于查看,本文档中的示例都做了格式化处理。
https://vpc.aliyuncs.com/?Action=AllocateEipAddress
&Format=xml
&Version=2016-04-28
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
…
API授权
为了确保您的账号安全,建议您使用RAM用户的身份凭证调用API。如果您使用RAM用户调用弹性公网IP API,您需要创建相应的授权策略,并将其附加给RAM用户。
弹性公网IP中可授权的资源和接口列表,请参见RAM鉴权。
API签名
弹性公网IP服务会对每个API请求进行身份验证,无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息。
弹性公网IP通过使用AccessKey ID和AccessKey Secret进行对称加密的方法来验证请求的发送者身份。AccessKey是阿里云账号和RAM用户发布的一种身份凭证(类似于用户的登录密码),其中AccessKey ID用于标识访问者的身份。AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。
RPC API需按以下格式在请求中增加签名(Signature):
https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=XXXX%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx
以AllocateEipAddress为例,假设AccessKey ID是
testid
, AccessKey Secret是testsecret
,则签名前的请求URL如下:http://vpc.aliyuncs.com/?Action=AllocateEipAddress
&Timestamp=2016-05-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx
&Version=2016-04-28
&SignatureVersion=1.0
完成以下步骤计算签名:
- 使用请求参数创建待签名字符串:
GET&%2F&AccessKeyId%3Dtestid&Action%3DAllocateEipAddress&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2016-04-28
- 计算待签名的HMAC的值。 在AccessKey Secret后添加一个&作为计算HMAC值的key。本示例中的key为
testsecret&
。计算得到的签名值为:CT9X0VtwR86fNWS********juE=
- 将得到的签名值作为Signature参数添加到请求参数中: 说明 得到的签名值在作为最后的请求参数值提交时要和其它参数一样,按照RFC3986的规则进行URL编码。
http://vpc.aliyuncs.com/?Action=AllocateEipAddress &Timestamp=2016-05-23T12:46:24Z &Format=XML &AccessKeyId=testid &SignatureMethod=HMAC-SHA1 &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx &Version=2016-04-28 &SignatureVersion=1.0 &Signature=CT9X0VtwR86fNWS********juE=