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