全部產品
Search
文件中心

Certificate Management Service:DescribeClientCertificateForSerialNumber

更新時間:Aug 24, 2026

透過憑證的序號批次查詢用戶端憑證或伺服器端憑證的詳細資訊。

說明

目前該API介面已標記為棄用,推薦使用替代API:cas(2020-06-30) - DescribeClientCertificate。

介面說明

使用說明

本介面用於透過憑證的序號,批次查詢用戶端憑證或伺服器端憑證的詳細資訊,例如,憑證的序號、使用者資訊、內容、狀態等。

呼叫本介面前,您必須已經建立了用戶端憑證或伺服器端憑證。

關於如何呼叫 API 建立用戶端憑證,請參見:

關於如何呼叫 API 建立伺服器端憑證,請參見:

QPS 限制

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

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cert:DescribeClientCertificateForSerialNumber

get

*全部資源。

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

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

憑證的簽發時間。YYYY-MM-DD。

2021-10-28T16:15Z

AfterDate

string

憑證的到期時間。YYYY-MM-DD。

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"
}

錯誤碼

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

變更歷史

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