全部产品
Search
文档中心

专有网络 VPC:DescribeSslVpnClientCerts - 查询已创建的SSL-VPN客户端证书

更新时间:Mar 04, 2024

调用DescribeSslVpnClientCerts接口查询已创建的SSL客户端证书。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeSslVpnClientCertsList
  • SslVpnClientCert
    acs:vpc:{#regionId}:{#accountId}:sslvpnclientcert/*
  • SslVpnClientCert
    acs:vpc:{#regionId}:{#accountId}:sslvpnclientcert/{#SslVpnClientCertId}

请求参数

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

要查询的 SSL 客户端证书所在的地域 ID。

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

cn-hangzhou
SslVpnServerIdstring

SSL 服务端 ID。

vss-bp18q7hzj6largv4v****
SslVpnClientCertIdstring

SSL 客户端证书 ID。

vsc-bp1n8wcf134yl0osr****
Namestring

SSL 客户端证书的名称。

cert1
PageNumberinteger

列表的页码,默认值:1

1
PageSizeinteger

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

10
ResourceGroupIdstring

SSL 客户端证书所属的资源组 ID。

SSL 客户端证书与其关联的 SSL 服务端的资源组相同。您可以调用 DescribeSslVpnServers 接口查询 SSL 服务端所属的资源组 ID。

rg-acfmzs372yg****

返回参数

名称类型描述示例值
object

返回结果。

PageSizeinteger

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

10
RequestIdstring

请求 ID。

5BE01CD7-5A50-472D-AC14-CA181C5C03BE
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
SslVpnClientCertKeysobject []

SSL 客户端证书的信息列表。

Statusstring

客户端证书的状态。

  • expiring-soon:证书将在 1 周后过期。

  • normal:正常。

  • expired:已过期。

normal
EndTimelong

SSL 客户端证书的到期时间戳。单位:毫秒。

时间戳的格式采用 Unix 时间戳,表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至 SSL 客户端证书到期时的总时长。

1494966335000
CreateTimelong

SSL 客户端证书的创建时间戳。单位:毫秒。

时间戳的格式采用 Unix 时间戳,表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至创建 SSL 客户端证书时的总时长。

1492747187000
SslVpnClientCertIdstring

SSL 客户端证书的 ID。

vsc-bp1n8wcf134yl0osr****
SslVpnServerIdstring

SSL 服务端 ID。

vss-bp18q7hzj6largv4v****
Namestring

SSL 客户端证书的名称。

cert1
RegionIdstring

SSL 客户端证书的地域。

cn-hangzhou
ResourceGroupIdstring

SSL 客户端证书所属的资源组 ID。

您可以调用 ListResourceGroups 接口查询资源组信息。

rg-acfmzs372yg****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "PageNumber": 1,
  "TotalCount": 1,
  "SslVpnClientCertKeys": {
    "SslVpnClientCertKey": [
      {
        "Status": "normal",
        "EndTime": 1494966335000,
        "CreateTime": 1492747187000,
        "SslVpnClientCertId": "vsc-bp1n8wcf134yl0osr****",
        "SslVpnServerId": "vss-bp18q7hzj6largv4v****",
        "Name": "cert1",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-acfmzs372yg****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源,请您申请操作权限后再试。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidRegionId.NotFoundThe specified region is not found during access authentication.接入认证时未找到指定区域。

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

变更历史

变更时间变更内容概要操作
2023-10-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更