API 標準および多言語対応の SDK
本製品 (oos/2019-06-01) の 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 |
タイトル |
説明 |
| DescribeRegions | DescribeRegions | サポートされているリージョンを照会します。 |
テンプレート
|
API |
タイトル |
説明 |
| CreateTemplate | CreateTemplate | テンプレートを作成します。 |
| DeleteTemplates | DeleteTemplates | 複数のテンプレートを削除します。 |
| DeleteTemplate | DeleteTemplate | テンプレートを削除します。 |
| UpdateTemplate | UpdateTemplate | 既存のテンプレートの情報を更新します。 |
| ListTemplateVersions | ListTemplateVersions | 指定されたテンプレートのバージョンを一覧表示します。 |
| ListTemplates | ListTemplates | テンプレートを照会します。 複数のメソッドを使用してテンプレートをフィルターできます。 |
| GetTemplate | GetTemplate | テンプレートとその内容を取得します。 |
| ListExecutionRiskyTasks | ListExecutionRiskyTasks | テンプレート内の高リスクタスクを一覧表示します。 |
| ValidateTemplateContent | ValidateTemplateContent | テンプレートの構文を検証します。 |
実行
|
API |
タイトル |
説明 |
| DeleteExecutions | DeleteExecutions | 実行を削除します。 |
| StartExecution | StartExecution | 実行を開始します。 |
| UpdateExecution | UpdateExecution | 実行中または待機中の実行を更新します。 |
| GetExecutionTemplate | GetExecutionTemplate | 実行 のテンプレートに関する情報 (テンプレート のコンテンツを含む) を照会します。 |
| ListExecutions | ListExecutions | 実行回数を一覧表示し、複数のフィルターをサポートします。 |
| ListExecutionLogs | ListExecutionLogs | 実行のログを返します。 |
| ListTaskExecutions | ListTaskExecutions | 複数のフィルターを使用してタスク実行を照会します。 |
| ListResourceExecutionStatus | ListResourceExecutionStatus | Elastic Compute Service (ECS) インスタンスに対する運用保守操作を含む、スケジュールされた実行の情報を照会します。 |
| CancelExecution | CancelExecution | 実行をキャンセルします。 |
| GenerateExecutionPolicy | GenerateExecutionPolicy | テンプレートを実行するために必要な RAM ポリシーを生成します。 |
| NotifyExecution | NotifyExecution | 待機中の実行に後続の操作を通知します。 |
| TriggerExecution | TriggerExecution | イベントトリガータスクまたはアラートトリガータスクを含む、開始済みの実行をデバッグします。この操作が呼び出されると、メッセージ本文がイベントトリガータスクまたはアラートトリガータスクに送信されます。トリガータスクがメッセージ本文を受信すると、新しいサブ実行が生成されます。 |
操作
|
API |
タイトル |
説明 |
| ListActions | ListActions | アトミックアクションやクラウドプロダクトアクションなど、利用可能な操作を照会します。 |
パラメーター
|
API |
タイトル |
説明 |
| 共通パラメーター | 共通パラメーター | |
| CreateParameter | CreateParameter | 共通パラメーターを作成します。 |
| DeleteParameter | DeleteParameter | この操作は、共通パラメータを削除します。 |
| UpdateParameter | UpdateParameter | 共通パラメーターを更新します。 |
| GetParameter | GetParameter | 標準または共通のパラメーターとその値を取得します。 |
| ListParameters | ListParameters | 共通パラメーターを照会します。共通パラメーターをフィルターするための複数の方法がサポートされています。 |
| ListParameterVersions | ListParameterVersions | 指定された標準パラメーターのバージョンを一覧表示します。 |
| GetParametersByPath | GetParametersByPath | パス別にパラメータを取得します。 |
| GetParameters | GetParameters | 1 つ以上のパラメーターの詳細を取得します。 |
| 暗号化パラメーター | 暗号化パラメーター | |
| CreateSecretParameter | CreateSecretParameter | 暗号化パラメーターを作成します。この操作を呼び出す前に、Key Management Service (KMS) の CreateSecret 操作を呼び出す権限があることを確認してください。 |
| DeleteSecretParameter | DeleteSecretParameter | 暗号化パラメーターを削除します。この操作には、Key Management Service ( KMS ) DeleteSecret API を呼び出す権限が必要です。 |
| UpdateSecretParameter | UpdateSecretParameter | 暗号化パラメーターを更新します。この操作を呼び出す前に、Key Management Service (KMS) の UpdateSecretValue 操作を呼び出す権限があることを確認してください。 |
| GetSecretParameter | GetSecretParameter | 暗号化されたパラメーターとその値を取得します。 この操作を呼び出す前に、KMS の GetSecretValue API 操作を呼び出す権限を持っていることを確認してください。 |
| ListSecretParameters | ListSecretParameters | 共通パラメーターを照会します。複数のクエリタイプがサポートされています。 |
| ListSecretParameterVersions | ListSecretParameterVersions | シークレットパラメータの複数のバージョンをクエリします。 |
| GetSecretParametersByPath | GetSecretParametersByPath | パスによって暗号化されたパラメータを取得します。 この操作を呼び出す前に、Key Management Service ( KMS ) の GetSecretValue 操作を呼び出す権限を持っていることを確認してください。 |
| GetSecretParameters | GetSecretParameters | 1 つ以上の暗号化されたパラメータの詳細を取得します。 この操作を使用するには、Key Management Service ( KMS ) の GetSecretValue 操作を呼び出す権限が必要です。 |
パッチ管理
|
API |
タイトル |
説明 |
| パッチベースライン | パッチベースライン | |
| CreatePatchBaseline | CreatePatchBaseline | パッチベースラインを作成します。 |
| DeletePatchBaseline | DeletePatchBaseline | Deletes a patch baseline. |
| UpdatePatchBaseline | UpdatePatchBaseline | パッチベースラインを更新します。 |
| GetPatchBaseline | GetPatchBaseline | パッチベースラインの詳細を照会します。 |
| ListPatchBaselines | ListPatchBaselines | パッチベースラインのリストを照会します。 |
| RegisterDefaultPatchBaseline | RegisterDefaultPatchBaseline | デフォルトのパッチベースラインを登録します。 |
| パッチステータス | パッチステータス | |
| ListInstancePatchStates | ListInstancePatchStates | 1 つ以上のインスタンスのパッチ状態を取得します。 |
| ListInstancePatches | ListInstancePatches | 指定されたインスタンスのパッチを一覧表示します。 |
構成インベントリ
|
API |
タイトル |
説明 |
| ListInventoryEntries | ListInventoryEntries | Elastic Compute Service (ECS) インスタンスの構成を照会します。 |
| GetInventorySchema | GetInventorySchema | 構成リストのプロパティを照会します。 |
| SearchInventory | 在庫を検索します | 在庫に関する詳細情報または集計情報をクエリします。 |
望ましい状態構成
|
API |
タイトル |
説明 |
| CreateStateConfiguration | CreateStateConfiguration | 状態設定を作成します。 |
| DeleteStateConfigurations | DeleteStateConfigurations | 複数の望ましい状態構成を一度に削除します。 |
| UpdateStateConfiguration | UpdateStateConfiguration | 目的状態構成を更新します。 |
| ListStateConfigurations | ListStateConfigurations | 状態設定を照会します。 |
O&M 項目
|
API |
タイトル |
説明 |
| CreateOpsItem | CreateOpsItem | O&M アイテムを作成します。 |
| GetOpsItem | GetOpsItem | O&M アイテムの詳細を照会します。 |
| ListOpsItems | ListOpsItems | O&M アイテムを照会します。 |
| UpdateOpsItem | UpdateOpsItem | O&M アイテムを変更します。 |
| DeleteOpsItems | DeleteOpsItems | O&M アイテムを削除します。 |
サービス構成
|
API |
タイトル |
説明 |
| SetServiceSettings | SetServiceSettings | テンプレート実行記録の配信を有効化または無効化し、配信先を設定し、Apsara DevOps のエンタープライズ ID を関連付けます。 |
| GetServiceSettings | GetServiceSettings | 実行の配信構成や関連付けられた Apsara DevOps エンタープライズの詳細など、サービスの構成設定を取得します。 |
アプリケーション管理
|
API |
タイトル |
説明 |
| アプリケーション | アプリケーション | |
| CreateApplication | CreateApplication | アプリケーションを作成します。この操作は、中国 (杭州) リージョンに存在するアプリケーションに対してのみ呼び出すことができます。中国 (杭州) リージョンのエンドポイントを使用してください。 |
| DeleteApplication | DeleteApplication | アプリケーションを削除します。この操作は、中国 (杭州) リージョンに存在するアプリケーションに対してのみ呼び出すことができます。中国 (杭州) リージョンのエンドポイントを使用してください。 |
| UpdateApplication | UpdateApplication | アプリケーションを更新します。この操作は、中国 (杭州) リージョンに存在するアプリケーションに対してのみ呼び出すことができます。中国 (杭州) リージョンのエンドポイントを使用してください。 |
| GetApplication | GetApplication | アプリケーションの情報を照会します。この操作は、中国 (杭州) リージョンにあるアプリケーションに対してのみ呼び出すことができます。中国 (杭州) リージョンのエンドポイントを使用してください。 |
| ListApplications | ListApplications | アプリケーションのリストをクエリします。この操作は、中国 (杭州) リージョンにあるアプリケーションに対してのみ呼び出すことができます。中国 (杭州) リージョンのエンドポイントを使用してください。 |
| アプリケーショングループ | アプリケーショングループ | |
| CreateApplicationGroup | CreateApplicationGroup | アプリケーショングループを作成します。 この操作は、中国 (杭州) リージョンにあるアプリケーショングループに対してのみ呼び出すことができます。 中国 (杭州) リージョンのエンドポイントを使用してください。 |
| DeleteApplicationGroup | DeleteApplicationGroup | アプリケーショングループを削除します。この操作は、中国 (杭州) リージョンに存在するアプリケーショングループに対してのみ呼び出すことができます。中国 (杭州) リージョンのエンドポイントを使用してください。 |
| UpdateApplicationGroup | UpdateApplicationGroup | アプリケーショングループの情報を更新します。 アプリケーション管理サービスは中国 (杭州) リージョンでのみ利用可能です。このリージョンのエンドポイントを使用する必要があります。 |
| GetApplicationGroup | GetApplicationGroup | アプリケーショングループの詳細情報を取得します。アプリケーション管理機能は、中国 (杭州) リージョンでのみ利用可能です。このリージョン専用のエンドポイントをご利用ください。 |
| ListApplicationGroups | ListApplicationGroups | アプリケーション グループのリストを照会します。アプリケーション管理機能は、中国 (杭州) リージョンでのみ利用可能です。このリージョンのエンドポイントを使用していることを確認してください。 |
| DeployApplicationGroup | DeployApplicationGroup | アプリケーショングループをデプロイします。アプリケーション管理は、中国 (杭州) リージョンでのみ利用できます。このリージョンのエンドポイントを使用する必要があります。 |
| ContinueDeployApplicationGroup | ContinueDeployApplicationGroup | DeployApplicationGroup 操作の呼び出しでエラーが発生した場合に、アプリケーショングループのデプロイを続行します。この操作は、中国 (杭州) リージョンにあるアプリケーションに対してのみ呼び出すことができます。中国 (杭州) リージョンのエンドポイントを使用してください。 |
| DescribeApplicationGroupBill | DescribeApplicationGroupBill | アプリケーショングループのリソースコストを照会します。 |
タグ
|
API |
タイトル |
説明 |
| ListTagKeys | ListTagKeys | タグを照会します。 |
| ListTagValues | ListTagValues | 作成されたタグの値を一覧表示します。 |
| ListTagResources | ListTagResources | 1 つ以上のリソースに追加されたタグを照会します。 |
| UntagResources | UntagResources | 1 つ以上のリソースからタグを削除します。 |
| TagResources | TagResources | 1 つ以上のリソースにタグを追加します。 |
リソースグループ
|
API |
タイトル |
説明 |
| ChangeResourceGroup | ChangeResourceGroup | クラウドリソースが属するリソースグループを変更します。 |
拡張
|
API |
タイトル |
説明 |
| UpdateInstancePackageState | UpdateInstancePackageState | インスタンスにインストールされている拡張機能の状態を更新します。 |
| ListInstancePackageStates | ListInstancePackageStates | インスタンス上の各パッケージのステータスをリストします。 |
その他
|
API |
タイトル |
説明 |
| GenerateOpsItem | GenerateOpsItem | O&M 項目 (OpsItem) を生成します。 |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | パラメーターに許可される値を取得します。 |
| UpdateTemplateAttributes | UpdateTemplateAttributes | テンプレートの属性を更新します。 |
| CheckGitRepoFileExists | CheckGitRepoFileExists | リポジトリにファイルが存在するかどうかを確認します。 |
| ListGitOrganizations | ListGitOrganizations | 認証済みユーザーの Git 組織を取得します。 |
| ListGitRepositories | ListGitRepositories | Git リポジトリを一覧表示します。 |
| ListGitBranches | ListGitBranches | 指定された Git リポジトリのすべてのブランチを一覧表示します。 |
| ListGitAccounts | ListGitAccounts | 現在の Alibaba Cloud ユーザーがアプリケーション管理のために承認した Git アカウントを一覧表示します。 |
| CreateGitRepository | CreateGitRepository | Git リポジトリを作成します。 |
| CheckGitRepositoryExists | CheckGitRepositoryExists | リポジトリが存在するかどうかを確認します。 |
| GetGitBranch | GetGitBranch | Git ブランチの詳細をクエリします。権限付与なしでパブリックリポジトリをクエリできます。 |
| ListGitRepositoryContents | ListGitRepositoryContents | リポジトリ内のファイルとディレクトリを一覧表示します。 |
| GetGitRepository | GetGitRepository | Git リポジトリの詳細を照会します。 |
| ListTaskExecutionInvocations | ListTaskExecutionInvocations | タスク実行のクラウドアシスタントコマンドの実行 ID を取得します。 |
| GetChatConfiguration | GetChatConfiguration | DingTalk などのプラットフォームのチャット構成を作成、更新、取得、削除します。 |
| CreateChatConfiguration | CreateChatConfiguration | DingTalk などのプラットフォーム向けにチャット構成を新規作成、更新、クエリ実行、および削除できます。 |
| ListChatConfigurations | ListChatConfigurations | DingTalk などのプラットフォームのチャット構成を作成、更新、取得、削除します。 |
| UpdateChatConfiguration | UpdateChatConfiguration | DingTalk などのプラットフォームのチャット構成を作成、更新、照会、削除します。 |
| DeleteChatConfiguration | DeleteChatConfiguration | この操作は、DingTalk などのプラットフォームのチャット構成を作成、更新、クエリ、削除するために使用します。 |
| ListDeployRevisions | ListDeployRevisions | アプリケーションのリビジョンを一覧表示します。 |
| CreateDeployRevision | CreateDeployRevision | デプロイメントのリビジョンを作成します。 |
| GetDeployRevision | GetDeployRevision | アプリケーションリビジョンの詳細を取得します。 |
| StartDebugExecution | StartDebugExecution | デバッグ実行を開始します。 |