基於自訂的 CSR 簽發單個用戶端憑證。
介面說明
呼叫本介面之前,您必須已經呼叫 CreateRootCACertificate 建立了根 CA 憑證,並且呼叫 CreateSubCACertificate 建立了子 CA 憑證。只有子 CA 憑證才能簽發用戶端憑證。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫將會被限流,這可能影響您的業務,請合理呼叫。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-cert:CreateClientCertificateWithCsr |
create |
*全部資源。
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Csr |
string |
否 |
CSR 內容。您可以透過 OpenSSL 工具或者 Keytool 工具產生 CSR。更多資訊,請參見如何製作 CSR 檔案。 |
-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST----- |
| SanType |
integer |
否 |
用戶端憑證的擴充資訊 SAN(Subject Alternative Name)的類型。取值:
|
2 |
| SanValue |
string |
否 |
用戶端憑證的具體擴充資訊。支援輸入多個擴充資訊,如果您需要輸入多個擴充資訊,請用半形逗號(,)將其隔開。
|
somebody@example.com |
| Organization |
string |
否 |
機構名稱,預設值:Alibaba Inc。 |
Alibaba Inc |
| OrganizationUnit |
string |
否 |
部門名稱,預設值:Aliyun CDN。 |
Security |
| Country |
string |
否 |
國家代碼,例如 CN、US。 |
CN |
| CommonName |
string |
否 |
設定憑證的公用名稱。支援使用中文、英文字元等。 說明
如果您設定了 CsrPemString 參數,則 CommonName 參數取值以 CsrPemString 參數中的對應資訊為準。 |
aliyundoc.com |
| State |
string |
否 |
設定憑證組織機構所在省份或州的名稱。支援使用中文、英文字元等。預設為簽發該憑證的子 CA 憑證組織機構所在省份或州的名稱。 |
Zhejiang |
| Locality |
string |
否 |
設定憑證組織機構所在城市的名稱。支援使用中文、英文字元等。 預設為簽發該憑證的子 CA 憑證的組織機構所在城市的名稱。 |
Hangzhou |
| Algorithm |
string |
否 |
用戶端憑證的金鑰演算法。金鑰演算法使用
用戶端憑證的加密演算法必須與子 CA 憑證一致,金鑰長度可以不一致。例如:子 CA 憑證的金鑰演算法為 RSA_2048,則用戶端憑證的金鑰演算法必須是 RSA_1024、RSA_2048、RSA_4096 中的一種。 說明
您可以呼叫 DescribeCACertificate 查詢子 CA 憑證的金鑰演算法。 |
RSA_2048 |
| ParentIdentifier |
string |
否 |
簽發該憑證的子 CA 憑證的唯一識別碼。 說明
您可以呼叫 DescribeCACertificateList 查詢子 CA 憑證的唯一識別碼。 |
270ae6bb538d538c70c01f81fg3**** |
| Years |
integer |
否 |
憑證有效期間。單位:年。 |
1 |
| Months |
integer |
否 |
憑證有效期間。單位:月。 |
12 |
| Days |
integer |
否 |
用戶端憑證的有效期間。單位:天。 Days、BeforeTime、AfterTime 參數不能同時為空,同時 BeforeTime 和 AfterTime 參數必須同時為空或者同時設定。該參數具體設定說明如下:
說明
|
365 |
| BeforeTime |
integer |
否 |
用戶端憑證的簽發時間,使用時間戳記格式,預設為您呼叫該介面的時間。單位:秒。 說明
BeforeTime 和 AfterTime 參數必須同時為空或者同時設定。 |
1634283958 |
| AfterTime |
integer |
否 |
用戶端憑證的服務到期時間,使用時間戳記格式。單位:秒。 說明
BeforeTime 和 AfterTime 參數必須同時為空或者同時設定。 |
1665819958 |
| Immediately |
integer |
否 |
立即返回數位憑證。
|
1 |
| EnableCrl |
integer |
否 |
是否包含 CRL 地址。 0 - 否 1 - 是 |
1 |
| Tags |
array<object> |
否 |
標籤清單。 |
|
|
object |
否 |
標籤清單。 |
||
| Key |
string |
否 |
標籤鍵。 |
database |
| Value |
string |
否 |
標籤的值(value)。 |
1 |
| ResourceGroupId |
string |
否 |
憑證所屬資源群組的 ID。 |
rg-ae******4wia |
| CustomIdentifier |
string |
否 |
使用者自訂標識,唯一鍵。 |
***e6bb538d538c70c01f81fg3**** |
| AsynchronousFlag |
boolean |
否 |
非同步處理標識。當傳值為「true」時,後端服務將採用非同步的方式申請憑證。 使用者請求後可透過 ListClientCertificate 介面獲取最新憑證。 |
false |
呼叫 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 |
用戶端憑證的唯一識別碼。 |
200ae6bb538d538c70c01f81dcf2**** |
| SerialNumber |
string |
憑證序號。 |
084bde9cd233f0ddae33adc438cfbbbd**** |
| RequestId |
string |
本次呼叫請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
31C66C7B-671A-4297-9187-2C4477247A74 |
| CertSignBufKmc |
string |
加密憑證內容。 |
MIIDYDCCAwWgAwIBAgIU *** TmTk0CS3WNweqsjMEETyxd2pzU6DA |
| CertKmcRep1 |
string |
加密憑證密文。 |
userSeal=MHkCIEu94PQAahFWuFk% *** EtFw%2FkMMBjw8i5bFfSkV%2FIUrcOJD |
樣本
正常返回樣本
JSON格式
{
"X509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
"CertificateChain": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n",
"Identifier": "200ae6bb538d538c70c01f81dcf2****",
"SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
"RequestId": "31C66C7B-671A-4297-9187-2C4477247A74",
"CertSignBufKmc": "MIIDYDCCAwWgAwIBAgIU\n***\nTmTk0CS3WNweqsjMEETyxd2pzU6DA",
"CertKmcRep1": "userSeal=MHkCIEu94PQAahFWuFk%\n***\nEtFw%2FkMMBjw8i5bFfSkV%2FIUrcOJD"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。