文档

DescribeClientCertificate - 查询证书详细信息

更新时间:

通过证书的唯一识别码查询单个客户端证书或服务端证书的详细信息。

接口说明

本接口用于通过证书的唯一识别码,查询单个客户端证书或服务端证书的详细信息,例如,证书的序列号、使用者信息、内容、状态等。

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

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

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

QPS限制

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

调试

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

调试

授权信息

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

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

请求参数

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

要查询的客户端证书或服务端证书的唯一识别码。

说明 您可以调用ListClientCertificate查询所有客户端证书和服务端证书的唯一识别码。
d3b95700998e47afc4d95f886579****

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。

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

返回参数

名称类型描述示例值
object

DescribeCertificateResponse

Certificateobject

客户端证书或服务端证书的详细信息。

X509Certificatestring

证书的内容。

-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----
Identifierstring

证书的唯一识别码。

d3b95700998e47afc4d95f886579****
SerialNumberstring

证书的序列号。

62b2b943a32d96883a6650e672ea0276****
SubjectDNstring

证书的DN(Distinguished Name)属性,表示证书的使用者,具体包含以下信息:

  • C:国家。

  • O:组织机构。

  • OU:部门。

  • L:城市。

  • ST:省份、直辖市或自治区。

  • CN:公用名。

C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonNamestring

证书的公用名。

aliyun.com
OrganizationUnitstring

签发该证书的子CA证书关联的组织机构下部门的名称。

Security
Organizationstring

签发该证书的子CA证书关联的组织机构的名称。

阿里云计算有限公司
Localitystring

签发该证书的子CA证书关联的组织机构所在城市的名称。

Hangzhou
Statestring

签发该证书的子CA证书关联的组织机构所在省份、直辖市或自治区的名称。

Zhejiang
CountryCodestring

签发该证书的子CA证书关联的组织机构所在国家的代码。

关于不同国家代码的含义,请参见管理公司信息中的国际代号章节。

CN
Sansstring

证书的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"}, ]
Statusstring

证书的状态。取值:

  • ISSUE:表示正常签发。
  • REVOKE:表示已被吊销。
ISSUE
BeforeDatelong

证书的签发日期。使用时间戳表示,单位:毫秒。

1634283958000
AfterDatelong

证书的到期日期。使用时间戳表示,单位:毫秒。

1665819958000
Algorithmstring

证书的加密算法类型。取值:

  • RSA:表示RSA算法。
  • ECC:表示ECC算法。
  • SM2:表示SM2(国密)算法。
RSA
KeySizeinteger

证书的密钥长度。

4096
SignAlgorithmstring

证书的签名算法。

SHA256WITHRSA
CertificateTypestring

证书的类型。取值:

  • CLIENT:表示客户端证书。
  • SERVER:表示服务端证书。
SERVER
ParentIdentifierstring

签发该证书的子CA证书的唯一识别码。

160ae6bb538d538c70c01f81dcf2****
Sha2string

证书的SHA256数字指纹。

14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5string

证书的MD5数字指纹。

d3b95700998e47afc4d95f886579****
Daysinteger

证书的有效期。单位:天。

365
RequestIdstring

本次请求的ID。

15C66C7B-671A-4297-9187-2C4477247A74

示例

正常返回示例

JSON格式

{
  "Certificate": {
    "X509Certificate": "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
    "Identifier": "d3b95700998e47afc4d95f886579****",
    "SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
    "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": 1634283958000,
    "AfterDate": 1665819958000,
    "Algorithm": "RSA",
    "KeySize": 4096,
    "SignAlgorithm": "SHA256WITHRSA",
    "CertificateType": "SERVER",
    "ParentIdentifier": "160ae6bb538d538c70c01f81dcf2****",
    "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
    "Md5": "d3b95700998e47afc4d95f886579****",
    "Days": 365
  },
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

错误码

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