API の概要

API 標準および多言語対応の SDK

本製品 (cas/2020-04-07) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。

カスタム署名

署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。

はじめに

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。

API セキュリティを確保するには、以下を作成し、設定する必要があります。

RAM ユーザー
RAM ユーザー用の AccessKey ペア

リソースグループ

API	タイトル	説明
ListInstances	インスタンスのリストを取得します	インスタンスのリストを取得します。
UpdateInstance	UpdateInstance	インスタンスを更新します。
GetInstanceDetail	インスタンスの詳細を取得します	インスタンスの詳細を照会します。
DeleteInstance	DeleteInstance	インスタンスを削除します。
RefundInstance	RefundInstance	購入から 7 日以内にリクエストが行われた場合、インスタンスを返金します。
GetInstanceSummary	GetInstanceSummary	インスタンス統計情報
ApplyCertificate	ApplyCertificate	証明書をリクエストします。
GetTaskAttribute	GetTaskAttribute	送信された証明書リクエストの結果を取得します。
CancelPendingCertificate	CancelPendingCertificate	証明書の申請を取り消します。
ListCertificates	ListCertificates	証明書のリストを取得します。
RevokeCertificate	証明書を取り消します	証明書を取り消します。
GetCertificateDetail	GetCertificateDetail	証明書の本文と秘密鍵を除き、証明書の詳細を取得します。
GetUserCertificateDetail	GetUserCertificateDetail	この操作を呼び出して、証明書の詳細 (基本情報、コンテンツ、秘密鍵を含む) を取得します。証明書と秘密鍵をダウンロードすることもできます。
DeleteUserCertificate	DeleteUserCertificate	Certificate Management Service から、期限切れ、取り消された、または手動でアップロードされた証明書を削除します。
UploadUserCertificate	UploadUserCertificate	この操作は、標準の SM 証明書と非 SM 証明書を含む証明書をアップロードするために使用されます。

Deployment タスク

API	タイトル	説明
MoveResourceGroup	MoveResourceGroup	証明書または証明書注文が属するリソースグループを変更します。

証明書リクエスト

API	タイトル	説明
CreateDeploymentJob	CreateDeploymentJob	証明書デプロイメントタスクを作成します。SSL 証明書が発行された後、証明書デプロイメントタスクを作成して、証明書を Alibaba Cloud サービスにすぐにデプロイするか、特定の時点でサービスにデプロイすることができます。これにより、証明書は信頼された身分認証を実装し、サービスでホストされているウェブサイトのデータ伝送のセキュリティを確保できます。
UpdateDeploymentJobStatus	UpdateDeploymentJobStatus	デプロイメントタスクのステータスを更新します。
ListDeploymentJob	ListDeploymentJob	作成されたデプロイメントタスクのリストを照会します。
UpdateDeploymentJob	UpdateDeploymentJob	証明書デプロイメントタスクの構成（例：証明書または対象リソース）を更新します。
DescribeDeploymentJob	DescribeDeploymentJob	デプロイメントジョブの詳細を照会します。CreateDeploymentJob 操作を呼び出してデプロイメントジョブを作成し、ジョブの ID を取得できます。
ListWorkerResource	ListWorkerResource	デプロイメントタスクのワーカータスクに関する詳細を照会します。Alibaba Cloud では、一度に複数の証明書をデプロイできます。そのため、1 つのデプロイメントタスクには、複数のクラウドサービスにおける複数のワーカータスクが含まれる場合があります。ワーカータスクとは、クラウドサービス内のクラウドリソースに証明書をデプロイするタスクを指します。
DescribeDeploymentJobStatus	DescribeDeploymentJobStatus	デプロイメントタスク内のワーカータスクの数を照会します。
ListDeploymentJobResource	ListDeploymentJobResource	進行中のデプロイメントタスクに関連付けられているクラウドリソースのリストを取得します。空のリストは、関連付けられているリソースが無効であり、再関連付けが必要であることを示します。タスクが完了した場合、関連付けられているリソースが変更されていると、この操作は空のリストを返します。
ListContact	ListContact	連絡先のリストを照会します。
ListDeploymentJobCert	ListDeploymentJobCert	デプロイメントタスクに関連付けられた証明書（例：証明書インスタンス ID、タイプ、名前）を照会します。
UpdateWorkerResourceStatus	UpdateWorkerResourceStatus	デプロイメントタスク内のワーカータスクをロールバックまたは実行します。
DeleteWorkerResource	DeleteWorkerResource	デプロイタスクのワーカーを削除します。
DeleteDeploymentJob	DeleteDeploymentJob	証明書のデプロイメントタスクを削除します。
DescribeCloudResourceStatus	DescribeCloudResourceStatus	マルチクラウドデプロイメントタスクを使用して証明書をデプロイしたサードパーティのクラウドリソースの数を照会します。
ListCloudResources	ListCloudResources	クラウドサービスプロバイダー (CSP) とクラウドサービスの証明書リソースを照会します。
ListCloudAccess	ListCloudAccess	マルチクラウドデプロイメント用の AccessKey ペアのリストをクエリします。

注文

API	タイトル	説明
GetCertWarehouseQuota	GetCertWarehouseQuota	証明書リポジトリ内のデータに対する署名、署名検証、暗号化、または復号化の各 API 呼び出しでクォータが消費されます。クォータを使い切ると、それ以上の API 呼び出しはできなくなります。この操作を呼び出すことで、証明書リポジトリのクォータを照会できます。
ListCertWarehouse	ListCertWarehouse	証明書リポジトリを照会します。
ListCert	ListCert	この API は、証明書ストア内の証明書を照会します。
Sign	Sign	この操作は、証明書リポジトリの PCA 証明書を使用してデジタル署名を作成します。
Verify	Verify	この API は、証明書リポジトリ内のプライベート認証局 (PCA) の証明書の署名を検証します。
Encrypt	Encrypt	この操作を呼び出して、証明書リポジトリ内の証明書を暗号化できます。
Decrypt	Decrypt	この API 操作は、証明書リポジトリ内の証明書を復号します。
UploadPCACert	UploadPCACert	PCA 証明書を証明書ウェアハウスにアップロードします。
DeletePCACert	DeletePCACert	証明書アプリケーションリポジトリからプライベート証明書を削除します。
CreateWHClientCertificate	CreateWHClientCertificate	一般ユーザー証明書リポジトリから単一のクライアント証明書を発行します。
RevokeWHClientCertificate	RevokeWHClientCertificate	クライアント証明書を証明書リポジトリから取り消します。

証明書リポジトリ

API	タイトル	説明
ListCsr	ListCsr	CSR の詳細を照会します。
CreateCsr	CreateCsr	証明書署名要求 (CSR) を作成します。CSR ファイルには、申請する SSL 証明書に関する情報が含まれます。この情報には、証明書にバインドするドメイン名、証明書の所有者の名前、および地理的な場所が含まれます。認証局 (CA) に証明書申請を提出する際、CSR を提供する必要があります。CA が証明書申請を承認すると、CA はルート CA の秘密鍵を使用して CSR に署名し、公開鍵ファイルを生成します。この公開鍵ファイルが、CA から発行される SSL 証明書です。SSL 証明書の秘密鍵は、CSR の作成時に生成されます。
UploadCsr	UploadCsr	Alibaba Cloud Digital Certificate Management Service では、既存の証明書署名リクエスト (CSR) をアップロードできます。アップロードした CSR を使用して証明書をリクエストし、アップロードしたすべての CSR を一元管理できます。
GetCsrDetail	GetCsrDetail	証明書署名要求 (CSR) ファイルの内容を取得します。
UpdateCsr	UpdateCsr	ローカルの証明書署名リクエスト (CSR) を秘密鍵なしでアップロードした場合、この操作を呼び出して秘密鍵をアップロードまたは更新できます。
DeleteCsr	DeleteCsr	不要になった証明書署名要求 (CSR) を削除します。

CSR 管理

API	タイトル	説明
DescribePackageState	DescribePackageState	購入したドメイン検証 (DV) 証明書のクォータとクォータ使用量を照会します。
ListUserCertificateOrder	ListUserCertificateOrder	証明書または注文のリストを照会します。
CreateCertificateForPackageRequest	CreateCertificateForPackageRequest	証明書申請を送信します。
CancelCertificateForPackageRequest	CancelCertificateForPackageRequest	注文が発行済みの場合、この操作は証明書を取り消します。注文が保留中の場合、この操作は注文をキャンセルし、クォータを復元します。
CancelOrderRequest	CancelOrderRequest	検証待ちまたは審査中の証明書申請注文をキャンセルします。
RenewCertificateOrderForPackageRequest	RenewCertificateOrderForPackageRequest	発行済みの証明書の更新申請を提出します。

その他

API	タイトル	説明
DescribeCertificateState	DescribeCertificateState	証明書アプリケーション注文のステータス（ドメイン検証の進捗状況など）を照会します。
CreateCertificateWithCsrRequest	CreateCertificateWithCsrRequest	カスタムの証明書署名要求 (CSR) ファイルを使用して、ドメイン検証 (DV) 証明書を購入、申請、発行します。証明書サービスの拡張機能を利用することで、数回のクリック操作で DV 証明書を購入・申請できます。
CreateCertificateRequest	CreateCertificateRequest	拡張証明書サービスを利用して、ドメイン検証 (DV) 証明書の購入、申請、発行を行います。
DeleteCertificateRequest	DeleteCertificateRequest	ドメイン検証 (DV) 証明書の申請に失敗した注文を削除します。

その他

API	タイトル	説明
AddCloudAccess	AddCloudAccess	権限付与のための AccessKey を追加します。
CreateWarehouse	CreateWarehouse	証明書ウェアハウスを作成します。
DeleteCloudAccess	DeleteCloudAccess	アクセスキーを削除します。
DeleteWarehouse	DeleteWarehouse	証明書ウォレハウスを削除します。
DescribeWarehouseCert	DescribeWarehouseCert	証明書ウェアハウスに保存されている証明書の詳細を取得します。
GetAssetCount	GetAssetCount	アセットの数をカウントします。
GetRiskCount	GetRiskCount	リスクのある資産の数をカウントします。
ListAssetCount	ListAssetCount	クラウドプロダクトリソースの統計情報を照会します。
ListWarehouse	ListWarehouse	ウェアハウスの一覧を取得します。

Others

API	タイトル	説明
BatchUpdateNoticeStatus	BatchUpdateNoticeStatus	通知ステータスを一括で更新します。
GetMatchedResources	GetMatchedResources	証明書に一致するリソースを取得します。