調用DescribeCertificate介面查詢認證資訊。
本文將提供一個樣本,查詢一個ID為9a28de48-8d8b-484d-a766-dec4****的認證資訊,包括認證ID、建立時間、簽發者資訊、有效期間、序號、簽名演算法等。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | DescribeCertificate | 要執行的操作,取值:DescribeCertificate。 |
| CertificateId | String | 是 | 9a28de48-8d8b-484d-a766-dec4**** | 認證ID。認證管家中認證的通用唯一識別碼。 |
關於公用請求參數的詳情,請參見公用參數。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Arn | String | acs:kms:cn-hangzhou:159498693826****:certificate/9a28de48-8d8b-484d-a766-dec4****" | 認證ARN。 |
| CertificateId | String | 9a28de48-8d8b-484d-a766-dec4**** | 認證ID。認證管家中認證的通用唯一識別碼。 |
| CreatedAt | String | 2020-10-13T03:05:03Z | 認證的建立時間。 |
| ExportablePrivateKey | Boolean | true | 認證密鑰是否支援匯出。取值:
|
| Issuer | String | CN=testCA,OU=kms,O=aliyun,C=CN | 認證的簽發者資訊,使用限定名DN(Distinguished Names)形式標識。 |
| KeySpec | String | RSA_2048 | 密鑰類型。 |
| NotAfter | String | 2022-10-13T03:09:00Z | 認證有效期間的截止時間。 |
| NotBefore | String | 2020-10-13T03:09:00Z | 認證有效期間的開始時間。 |
| RequestId | String | edb671a3-c5a1-4ebe-a1de-d748b640bdf2 | 請求ID。 |
| Serial | String | 12345678 | 認證序號。 |
| SignatureAlgorithm | String | ECDSA-SHA256 | 認證簽名演算法,取值:
|
| Status | String | ACTIVE | 認證的狀態資訊,取值:
|
| Subject | String | CN=userName,OU=aliyun,O=aliyun,C=CN | 認證主體(擁有者) ,採用DN標識。 |
| SubjectAlternativeNames | List | ["test1.example.com","test2.example.com"] | 認證主體別名。 支援網域名稱列表,最多支援10個網域名稱。 |
| SubjectKeyIdentifier | String | 79 36 26 DE 9F F5 15 E3 56 DC **** | 主體公開金鑰識別符。 |
| SubjectPublicKey | String | -----BEGIN PUBLIC KEY----- MIIBIjA -----END PUBLIC KEY----- | 認證中的公開金鑰。 |
| Tags | Map | [{\"TagKey\":\"S1key1\",\"TagValue\":\"S1val1\"},{\"TagKey\":\"S1key2\",\"TagValue\":\"S2val2\"}] | 認證對應的標籤。 |
| UpdatedAt | String | 2020-12-23T06:10:13Z | 認證的更新時間。 |
樣本
請求樣本
http(s)://[Endpoint]/?Action=DescribeCertificate
&CertificateId=9a28de48-8d8b-484d-a766-dec4****
&<公用請求參數>
正常返回樣本
XML格式
<KMS>
<Status>ACTIVE</Status>
<RequestId>edb671a3-c5a1-4ebe-a1de-d748b640bdf2</RequestId>
<Issuer>CN=testCA,OU=kms,O=aliyun,C=CN</Issuer>
<CertificateId>9a28de48-8d8b-484d-a766-dec4****</CertificateId>
<CreatedAt>2020-10-13T03:05:03Z</CreatedAt>
<KeySpec>RSA_2048</KeySpec>
<SubjectAlternativeNames>[\"test1.example.com\",\"test2.example.com\"]</SubjectAlternativeNames>
<SignatureAlgorithm>ECDSA-SHA256</SignatureAlgorithm>
<SubjectKeyIdentifier>79 36 26 DE 9F F5 15 E3 56 DC ********</SubjectKeyIdentifier>
<NotAfter>2022-10-13T03:09:00Z</NotAfter>
<ExportablePrivateKey>true</ExportablePrivateKey>
<UpdatedAt>2020-10-13T03:15:00Z</UpdatedAt>
<Subject>CN=userName,OU=aliyun,O=aliyun,C=CN</Subject>
<Serial>12345678</Serial>
<SubjectPublicKey>-----BEGIN PUBLIC KEY----- MIIBIjA -----END PUBLIC KEY-----</SubjectPublicKey>
<NotBefore>2020-10-13T03:09:00Z</NotBefore>
<Arn>acs:kms:cn-hangzhou:159498693826****:certificate/9a28de48-8d8b-484d-a766-dec4****</Arn>
<Tags>[{\"TagKey\":\"S1key1\",\"TagValue\":\"S1val1\"},{\"TagKey\":\"S1key2\",\"TagValue\":\"S2val2\"}]</Tags>
</KMS>
JSON格式
{
"Status": "ACTIVE",
"RequestId": "edb671a3-c5a1-4ebe-a1de-d748b640bdf2",
"Issuer": "CN=testCA,OU=kms,O=aliyun,C=CN",
"CertificateId": "9a28de48-8d8b-484d-a766-dec4****",
"CreatedAt": "2020-10-13T03:05:03Z",
"KeySpec": "RSA_2048",
"SubjectAlternativeNames": "[\"test1.example.com\",\"test2.example.com\"]",
"SignatureAlgorithm": "ECDSA-SHA256",
"SubjectKeyIdentifier": "79 36 26 DE 9F F5 15 E3 56 DC ********",
"NotAfter": "2022-10-13T03:09:00Z",
"ExportablePrivateKey": "true",
"UpdatedAt": "2020-10-13T03:15:00Z",
"Subject": "CN=userName,OU=aliyun,O=aliyun,C=CN",
"Serial": "12345678",
"SubjectPublicKey": "-----BEGIN PUBLIC KEY----- MIIBIjA -----END PUBLIC KEY-----",
"NotBefore": "2020-10-13T03:09:00Z",
"Arn": "acs:kms:cn-hangzhou:159498693826****:certificate/9a28de48-8d8b-484d-a766-dec4****",
"Tags": "[{\"TagKey\":\"S1key1\",\"TagValue\":\"S1val1\"},{\"TagKey\":\"S1key2\",\"TagValue\":\"S2val2\"}]"
}
錯誤碼
| HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
| 404 | Certificate.NotFound | The specified certificate is not found. | 指定的認證不存在。 |
訪問錯誤中心查看更多錯誤碼。