API 標準および多言語対応の SDK
本製品 (ROS/2019-09-10) の 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 ペア
AI タスク操作
|
API |
タイトル |
説明 |
| CreateAITask | Create AI Task | AI タスクの作成 |
| GetAITask | GetAITask | タスク ID に基づいて AI タスクの情報を照会します。 |
| ListAITasks | ListAITasks | AI タスクのリストを照会します。 |
| ListAITaskEvents | ListAITaskEvents | AI タスクのイベントをクエリします。 |
スタック操作
|
API |
タイトル |
説明 |
| CreateStack | CreateStack | ROS テンプレートからスタックを作成し、リソースグループをデプロイします。 |
| DeleteStack | DeleteStack | スタックを削除します。リソースを保持するかどうかを指定できます。 |
| UpdateStack | スタックを更新します。 | 作成済みのスタックのリソース情報を更新します。 |
| ContinueCreateStack | ContinueCreateStack | スタックの作成に失敗した後も、スタックの作成を続行します。 |
| ListStacks | スタックリストの照会 | スタックのリストを照会します。 |
| CancelUpdateStack | CancelUpdateStack | スタックの更新操作をキャンセルします。スタックの更新中または作成中に、この操作を呼び出すことでスタックの更新をキャンセルできます。 |
| CancelStackOperation | CancelStackOperation | スタックに対するオペレーションをキャンセルします。 |
| ListStackEvents | スタックおよびそのリソースのイベントを照会します | スタックおよびスタック内のリソースのイベントを照会します。 |
| ListStackOperationRisks | ListStackOperationRisks | スタックの操作リスクを検出し、不足している権限とリスクの原因を返します。 |
| PreviewStack | PreviewStack | テンプレートに基づき、作成または更新するスタックの情報をプレビューします。このオペレーションを呼び出すことで、テンプレートのリソースが有効かどうかを検証できます。 |
リソース操作
|
API |
タイトル |
説明 |
| ListStackResources | スタック内のリソースを照会します | 指定されたスタック内のリソースを照会します。 |
| GetStackResource | スタック内のリソースを照会します | 特定のスタック内のリソースを照会します。 |
リソースシナリオ操作
|
API |
タイトル |
説明 |
| CreateTemplateScratch | CreateTemplateScratch | スクラッチ作成からシナリオを作成します。 |
| DeleteTemplateScratch | DeleteTemplateScratch | シナリオを削除します。 |
| UpdateTemplateScratch | UpdateTemplateScratch | シナリオを更新します。 |
| ListTemplateScratches | リソースシナリオの照会 | リソースシナリオのリストを照会します。 |
| GetTemplateScratch | リソースシナリオの詳細を取得します | リソースシナリオの詳細を取得します。 |
| GenerateTemplateByScratch | GenerateTemplateByScratch | リソースシナリオのテンプレートを生成します。 |
テンプレート操作
|
API |
タイトル |
説明 |
| ListTemplateVersions | ListTemplateVersions | テンプレートのバージョンリストを取得します。 |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | テンプレートのパラメーターの有効な値を取得します。 |
| SetTemplatePermission | SetTemplatePermission | テンプレートを共有または共有解除します。 |
| GetTemplateEstimateCost | GetTemplateEstimateCost | テンプレート内のリソースの概算価格を照会します。 |
| GetTemplateSummary | GetTemplateSummary | テンプレートリソースの情報は、関連するテンプレート、スタック、スタックグループ、または変更セットを使用して照会します。 |
| ValidateTemplate | ValidateTemplate | テンプレート URL または本文を指定して、スタック作成用のテンプレートを検証します。 |
| GenerateTemplatePolicy | テンプレートに必須のポリシー情報を生成します | 指定されたテンプレートに必須のポリシー情報を生成します。 |
スタックポリシー操作
|
API |
タイトル |
説明 |
| SetStackPolicy | SetStackPolicy | スタックにスタックポリシーを設定します。 |
| GetStackPolicy | GetStackPolicy | Alibaba Cloud リージョン内のスタックポリシーの情報を取得します。 |
変更セット操作
|
API |
タイトル |
説明 |
| CreateChangeSet | CreateChangeSet | スタックの変更セットを作成します。変更セットを実行する前に、変更内容をプレビューできます。 |
| DeleteChangeSet | DeleteChangeSet | 変更セットを削除します。 |
| GetChangeSet | GetChangeSet | 指定された変更セットの情報をクエリします。テンプレートの詳細を取得するかどうかを指定できます。 |
| ListChangeSets | 変更セットを照会します | 作成済みの変更セットの詳細を照会します。 |
| ExecuteChangeSet | ExecuteChangeSet | 変更セットを実行します。 |
スタックグループ操作
|
API |
タイトル |
説明 |
| CreateStackGroup | CreateStackGroup | Resource Orchestration Service (ROS) のテンプレートに基づいてスタックグループを作成します。スタックグループでは、複数の Alibaba Cloud アカウントとリージョンにわたってスタックを作成できます。 |
| DeleteStackGroup | DeleteStackGroup | スタックグループを削除します。 |
| UpdateStackGroup | Update Stack Group | 既存のスタックグループを更新します。 |
| ListStackGroups | ListStackGroups | 指定の Alibaba Cloud リージョンにあるスタックグループの詳細を照会します。 |
| GetStackGroup | GetStackGroup | Alibaba Cloud のリージョンで、スタックグループの詳細を名前で照会します。 |
| CreateStackInstances | CreateStackInstances | 指定されたリージョン内の 1 つ以上のアカウントに対してスタックインスタンスを作成します。 |
| DeleteStackInstances | DeleteStackInstances | 指定されたアカウントとリージョンからスタックインスタンスを削除します。リソースを保持することも選択できます。 |
| UpdateStackInstances | UpdateStackInstances | 指定されたリージョン内の 1 つ以上のアカウントのスタックインスタンスを更新します。 |
| GetStackInstance | GetStackInstance | スタックグループに関連付けられたスタックインスタンスに関する情報を照会します。 |
| StopStackGroupOperation | StopStackGroupOperation | スタックグループで進行中のオペレーションを停止します。 |
| ListStackInstances | ListStackInstances | Alibaba Cloud リージョン内のスタックグループのスタックインスタンス一覧を照会します。 |
| GetStackGroupOperation | GetStackGroupOperation | Alibaba Cloud のリージョン内でのスタックグループのオペレーションに関する情報をクエリします。 |
| ListStackGroupOperations | ListStackGroupOperations | Alibaba Cloud リージョン内のスタックグループ操作の情報を照会します。 |
| ListStackGroupOperationResults | ListStackGroupOperationResults | スタックグループのオペレーション結果を照会します。 |
| ImportStacksToStackGroup | ImportStacksToStackGroup | 複数のアカウントからスタックをスタックグループにインポートします。 |
ドリフト検出操作
|
API |
タイトル |
説明 |
| UpdateStackTemplateByResources | UpdateStackTemplateByResources | 検出されたスタックドリフトを解消します。 |
| GetStackDriftDetectionStatus | GetStackDriftDetectionStatus | スタックのドリフト検出ステータスを照会します。 |
| ListStackResourceDrifts | ListStackResourceDrifts | クエリ トークン。このパラメーターには、前回の API 呼び出しで返された NextToken の値を設定します。 |
| DetectStackDrift | DetectStackDrift | スタック内のリソースでドリフト検出を実行し、リソースが期待されるテンプレート設定からドリフトしているかどうかを確認します。 |
| DetectStackGroupDrift | DetectStackGroupDrift | スタックグループのドリフト検出を実行し、スタックグループが想定されるテンプレート設定からドリフトしているかどうかを確認します。 |
| DetectStackResourceDrift | DetectStackResourceDrift | スタック内のリソースに対してドリフト検出を実行し、リソースが期待される設定からドリフトしているかどうかを判定します。 |
診断操作
|
API |
タイトル |
説明 |
| CreateDiagnostic | CreateDiagnostic | 診断タスクを作成します。 |
| GetDiagnostic | GetDiagnostic | 指定された診断レポート ID に基づいて診断の詳細を取得します。 |
| ListDiagnostics | ListDiagnostics | 診断レポートをクエリします。 |
| DeleteDiagnostic | DeleteDiagnostic | 診断レコードを削除します。 |
リソースタイプ操作
|
API |
タイトル |
説明 |
| RegisterResourceType | RegisterResourceType | 新しいリソースタイプを作成するか、既存のリソースタイプの新しいバージョンを作成します。 |
| SetResourceType | SetResourceType | リソースタイプ、またはそのバージョンの説明を変更します。 |
| DeregisterResourceType | DeregisterResourceType | リソースタイプ、またはその特定のバージョンを登録解除します。 |
| ListResourceTypes | サポートされているリソースタイプを照会します | サポートされているリソースタイプのリストを照会します。 |
| GetResourceTypeTemplate | GetResourceTypeTemplate | リソースタイプに基づいてサンプルテンプレートを生成します。 |
| GetResourceType | リソースタイプの詳細を照会します | リソースタイプの詳細を照会します。 |
| ListResourceTypeVersions | リソースタイプのバージョンを照会します | リソースタイプのバージョンリストを照会します。ユーザーが作成したリソースタイプおよび Resource Orchestration サービス (ROS) が提供するリソースタイプを含みます。 |
| ListResourceTypeRegistrations | リソース登録 Record を照会します | リソース登録 Record のリストを照会します。 |
その他の操作
|
API |
タイトル |
説明 |
| SignalResource | SignalResource | スタック内のリソースにシグナルを送信します。 |
| GetServiceProvisions | GetServiceProvisions | Alibaba Cloud サービスの有効化ステータスおよびそのサービスリンクロールに関する情報をクエリします。 |
| GetFeatureDetails | GetFeatureDetails | Resource Orchestration Service (ROS) で利用可能な機能の詳細を照会します。 |
その他
|
API |
タイトル |
説明 |
| EnableServiceAccess | EnableServiceAccess | 信頼されたサービスアクセスを有効にします。 |
| EnableServices | EnableServices | サービスをバッチで有効化します。 |
| GetServiceAccess | GetServiceAccess | 信頼されたサービスを照会します。 |
| ListSummaries | ListSummaries | 概要を照会します。 |
Others
|
API |
タイトル |
説明 |
| CreateTemplate | CreateTemplate | カスタムテンプレートを作成します。 |
| DeleteTemplate | DeleteTemplate | テンプレートを削除します。 |
| DescribeRegions | DescribeRegions | 利用可能なリージョンの一覧を照会します。 |
| GetStack | スタック情報を照会します | スタック情報を照会します。 |
| GetTemplate | GetTemplate | スタックやスタックグループ、変更セット、または任意のカスタムテンプレート情報をもとに、テンプレートの詳細を取得します。 |
| ListChatMessages | セッションのメッセージ履歴を取得します。 | セッション ID を指定して、指定されたセッションのメッセージ履歴およびパイプラインスナップショットの一時的なダウンロード URL を取得します。 |
| ListTagKeys | ListTagKeys | 指定されたリージョン内のスタックまたはテンプレートのタグキーをクエリします。 |
| ListTagResources | ListTagResources | Alibaba Cloud リージョン内のテンプレートまたはスタックのリソースに追加されたタグをクエリします。 |
| ListTagValues | ListTagValues | Alibaba Cloud のリージョンで、テンプレートまたはスタックのリソースに追加されたタグ値を取得します。 |
| ListTemplates | List Templates | プライベートテンプレートと共有テンプレートのリストをクエリします。 |
| MoveResourceGroup | MoveResourceGroup | リソースを特定のリソースグループに移動します。 |
| SetDeletionProtection | SetDeletionProtection | スタックの削除保護を設定します。 |
| TagResources | TagResources | リソースにタグを作成して追加します。 |
| UntagResources | UntagResources | リソースからタグを削除し、その後それらのタグを削除します。 |
| UpdateTemplate | Update Template | テンプレートの更新 |