ListCertificatesByRecord - 查询匹配记录的站点证书列表_边缘安全加速(ESA)-阿里云帮助中心

查看匹配记录的站点证书列表，支持批量记录匹配。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
SiteId	long	是	站点 ID，可通过调用 ListSites 接口查询获取。	1234567890123
RecordName	string	是	记录名称。	www.example.com
ValidOnly	boolean	否	是否仅返回有效证书。0 表示返回所有匹配证书；1 表示仅返回有效证书。	1
Detail	boolean	否	是否返回证书详情。0 表示不返回证书详情；1 表示返回证书详情。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	65C66B7B-671A-8297-9187-2R5477247B76
TotalCount	long	总条数，数量和记录数相同。	12
SiteId	long	站点 ID。	1234567890123
SiteName	string	站点名称。	example.com
Result	array<object>	结果数组。
RecordItem	object	结果。
RecordName	string	记录名称。	www.example.com
Count	long	匹配记录的证书个数。	3
Certificates	array<object>	匹配记录的证书信息列表。
CertItem	object	证书信息。
CasId	string	云证书 Id。	30000137
Id	string	证书 ID。	babab022c5e9b27bf9c64d7f4b1667f4
Name	string	证书名称。	yourCertName
Region	string	证书存储区域。	cn-hangzhou
Status	string	证书状态。	OK
Type	string	证书类型。	free
CommonName	string	证书通用名称。	www.example.com
NotBefore	string	证书有效期开始时间。	2023-02-28 06:17:11
NotAfter	string	证书有效期截止时间。	2024-02-28 06:17:11
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	创建时间。	2023-02-28 06:17:11
UpdateTime	string	更新时间。	2023-02-28 06:17:11
SerialNumber	string	证书序列号。	baba39055622c008b90285a8838ed09a
FingerprintSha256	string	证书 Sha256 指纹。	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66
ApplylingCount	long	正在申请的证书数量。	1
Status	string	Record 证书配置状态。可能值：none：未配置；configured：已配置；applying：正在申请；failed：申请失败。	none

示例

正常返回示例

JSON格式

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "TotalCount": 12,
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Result": [
    {
      "RecordName": "www.example.com ",
      "Count": 3,
      "Certificates": [
        {
          "CasId": 30000137,
          "Id": "babab022c5e9b27bf9c64d7f4b1667f4",
          "Name": "yourCertName",
          "Region": "cn-hangzhou",
          "Status": "OK",
          "Type": "free",
          "CommonName": "www.example.com ",
          "NotBefore": "2023-02-28 06:17:11",
          "NotAfter": "2024-02-28 06:17:11",
          "Issuer": "GlobalSign nv-sa",
          "IssuerCN": "GlobalSign Organization Validation CA - SHA256 - G3",
          "SAN": "www.example.com,*.example.com",
          "SigAlg": "SHA256-RSA",
          "PubAlg": "RSA",
          "CreateTime": "2023-02-28 06:17:11",
          "UpdateTime": "2023-02-28 06:17:11",
          "SerialNumber": "baba39055622c008b90285a8838ed09a",
          "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66"
        }
      ],
      "ApplylingCount": 1,
      "Status": "none"
    }
  ]
}

错误码

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.	调用服务失败，请稍后重试或联系客服咨询详情。
400	MissingParameter	Required parameter RecordName missing. Specify RecordName and try again.	缺少必填参数RecordName，请指定RecordName参数后重试。
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	您输入的鉴权时间参数无效，请检查参数值后重试。
403	Unauthorized.InvalidToken	Token authentication failed.	您输入的token无效，请检查并输入正确的token后进行重试。

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