ListCertificates - 查询站点证书列表_边缘安全加速(ESA)-阿里云帮助中心

查询特定站点下的证书列表。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
SiteId	long	是	站点 ID，可通过调用 ListSites 接口查询获取。	1234567890123
Keyword	string	否	搜索关键字。	example
ValidOnly	boolean	否	是否仅返回有效证书。	1
PageNumber	long	否	返回数据的页码。	3
PageSize	long	否	每页的记录条数。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	15C66C7B-671A-4297-9187-2C4477247A74
TotalCount	long	总个数。	10
PageNumber	long	返回数据的页码。	1
PageSize	long	每页的记录条数。	20
SiteId	long	站点 ID。	1234567890123
SiteName	string	站点名称。	example.com
Result	array<object>	结果数组。
CertItem	object	结果。
CasId	string	云证书 Id。	30000569
Id	string	证书 Id。	baba39055622c008b90285a8838e****
Name	string	证书名称。	yourCertName
Region	string	地域信息。	cn-hangzhou
Status	string	证书状态。 OK：正常。 Expired：证书已过期。 Expiring：证书即将过期（30 天内）。 Issued：免费证书-已签发。 Applying：免费证书-申请中。 ApplyFailed：免费证书-申请失败。 Canceled：免费证书-已取消。	OK
Type	string	证书类型。 cas：云盾证书。 upload：自定义上传证书。 free：免费证书。	free
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
IssuerCN	string	证书发行商通用名。	GlobalSign Organization Validation CA - SHA256 - G3
SAN	string	证书主题备用名。	www.example.com,*.example.com
SigAlg	string	证书签名算法。	SHA256-RSA
PubAlg	string	证书公钥算法。	RSA
CreateTime	string	创建时间。	2022-06-24 07:48:51
UpdateTime	string	更新时间。	2023-04-20 06:18:42
SerialNumber	string	证书序列号。	babab022c5e9b27bf9c64d7f4b16****
FingerprintSha256	string	证书 Sha256 指纹。	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****
DCV	array<object>	DCV 信息。
DCV	object	DCV 信息。
Id	string	DCV ID。	bababf7cdd1546a2ad04c0def1f4****
Type	string	DCV 类型。可能值：DNS；HTTP。	HTTP
Key	string	DCV 名称。DNS 类型为 TXT 记录名；HTTP 类型为 URL。	http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow
Value	string	DCV 内容。	pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ
Status	string	验证状态。	pending
ApplyCode	long	证书申请错误码。	2
ApplyMessage	string	证书申请错误信息。	canceled

示例

正常返回示例

JSON格式

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 20,
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Result": [
    {
      "CasId": "30000569",
      "Id": "baba39055622c008b90285a8838e****",
      "Name": "yourCertName",
      "Region": "cn-hangzhou",
      "Status": "OK",
      "Type": "free",
      "CommonName": "www.example.com",
      "NotBefore": "2023-03-31 02:08:00",
      "NotAfter": "2024-03-31 02:08:00",
      "Issuer": "GlobalSign nv-sa",
      "IssuerCN": "GlobalSign Organization Validation CA - SHA256 - G3",
      "SAN": "www.example.com,*.example.com",
      "SigAlg": "SHA256-RSA",
      "PubAlg": "RSA",
      "CreateTime": "2022-06-24 07:48:51",
      "UpdateTime": "2023-04-20 06:18:42",
      "SerialNumber": "babab022c5e9b27bf9c64d7f4b16****",
      "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****",
      "DCV": [
        {
          "Id": "bababf7cdd1546a2ad04c0def1f4****",
          "Type": "HTTP",
          "Key": "http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow",
          "Value": "pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ",
          "Status": "pending"
        }
      ],
      "ApplyCode": 2,
      "ApplyMessage": "canceled"
    }
  ]
}

错误码

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参数后重试。
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	您输入的鉴权时间参数无效，请检查参数值后重试。
403	Unauthorized.InvalidToken	Token authentication failed.	您输入的token无效，请检查并输入正确的token后进行重试。

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