API 概覽

API標準及多語言預置SDK

本產品（cas/2020-06-30）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

私有 CA 憑證

API	標題	API概述
CreateRootCACertificate	建立根CA認證	建立一個根CA認證。
CreateSubCACertificate	建立子CA認證	建立一個子CA認證。
CreateExternalCACertificate	建立外部子CA認證	基於CSR和API參數建立並頒發外部子CA認證。
GetCAInstanceStatus	查詢CA執行個體的狀態資訊	查詢您通過SSL認證服務控制台購買的私人根CA執行個體或私人子CA執行個體的狀態資訊。
DescribeCACertificateCount	查詢已建立的CA認證的數量	查詢已建立的CA認證的數量。
DescribeCACertificateList	查詢所有根CA認證和子CA認證的資訊	查詢所有根CA認證和子CA認證的資訊。
DescribeCACertificate	查詢單個根CA認證或子CA認證的詳細資料	查詢CA詳情。
UpdateCACertificateStatus	更新CA認證狀態	將根CA認證或子CA認證的狀態由正常簽發修改為吊銷。

用戶端和伺服器端憑證

API	標題	API概述
CreateCustomCertificate	頒發自訂認證	使用指定的認證主體名稱、認證主題別名、密鑰用法、擴充金鑰使用方法頒發數位憑證
CreateClientCertificateWithCsr	基於自訂的CSR簽發單個用戶端認證	基於自訂的CSR簽發單個用戶端認證
CreateServerCertificate	基於系統自動產生的CSR簽發單個服務端認證	基於系統自動產生的CSR簽發單個服務端認證
CreateServerCertificateWithCsr	基於自訂的CSR簽發單個服務端認證	基於自訂的CSR簽發單個服務端認證
CreateRevokeClientCertificate	吊銷認證	吊銷某個用戶端認證或服務端認證。
DescribeCertificatePrivateKey	查詢認證的私密金鑰	擷取單個用戶端認證或服務端認證的私密金鑰（加密格式）。
DescribeClientCertificate	查詢認證詳細資料	通過認證的唯一識別碼查詢單個用戶端認證或服務端認證的詳細資料。
DescribeClientCertificateStatus	查詢認證的狀態資訊	通過認證的唯一識別碼查詢用戶端認證和服務端認證的狀態資訊。
ListClientCertificate	查詢認證列表	查詢所有用戶端認證和服務端認證的詳細資料。
ListRevokeCertificate	查詢吊銷認證列表	查詢所有已被吊銷的用戶端認證和服務端認證的詳細資料。

其他

API	標題	API概述
ListPcaCaCertificate	擷取私人CA列表	查詢私人CA機構認證。
UploadPcaCertToCas	同步私人認證到認證服務	上傳PCA認證到SSL上傳認證。

Others

API	標題	API概述
AssignCertificateCount	分配認證數量	分配認證使用數量
CreateClientCertificate	基於系統自動產生的CSR簽發單個用戶端認證	基於系統自動產生的CSR簽發單個用戶端認證
DeleteClientCertificate	刪除認證	刪除已吊銷的用戶端認證或服務端認證。
DescribeClientCertificateForSerialNumber	根據認證序號查詢認證	通過認證的序號批量查詢用戶端認證或服務端認證的詳細資料。
DescribeClientCertificateStatusForSerialNumber	通過序號查詢認證狀態	通過認證的序號查詢用戶端認證和服務端認證的狀態資訊。
DescribePcaAndExternalCACertificateList	擷取ipa認證列表	返回使用者所有CaCertificate，包括PCA內部產生的與匯入的外部認證。
GetCaInstanceCrlAddress	擷取CA的吊銷列表	擷取ca的crl地址
ListAllEndEntityInstance	擷取可分配認證的終端CA	查詢終端執行個體
ListCACertificateLog	查詢CA認證的動作記錄	查詢CA認證的動作記錄。
ListCert	查詢CA簽發的認證列表	擷取認證列表。
ListTagResources	查詢資源和標籤關係	查詢資源（SSL認證執行個體）和標籤的對應關係。
MoveResourceGroup	刪除資源群組	修改資源所屬的資源群組。
TagResources	為指定資源（SSL認證執行個體）綁定標籤	為指定資源（SSL認證執行個體）綁定標籤。
UntagResources	移除指定資源（SSL認證執行個體）的標籤	移除標籤。
UpdatePcaCertificate	更新PCA資源屬性	更新認證屬性