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

说明 私网连接API必须通过发送HTTPS请求调用。

请求结构

私网连接的API是RPC风格,您可以通过发送GET请求调用私网连接API。

其请求结构如下:

https://Endpoint/?Action=xx&Parameters
其中:
  • Endpoint:私网连接API的服务接入地址为privatelink.aliyuncs.com
  • Action:要执行的操作,例如使用CreateVpcEndpointServiceConfiguration创建终端节点服务。
  • Version:要使用的API版本,私网连接的API版本是2019-02-18
  • Parameters:请求参数,每个参数之间用“&”分隔。

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

下面是一个调用CreateVpcEndpointServiceConfiguration接口创建终端节点服务的示例:
说明 为了便于用户查看,本文档中的示例都做了格式化处理。
https://privatelink.cn-huhehaote.aliyuncs.com/?Action=CreateVpcEndpointServiceConfiguration
&Format=xml
&Version=2019-02-18
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
…

API授权

为了确保您的账号安全,建议您使用子账号的身份凭证调用API。如果您使用RAM账号调用私网连接API,您需要为该RAM账号创建、附加相应的授权策略。

私网连接中可授权的资源和接口列表,参见RAM鉴权

API签名

私网连接服务会对每个API请求进行身份验证,需要在请求中包含签名(Signature)信息。

私网连接通过使用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-4e0ad82fd6cf

CreateVpcEndpointServiceConfiguration为例,假设AccessKey ID是testid, AccessKey Secret是testsecret,则签名前的请求URL如下:

https://privatelink.cn-huhehaote.aliyuncs.com/?Action=CreateVpcEndpointServiceConfiguration
&Timestamp=2016-02-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2019-02-18
&SignatureVersion=1.0
完成以下步骤计算签名:
  1. 使用请求参数创建待签名字符串:
    GET&%2F&AccessKeyId%3Dtestid&Action%3DCreateVpcEndpointServiceConfiguration&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2019-02-18
  2. 计算待签名的HMAC的值。

    在AccessKey Secret后添加一个“&”作为计算HMAC值的key。本示例中的key为testsecret&

    CT9X0VtwR86fNWS********juE=
  3. 将签名加到请求参数中:
    https://privatelink.cn-huhehaote.aliyuncs.com/?Action=CreateVpcEndpointServiceConfiguration
    &Timestamp=2016-02-23T12:46:24Z
    &Format=XML
    &AccessKeyId=testid
    &SignatureMethod=HMAC-SHA1
    &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
    &Version=2019-02-18
    &SignatureVersion=1.0
    &Signature=xxxx%3D