API 概覽

API標準及多語言預置SDK

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

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

自訂簽名情境

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

帳號與安全準備

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

資源群組

API	標題	API概述
ListInstances	執行個體列表	取得執行個體列表。
UpdateInstance	更新執行個體	更新執行個體
GetInstanceDetail	取得執行個體詳情	查詢執行個體詳情。
DeleteInstance	刪除執行個體	刪除執行個體
RefundInstance	執行個體退款	執行個體7天內退款。
GetInstanceSummary	執行個體匯總	執行個體統計
ApplyCertificate	申請認證	申請認證
GetTaskAttribute	申請認證提交結果查詢	申請認證提交結果查詢。
CancelPendingCertificate	撤回認證申請	撤回認證申請。
ListCertificates	認證列表	擷取認證列表
RevokeCertificate	吊銷憑證	吊銷憑證。
GetCertificateDetail	擷取認證詳情，不包含認證私密金鑰	查詢認證詳情，不返回認證內容和私密金鑰內容。
GetUserCertificateDetail	擷取認證詳情	本介面一般用於擷取認證詳情，包含基本資料和公私密金鑰內容。可以通過該介面下載認證內容和私密金鑰。
DeleteUserCertificate	刪除認證	刪除已到期、已吊銷或上傳的認證。
UploadUserCertificate	上傳認證	本介面一般用於上傳認證，包括標準國密認證或非國密認證。

部署任務

API	標題	API概述
MoveResourceGroup	修改資源所屬的資源群組	修改認證或認證訂單資源所屬的資源群組。

憑證請求

API	標題	API概述
CreateDeploymentJob	建立部署任務	SSL認證簽發完成後，您可以通過該介面建立不同類型的認證部署任務，立即或手動指定任務部署時間，將SSL認證部署到阿里雲產品或三方雲產品，為您的業務網站提供可信身份認證和安全資料轉送。
UpdateDeploymentJobStatus	更新部署任務狀態	更新部署任務狀態。
ListDeploymentJob	擷取部署工作清單	建立部署任務後，您可以通過該介面擷取部署工作清單。
UpdateDeploymentJob	更新部署任務	更新部署任務。
DescribeDeploymentJob	擷取部署任務詳情	通過CreateDeploymentJob建立部署任務後會擷取任務ID，您可以通過該任務ID調用本介面擷取部署任務詳情。
ListWorkerResource	擷取部署任務下的Worker工作清單	阿里雲支援批量部署認證，因此一個部署任務中可能對應多個雲產品子任務（Worker），對應每個產品中的資源執行個體，您可通過該介面查看Worker任務詳細資料。
DescribeDeploymentJobStatus	擷取部署任務下的Worker任務數	擷取部署任務下的Worker任務數。
ListDeploymentJobResource	擷取未執行部署任務關聯的雲產品資源清單	任務在未完成執行狀態時，擷取部署任務關聯的雲產品資源清單。返回空列表表示關聯的資源清單已經失效，需要重新關聯。任務已經完成狀態，資源發生變化時該列表返回空。
ListContact	擷取連絡人清單	擷取連絡人清單。
ListDeploymentJobCert	擷取部署任務的認證詳情	建立部署任務後，可通過本介面擷取部署到雲產品的認證基本資料，例如認證執行個體ID、認證類型、認證名稱等。
UpdateWorkerResourceStatus	更新部署任務下的Worker任務狀態	您可以通過該介面立即復原或執行部署任務下的Worker任務。
DeleteWorkerResource	刪除部署任務下的Worker任務	刪除部署任務worker（預覽）。
DeleteDeploymentJob	刪除部署任務	刪除部署任務。
DescribeCloudResourceStatus	擷取多雲部署的雲產品資源數	您可通過本介面擷取通過多雲部署任務，部署認證到三方雲產品的資源數。
ListCloudResources	擷取雲廠商及對應雲產品的資源清單	您可以通過本介面擷取雲廠商及對應雲產品的資源清單。
ListCloudAccess	擷取多雲部署任務AK列表	多雲部署擷取AK列表。

訂單

API	標題	API概述
GetCertWarehouseQuota	認證倉庫調用額度查詢	調用認證應用倉庫簽名、驗簽、加密和解密API時，會消耗API調用次數，API調用次數消耗完時，您將無法再調用相應的API。本介面一般用於查詢認證倉庫額度。
ListCertWarehouse	認證倉庫列表查詢	本介面一般用於查詢認證倉庫列表。
ListCert	認證倉庫中認證列表	本介面一般用於查詢認證倉庫中的認證。
Sign	認證倉庫簽名	本介面一般用於認證倉庫中的PCA認證簽名。
Verify	認證倉庫簽名驗簽	本介面一般用於認證倉庫中PCA認證的簽名校正。
Encrypt	認證倉庫中認證加密	本介面一般用於認證倉庫中認證加密。
Decrypt	認證倉庫中認證解密	本介面一般用於認證倉庫中認證解密。
UploadPCACert	上傳認證倉庫pca認證	本介面一般用於在認證倉庫中上傳PCA認證。
DeletePCACert	刪除認證倉庫中上傳的pca認證	本介面一般用於刪除認證倉庫中PCA認證。
CreateWHClientCertificate	申請認證倉庫中用戶端認證	一般使用者認證倉庫中，申請簽發單個用戶端認證。
RevokeWHClientCertificate	吊銷認證倉庫中用戶端認證	一般用於吊銷認證倉庫中用戶端認證。

憑證倉庫

API	標題	API概述
ListCsr	查詢CSR列表	查詢CSR列表資訊及CSR詳細資料。
CreateCsr	建立CSR	CSR是認證請求檔案，包含您的SSL認證資訊，例如，認證綁定的網域名稱、認證持有主體的名稱及地理位置資訊等。您向CA中心提交認證申請時，必須提供CSR。CA中心審核通過您的認證申請後，將使用其根CA私密金鑰為您提供的CSR簽名，產生SSL認證公開金鑰（即簽發給您的SSL認證）。SSL認證的私密金鑰即您在產生CSR時同時產生的私密金鑰。
UploadCsr	上傳CSR	阿里雲數位憑證管理服務支援上傳已有的CSR，以便申請認證時使用，同時也可對上傳的CSR進行統一管理。
GetCsrDetail	擷取CSR	通過CreateCsr介面建立CSR後會返回CsrId，您可以通過CsrId直接擷取CSR內容。
UpdateCsr	上傳或更新CSR私密金鑰	如果您在上傳本地CSR時未傳入CSR私密金鑰，您可以通過該介面上傳或更新CSR對應的私密金鑰。
DeleteCsr	刪除CSR	如果您不再需要某個CSR，可以將其刪除。

CSR管理

API	標題	API概述
DescribePackageState	查詢已經購買的DV認證總數和使用方式	查詢已經購買的DV認證總數和使用方式。
ListUserCertificateOrder	查詢使用者認證或者訂單列表	查詢使用者認證或者訂單列表。
CreateCertificateForPackageRequest	請求建立認證	提交認證申請。
CancelCertificateForPackageRequest	取消、吊銷額度訂單	如果是已簽發訂單，則吊銷已簽發的認證；如果是待申請訂單，則取消訂單，返回額度。
CancelOrderRequest	撤回審核中的申請訂單	撤回待驗證、審核中的認證申請訂單。
RenewCertificateOrderForPackageRequest	續訂認證訂單	為已簽發的認證申請訂單續約。

其他

API	標題	API概述
DescribeCertificateState	DescribeCertificateState	Queries the status of a certificate application order, such as domain validation progress.
CreateCertificateWithCsrRequest	購買、申請和簽發內建CSR檔案的DV認證	購買、申請和簽發內建CSR檔案的DV認證。認證擴充服務可通過一步完成DV認證的購買和申請。
CreateCertificateRequest	完成DV認證購買申請和簽發流程	完成擴充服務DV認證的購買、申請和簽發流程。
DeleteCertificateRequest	刪除DV認證申請失敗的訂單	刪除DV認證申請失敗的訂單。

其他

API	標題	API概述
AddCloudAccess	添加雲存取權限	添加授權ak。
CreateWarehouse	建立認證應用倉庫	建立認證倉庫。
DeleteCloudAccess	移除雲存取權限	刪除授權ak。
DeleteWarehouse	刪除認證應用倉庫	刪除認證應用倉庫。
DescribeWarehouseCert	擷取倉庫認證詳情	查詢倉庫認證詳情。
GetAssetCount	統計資產數量	統計資產數量。
GetRiskCount	統計風險資產數量	統計風險資產數量。
ListAssetCount	查詢雲產品資源統計列表	查詢雲產品資源統計列表。
ListWarehouse	擷取倉庫列表	查詢認證倉庫列表。
BatchUpdateNoticeStatus	更新訊息通知的狀態	批次更新通知狀態
GetMatchedResources	擷取認證可匹配的資源	擷取匹配的資源