幫助中心
首頁 Certificate Management Service 開發參考 API參考（私人認證） API目錄 用戶端和服務端認證 DescribeClientCertificate - 查詢認證詳細資料

DescribeClientCertificate - 查詢認證詳細資料

更新時間：
Copy as MD
產品

通過認證的唯一識別碼查詢單個用戶端認證或服務端認證的詳細資料。

介面說明

本介面用於通過認證的唯一識別碼，查詢單個用戶端認證或服務端認證的詳細資料，例如，認證的序號、使用者資訊、內容、狀態等。

調用本介面前，您必須已經建立了用戶端認證或服務端認證。

關於如何調用 API 建立用戶端認證，請參見：

關於如何調用 API 建立服務端認證，請參見：

QPS 限制

本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫將會被限流，這可能影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

  • 操作：是指具體的許可權點。

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

    • 對於必選的資源類型，用前面加 * 表示。

    • 對於不支援資源級授權的操作，用全部資源表示。

  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cert:DescribeClientCertificate

get

*全部資源

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
Identifier

string

是

要查詢的用戶端認證或服務端認證的唯一識別碼。

說明

您可以調用 ListClientCertificate 查詢所有用戶端認證和服務端認證的唯一識別碼。

d3b95700998e47afc4d95f886579****

調用 API 時，除了本文中該 API 的請求參數，還需加入阿里雲 API 公用請求參數。

調用 API 的請求格式，請參見本文樣本中的請求樣本。

返回參數

名稱

類型

描述

樣本值

object

DescribeCertificateResponse

Certificate

object

用戶端認證或服務端認證的詳細資料。

X509Certificate

string

認證的內容。

-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----
Identifier

string

認證的唯一識別碼。

d3b95700998e47afc4d95f886579****
SerialNumber

string

認證的序號。

62b2b943a32d96883a6650e672ea0276****
SubjectDN

string

認證的 DN（Distinguished Name）屬性，表示認證的使用者，具體包含以下資訊：

  • C：國家。

  • O：組織機構。

  • OU：部門。

  • L：城市。

  • ST：省份或州。

  • CN：一般名稱。

C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonName

string

認證的一般名稱。

aliyun.com
OrganizationUnit

string

簽發該認證的子 CA 憑證關聯的組織機構下部門的名稱。

Security
Organization

string

簽發該認證的子 CA 憑證關聯的組織機構的名稱。

Aliyun
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

integer

認證的簽發日期。使用時間戳表示，單位：毫秒。

1634283958000
AfterDate

integer

認證的到期日。使用時間戳表示，單位：毫秒。

1665819958000
Algorithm

string

認證的密碼編譯演算法類型。取值：

  • RSA：表示 RSA 演算法。

  • ECC：表示 ECC 演算法。

  • SM2：表示 SM2（國密）演算法。

RSA
KeySize

integer

認證的密鑰長度。

4096
SignAlgorithm

string

認證的簽名演算法。

SHA256WITHRSA
CertificateType

string

認證的類型。取值：

  • CLIENT：表示用戶端認證。

  • SERVER：表示服務端認證。

SERVER
ParentIdentifier

string

簽發該認證的子 CA 憑證的唯一識別碼。

160ae6bb538d538c70c01f81dcf2****
Sha2

string

認證的 SHA256 數位指紋。

14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5

string

認證的 MD5 數位指紋。

d3b95700998e47afc4d95f886579****
Days

integer

認證的有效期間。單位：天。

365
ResourceGroupId

string

認證所屬資源群組的 ID。

rg-acfmxllajdpw3fi
CertChain

string

完整的憑證鏈結。

-----BEGIN CERTIFICATE----- cert -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- subCA -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- rootCA -----END CERTIFICATE-----
CustomIdentifier

string

使用者自訂標識，唯一鍵。

***3a32d96883a6650e672ea0276****
UploadFlag

integer

表示該認證是否已同步到數位憑證服務。

1
FullAlgorithm

string

攜帶長度的演算法。

RSA_2048
AliasName

string

設定簽發認證的名稱。

rsa_root_2048
Id

integer

認證訂單所屬資料來源 ID。

1137354
Tags

array<object>

標籤列表。

mtls

object

標籤值。

TagKey

string

標籤 Key

testKey
TagValue

string

標籤值。

[{\"tag\":\"PROPERTY_TYPE\",\"values\":[]}]
RequestId

string

本次請求的 ID。

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

樣本

正常返回樣本

JSON格式

{
  "Certificate": {
    "X509Certificate": "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
    "Identifier": "d3b95700998e47afc4d95f886579****",
    "SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
    "SubjectDN": "C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
    "CommonName": "aliyun.com",
    "OrganizationUnit": "Security",
    "Organization": "Aliyun",
    "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,
    "ResourceGroupId": "rg-acfmxllajdpw3fi",
    "CertChain": "-----BEGIN CERTIFICATE-----\ncert\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nsubCA\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nrootCA\n-----END CERTIFICATE-----",
    "CustomIdentifier": "***3a32d96883a6650e672ea0276****",
    "UploadFlag": 1,
    "FullAlgorithm": "RSA_2048",
    "AliasName": "rsa_root_2048",
    "Id": 1137354,
    "Tags": [
      {
        "TagKey": "testKey",
        "TagValue": "[{\\\"tag\\\":\\\"PROPERTY_TYPE\\\",\\\"values\\\":[]}]"
      }
    ]
  },
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。

上一篇：DescribeCertificatePrivateKey - 查詢認證的私密金鑰下一篇：DescribeClientCertificateStatus - 查詢認證的狀態資訊