DescribeCertificate - 查询证书信息

查询证书信息。

接口说明

本文将提供一个示例,查询一个 ID 为9a28de48-8d8b-484d-a766-dec4****的证书信息,包括证书 ID、创建时间、签发者信息、有效期、序列号、签名算法等。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

CertificateId

string

证书 ID。证书管家中证书的全局唯一标识符。

9a28de48-8d8b-484d-a766-dec4****

返回参数

名称

类型

描述

示例值

object

Status

string

证书的状态信息,取值:

  • PENDING:等待导入。

  • ACTIVE:已启用。

  • INACTIVE:已禁用。

  • REVOKED:已吊销。

ACTIVE

Serial

string

证书序列号。

12345678

CreatedAt

string

证书的创建时间。

2020-10-13T03:05:03Z

Tags

object

证书对应的标签。

[{\"TagKey\":\"S1key1\",\"TagValue\":\"S1val1\"},{\"TagKey\":\"S1key2\",\"TagValue\":\"S2val2\"}]

SubjectKeyIdentifier

string

主体公钥识别符。

79 36 26 DE 9F F5 15 E3 56 DC ****

ExportablePrivateKey

boolean

证书密钥是否支持导出。取值:

  • true(默认值):支持导出。

  • false:不支持导出。

true

Issuer

string

证书的签发者信息,使用限定名 DN(Distinguished Names)形式标识。

CN=testCA,OU=kms,O=aliyun,C=CN

SignatureAlgorithm

string

证书签名算法,取值:

  • RSA2048-SHA256

  • ECDSA-SHA256

  • SM2-SM3

ECDSA-SHA256

NotAfter

string

证书有效期的截止时间。

2022-10-13T03:09:00Z

Arn

string

证书 ARN。

acs:kms:cn-hangzhou:159498693826****:certificate/9a28de48-8d8b-484d-a766-dec4****"

CertificateId

string

证书 ID。证书管家中证书的全局唯一标识符。

9a28de48-8d8b-484d-a766-dec4****

RequestId

string

请求 ID。

edb671a3-c5a1-4ebe-a1de-d748b640bdf2

KeySpec

string

密钥类型。

RSA_2048

SubjectPublicKey

string

证书中的公钥。

-----BEGIN PUBLIC KEY----- MIIBIjA -----END PUBLIC KEY-----

Subject

string

证书主体(拥有者) ,采用 DN 标识。

CN=userName,OU=aliyun,O=aliyun,C=CN

NotBefore

string

证书有效期的开始时间。

2020-10-13T03:09:00Z

UpdatedAt

string

证书的更新时间。

2020-12-23T06:10:13Z

SubjectAlternativeNames

array

支持域名列表,最多支持 10 个域名。

string

证书主体别名。

["test1.example.com","test2.example.com"]

示例

正常返回示例

JSON格式

{
  "Status": "ACTIVE",
  "Serial": "12345678",
  "CreatedAt": "2020-10-13T03:05:03Z",
  "Tags": {
    "test": "test",
    "test2": 1
  },
  "SubjectKeyIdentifier": "79 36 26 DE 9F F5 15 E3 56 DC ****",
  "ExportablePrivateKey": true,
  "Issuer": "CN=testCA,OU=kms,O=aliyun,C=CN",
  "SignatureAlgorithm": "ECDSA-SHA256",
  "NotAfter": "2022-10-13T03:09:00Z",
  "Arn": "acs:kms:cn-hangzhou:159498693826****:certificate/9a28de48-8d8b-484d-a766-dec4****\"",
  "CertificateId": "9a28de48-8d8b-484d-a766-dec4****",
  "RequestId": "edb671a3-c5a1-4ebe-a1de-d748b640bdf2",
  "KeySpec": "RSA_2048",
  "SubjectPublicKey": "-----BEGIN PUBLIC KEY----- MIIBIjA -----END PUBLIC KEY-----",
  "Subject": "CN=userName,OU=aliyun,O=aliyun,C=CN",
  "NotBefore": "2020-10-13T03:09:00Z",
  "UpdatedAt": "2020-12-23T06:10:13Z",
  "SubjectAlternativeNames": [
    "[\"test1.example.com\",\"test2.example.com\"]"
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The specified parameter is not valid. 参数非法。
404 Certificate.NotFound The specified certificate is not found. 指定的证书不存在。
404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.

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

变更历史

更多信息,参考变更详情