文档

ListVpnCertificateAssociations - 获取VPN证书关联列表

更新时间:

调用ListVpnCertificateAssociations接口查询指定地域下VPN网关实例和证书的绑定关系。

接口说明

在调用 ListVpnCertificateAssociations 时:

  • 如果您仅指定了 RegionId 参数的值,则表示您要查询指定地域下所有 VPN 网关实例和 SSL 证书的绑定关系。
  • 如果您指定了 RegionIdCertificateType 参数的值,则表示您要查询指定地域下 VPN 网关实例与指定证书类型的 SSL 证书的绑定关系。
  • 如果您指定了 RegionIdVpnGatewayId 参数的值,则表示您要查询指定地域下指定 VPN 网关实例与 SSL 证书的绑定关系。
  • 如果您指定了 RegionIdCertificateId 参数的值,则表示您要查询指定地域下指定 SSL 证书与 VPN 网关实例的绑定关系。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

VPN 网关所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
CertificateTypestring

证书类型。取值:

  • Encryption:加密证书。

  • Signature:签名证书。

Signature
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

caeba0bbb2be0****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~20,默认值:10

10
VpnGatewayIdarray

VPN 网关实例 ID 列表。

一次最多支持查询 20 个 VPN 网关实例与 SSL 证书的绑定关系。

string

VPN 网关实例 ID。

一次最多支持查询 20 个 VPN 网关实例与 SSL 证书的绑定关系。

vpn-bp1q8bgx4xnkm2ogj****
CertificateIdarray

证书 ID 列表。

一次最多支持查询 20 个 SSL 证书与 VPN 网关实例的绑定关系。

string

证书 ID。

一次最多支持查询 20 个 SSL 证书与 VPN 网关实例的绑定关系。

848****

返回参数

名称类型描述示例值
object

返回参数。

NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

caeba0bbb2be****
RequestIdstring

请求 ID。

197AF2BD-547F-470C-B29A-8400400233EB
TotalCountinteger

绑定关系总条目数。

4
MaxResultsinteger

分批次查询时每次显示的条目数。

10
VpnCertificateRelationsobject []

绑定关系列表。

VpnGatewayIdstring

VPN 网关实例 ID。

vpn-bp1usbiorilk51760****
CertificateTypestring

证书类型。

  • Encryption:加密证书。

  • Signature:签名证书。

Signature
CertificateIdstring

证书 ID。

6bfe4218-ea1d****
AssociationTimestring

绑定时间。

时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2020-12-29T09:30:29Z
RegionIdstring

VPN 网关所在地域 ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be****",
  "RequestId": "197AF2BD-547F-470C-B29A-8400400233EB",
  "TotalCount": 4,
  "MaxResults": 10,
  "VpnCertificateRelations": [
    {
      "VpnGatewayId": "vpn-bp1usbiorilk51760****",
      "CertificateType": "Signature",
      "CertificateId": "6bfe4218-ea1d****",
      "AssociationTime": "2020-12-29T09:30:29Z",
      "RegionId": "cn-hangzhou"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.NextTokenThe specified next token (%s) is invalid.-
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈