ListClientCertificates - 获取客户端证书列表_边缘安全加速(ESA)-阿里云帮助中心

获取指定站点下客户端证书列表。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
esa:ListClientCertificates	list	Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId}	无	无

请求参数

名称	类型	必填	描述	示例值
SiteId	long	是	站点 ID。	1234567890123
PageNumber	long	否	页面号码。	1
PageSize	long	否	分页大小。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	15C66C7B-671A-4297-9187-2C4477247A74
TotalCount	long	总条数。	5
PageNumber	long	返回数据的页码。	1
PageSize	long	分页大小。	20
SiteId	long	站点 ID。	1234567890123
SiteName	string	站点名称。	example.com
Result	array<object>	客户端证书列表。
CertItem	object	证书信息。
Id	string	证书 ID。	babab9db65ee5efcca9f3d41d4b50d66
Name	string	证书名称。	yourCertName
Status	string	证书状态。	active
Type	string	证书类型。	dcdn
CommonName	string	证书通用名称。	www.example.com
NotBefore	string	证书有效期开始时间。	2023-03-31 02:08:00
NotAfter	string	证书有效期截止时间。	2024-03-31 02:08:00
Issuer	string	证书颁发机构。	GlobalSign nv-sa
SAN	string	证书主题备用名。	www.example.com,*.example.com
SignatureAlgorithm	string	证书签名算法。	SHA256-RSA
PubkeyAlgorithm	string	证书公钥算法。	RSA
CreateTime	string	创建时间。	2024-06-24 07:48:51
UpdateTime	string	更新时间。	2024-07-20 06:18:42
CACertificateId	string	CA 证书 ID。	baba39055622c008b90285a8838ed09a

示例

正常返回示例

JSON格式

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 5,
  "PageNumber": 1,
  "PageSize": 20,
  "SiteId": 1234567890123,
  "SiteName": "example.com",
  "Result": [
    {
      "Id": "babab9db65ee5efcca9f3d41d4b50d66",
      "Name": "yourCertName",
      "Status": "active",
      "Type": "dcdn",
      "CommonName": "www.example.com ",
      "NotBefore": "2023-03-31 02:08:00",
      "NotAfter": "2024-03-31 02:08:00",
      "Issuer": "GlobalSign nv-sa",
      "SAN": "www.example.com,*.example.com",
      "SignatureAlgorithm": "SHA256-RSA",
      "PubkeyAlgorithm": "RSA",
      "CreateTime": "2024-06-24 07:48:51",
      "UpdateTime": "2024-07-20 06:18:42",
      "CACertificateId": "baba39055622c008b90285a8838ed09a"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.SiteId	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.	SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.	缺少必填参数SiteId，请指定SiteId参数后重试。
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	您输入的鉴权时间参数无效，请检查参数值后重试。
403	Unauthorized.InvalidToken	Token authentication failed.	您输入的token无效，请检查并输入正确的token后进行重试。

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