接口说明

使用说明

本接口用于通过证书的序列号，批量查询客户端证书或服务端证书的详细信息，例如，证书的序列号、使用者信息、内容、状态等。

调用本接口前，您必须已经创建了客户端证书或服务端证书。

关于如何调用 API 创建客户端证书，请参见：

关于如何调用 API 创建服务端证书，请参见：

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
SerialNumber	string	是	要查询的客户端证书或服务端证书的序列号。多个序列号之间使用半角逗号（,）分隔。说明您可以调用 ListClientCertificate 查询所有客户端证书和服务端证书的序列号。	084bde9cd233f0ddae33adc438cfbbbd****

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

名称	类型	描述	示例值
	object	ListCertificateResponse
CertificateList	array<object>	客户端证书或服务端证书的详细信息。
	object	证书信息。
X509Certificate	string	证书的内容。	-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----
Identifier	string	证书的唯一识别码。	d3b95700998e47afc4d95f886579****
SerialNumber	string	证书的序列号。	084bde9cd233f0ddae33adc438cfbbbd****
SubjectDN	string	证书的 DN（Distinguished Name）属性，表示证书的使用者，具体包含以下信息： C：国家。 O：组织机构。 OU：部门。 L：城市。 ST：省份、直辖市或自治区。 CN：公用名。	C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonName	string	证书的公用名。	aliyun.com
OrganizationUnit	string	签发该证书的子 CA 证书关联的组织机构下部门的名称。	Security
Organization	string	签发该证书的子 CA 证书关联的组织机构的名称。	阿里云计算有限公司
Locality	string	签发该证书的子 CA 证书关联的组织机构所在城市的名称。	Hangzhou
State	string	签发该证书的子 CA 证书关联的组织机构所在省份、直辖市或自治区的名称。	Zhejiang
CountryCode	string	签发该证书的子 CA 证书关联的组织机构所在国家的代码。关于不同国家代码的含义，请参见管理公司信息中的国际代号章节。	CN
Sans	string	证书的 SAN（Subject Alternative Name）扩展属性，表示证书关联的其他域名、IP 地址等。该参数使用 JSON 数组转化的字符串表示。JSON 数组中的每个元素是一个结构体，对应一个 SAN 扩展。每个 SAN 扩展结构体包含以下参数： Type：Integer 类型，表示扩展的类型。取值： 1：表示邮箱地址。 2：表示域名。 6：表示统一资源标志符 URI（Uniform Resource Identifier）。 7：表示 IP 地址。 Value：String 类型，表示扩展的内容。	[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]
Status	string	证书的状态。取值： ISSUE：表示正常签发。 REVOKE：表示已被吊销。	ISSUE
BeforeDate	string	证书的签发时间。	2021-10-28T16:15Z
AfterDate	string	证书的到期时间。	2022-08-23T16:15Z
Algorithm	string	证书的加密算法类型。取值： RSA：表示 RSA 算法。 ECC：表示 ECC 算法。 SM2：表示 SM2（国密）算法。	RSA
KeySize	integer	证书的密钥长度。	4096
SignAlgorithm	string	证书的签名算法。	SHA256WITHRSA
CertificateType	string	证书类型。	SUB_ROOT
ParentIdentifier	string	如果该参数不为空，代表该客户端证书的颁发机构为阿里云。	1a83bcbb89e562885e40aa0108f5****
Sha2	string	证书的 SHA256 数字指纹。	14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5	string	证书的 MD5 数字指纹。	d3b95700998e47afc4d95f886579****
Years	integer	该参数已废弃。	1
RequestId	string	本次请求的 ID。	15C66C7B-671A-4297-9187-2C4477247A74

示例

正常返回示例

JSON格式

{
  "CertificateList": [
    {
      "X509Certificate": "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
      "Identifier": "d3b95700998e47afc4d95f886579****",
      "SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
      "SubjectDN": "C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
      "CommonName": "aliyun.com",
      "OrganizationUnit": "Security",
      "Organization": "阿里云计算有限公司",
      "Locality": "Hangzhou",
      "State": "Zhejiang",
      "CountryCode": "CN",
      "Sans": "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
      "Status": "ISSUE",
      "BeforeDate": "2021-10-28T16:15Z",
      "AfterDate": "2022-08-23T16:15Z",
      "Algorithm": "RSA",
      "KeySize": 4096,
      "SignAlgorithm": "SHA256WITHRSA",
      "CertificateType": "SUB_ROOT",
      "ParentIdentifier": "1a83bcbb89e562885e40aa0108f5****",
      "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
      "Md5": "d3b95700998e47afc4d95f886579****",
      "Years": 1
    }
  ],
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

错误码

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

变更历史

更多信息，参考变更详情。