CreateClientCertificate - 基於系統自動產生的CSR簽發單個用戶端認證

更新時間:
Copy as MD

基於系統自動產生的CSR簽發單個用戶端認證

介面說明

調用本介面前,您必須已經調用 CreateRootCACertificate 建立了根 CA 憑證,並且調用 CreateSubCACertificate 建立了子 CA 憑證。只有子 CA 憑證才能簽發用戶端認證。

QPS 限制

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

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cert:CreateClientCertificate

create

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

SanType

integer

用戶端認證支援的擴充資訊 SAN(Subject Alternative Name)類型。取值:

  • 1:表示郵箱。

  • 6:表示統一資源標誌符 URI(Uniform Resource Identifier)。

1

SanValue

string

用戶端認證的具體擴充資訊。支援輸入多個擴充資訊,如果您需要輸入多個擴充資訊,請用半形逗號(,)將其隔開。

somebody@example.com

Organization

string

機構名稱,預設:Alibaba Inc。

阿里雲

OrganizationUnit

string

部門名稱,預設:Aliyun CDN。

IT

Country

string

所屬國家,預設:CN。

CN

CommonName

string

表示認證使用者的名稱。用戶端認證(ClientAuth)認證使用者一般是自然人、公司、組織或某個應用,建議填寫使用者的通用名稱。例如,張三、阿里巴巴、阿里雲密碼平台、天貓精靈等。

aliyun

State

string

設定認證組織機構所在省份或州的名稱。支援使用中文、英文字元等。預設為簽發該認證的子 CA 憑證組織機構所在省份或州的名稱。

Zhejiang

Locality

string

設定認證組織機構所在城市的名稱。支援使用中文、英文字元等。 預設為簽發該認證的子 CA 憑證的組織機構所在城市的名稱。

杭州市

Algorithm

string

用戶端認證的密鑰演算法。密鑰演算法使用<密碼編譯演算法>_<密鑰長度>格式表示。取值:

  • RSA_1024:對應簽名演算法為 Sha256WithRSA。

  • RSA_2048:對應簽名演算法為 Sha256WithRSA。

  • RSA_4096:對應簽名演算法為 Sha256WithRSA。

  • ECC_256:對應簽名演算法為 Sha256WithECDSA。

  • ECC_384:對應簽名演算法為 Sha256WithECDSA。

  • ECC_512:對應簽名演算法為 Sha256WithECDSA。

  • SM2_256:對應簽名演算法為 SM3WithSM2。

用戶端認證的密碼編譯演算法必須與子 CA 憑證一致,密鑰長度可以不一致。例如:子 CA 憑證的密鑰演算法為 RSA_2048,則用戶端認證的密鑰演算法必須是 RSA_1024、RSA_2048、RSA_4096 中的一種。

說明

您可以調用 DescribeCACertificate 查詢子 CA 憑證的密鑰演算法。

RSA_2048

ParentIdentifier

string

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

說明

您可以調用[DescribeCACertificateList]查詢子 CA 憑證的唯一識別碼。

273ae6bb538d538c70c01f81jh2****

Years

integer

購買認證的時間長度。單位:年。

5

Months

integer

購買認證的時間長度。單位:月。

1

Days

integer

用戶端認證的有效期間。單位:天。 DaysBeforeTimeAfterTime 參數不能同時為空白,並且 BeforeTimeAfterTime 參數必須同時為空白或者同時設定。該參數具體設定說明如下:

  • 當設定 Days 參數時,您可以選擇同時設定 BeforeTimeAfterTime 參數或者不設定 BeforeTimeAfterTime 參數。

  • 當不設定 Days 參數時,您必須設定 BeforeTimeAfterTime 參數。

說明
  • 當您同時設定 DaysBeforeTimeAfterTime 參數時,用戶端認證的有效期間以 Days 參數的值為準。

  • 用戶端認證的有效期間不能超過子 CA 憑證的有效期間。您可以調用 DescribeCACertificate 查看子 CA 憑證的有效期間。

365

BeforeTime

integer

用戶端認證的簽發時間,使用時間戳格式,預設為您調用該介面的時間。單位:秒。

說明

BeforeTimeAfterTime 參數必須同時為空白或者同時設定。

1634283958

AfterTime

integer

用戶端認證的服務到期時間,使用時間戳格式。單位:秒。

說明

BeforeTimeAfterTime 參數必須同時為空白或者同時設定。

1665819958

Immediately

integer

立即返回數位憑證。

  • 0,不返回。預設值。

  • 1,返回認證。

  • 2, 返回認證及其憑證鏈結 。

1

EnableCrl

integer

是否包含 CRL 地址

0 - 否 1 - 是

1

Tags

array<object>

標籤列表。

object

標籤列表。

Key

string

標籤鍵。

account

Value

string

標籤值。

1

ResourceGroupId

string

資源分組 ID。

rg-aek****wia

CustomIdentifier

string

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

****6bb538d538c70c01f81jh2****

AliasName

string

設定簽發認證的名稱。

cert-name

ClientToken

string

用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字元,且該參數值中不能包含非 ASCII 字元。

XXX

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

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

返回參數

名稱

類型

描述

樣本值

object

CreateCertificateResponse

X509Certificate

string

用戶端認證的內容。

-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----

CertificateChain

string

CA 憑證鏈。

-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n

Identifier

string

用戶端認證的唯一識別碼。

190ae6bb538d538c70c01f81dcf2****

SerialNumber

string

認證序號。

084bde9cd233f0ddae33adc438cfbbbd****

RequestId

string

本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。

8C467B38-3910-447D-87BC-AC049166F216

樣本

正常返回樣本

JSON格式

{
  "X509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
  "CertificateChain": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n",
  "Identifier": "190ae6bb538d538c70c01f81dcf2****",
  "SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
  "RequestId": "8C467B38-3910-447D-87BC-AC049166F216"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情