API 標準および多言語対応の SDK
本製品 (sae/2019-05-06) の API は、ROA 標準に準拠した 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 |
タイトル |
説明 |
| OpenSaeService | OpenSaeService | Serverless App Engine (SAE) を無料で有効化します。 |
一般的なサービス管理
|
API |
タイトル |
説明 |
| 名前空間と VPC | 名前空間と VPC | |
| CreateIngress | CreateIngress | ルーティングルールを作成します。 |
| DeleteIngress | DeleteIngress | Ingress インスタンスを削除します。 |
| UpdateNamespaceVpc | UpdateNamespaceVpc | 名前空間にアタッチされている VPC を更新します。 |
| UpdateApplicationVswitches | UpdateApplicationVswitches | アプリケーションの vSwitch 構成を更新します。 |
| UpdateIngress | UpdateIngress | Ingress インスタンスの構成を更新します。 |
| DescribeNamespaces | DescribeNamespaces | 名前空間のリストをクエリします。 |
| DescribeNamespaceList | DescribeNamespaceList | 名前空間のリストを照会します。 |
| ListAppEvents | ListAppEvents | アプリケーションイベントを一覧表示するには、`ListAppEvents` API を呼び出します。 |
| ListNamespaceChangeOrders | ListNamespaceChangeOrders | 名前空間内のデプロイメントオーダーを一覧表示します。 |
| DescribeNamespaceResources | DescribeNamespaceResources | 名前空間内のリソースをクエリします。 |
| DescribeIngress | DescribeIngress | Ingress の詳細を照会します。 |
| ListIngresses | ListIngresses | Ingress のリストを取得します。 |
| DescribePipeline | DescribePipeline | バッチ情報を表示します。 |
| 概要ページのトップ N モニタリング | 概要ページのトップ N モニタリング | |
| GetArmsTopNMetric | GetArmsTopNMetric | アプリケーションモニタリングでトップ N のアプリケーションをクエリします。 |
| GetChangeOrderMetric | GetChangeOrderMetric | 異常な変更オーダーがある上位 N 個のアプリケーションを取得するには、`GetChangeOrderMetric` API を呼び出します。 |
| GetScaleAppMetric | GetScaleAppMetric | オートスケーリングが有効になっている上位 N 個のアプリケーションを照会します。 |
| GetWarningEventMetric | GetWarningEventMetric | 警告イベントが発生した上位 N 個のアプリケーションをクエリします。 |
マイクロサービスアプリケーション
|
API |
タイトル |
説明 |
| アプリケーションライフサイクル | アプリケーションライフサイクル | |
| StopApplication | StopApplication | アプリケーションを停止します。 |
| StartApplication | StartApplication | アプリケーションを起動します。 |
| ReduceApplicationCapacityByInstanceIds | ReduceApplicationCapacityByInstanceIds | インスタンス ID に基づいてアプリケーションをスケールインします。 |
| UpdateApplicationDescription | UpdateApplicationDescription | アプリケーションの説明を更新します。 |
| UpdateAppSecurityGroup | UpdateAppSecurityGroup | アプリケーションセキュリティグループを更新します。 |
| DescribeApplicationStatus | DescribeApplicationStatus | DescribeApplicationStatus API を呼び出して、アプリケーションのステータスを取得します。 |
| ListChangeOrders | ListChangeOrders | 変更オーダーをリストアップします。 |
| DescribeChangeOrder | DescribeChangeOrder | DescribeChangeOrder を呼び出して、変更オーダーに関する情報を取得します。 |
| DescribeInstanceSpecifications | DescribeInstanceSpecifications | 利用可能なアプリケーションインスタンスの仕様のリストを取得します。 |
| DeployApplication | DeployApplication | アプリケーションをデプロイします。 |
| RescaleApplicationVertically | RescaleApplicationVertically | アプリケーションのインスタンスタイプを変更します。 |
| ConfirmPipelineBatch | ConfirmPipelineBatch | 次のバッチを開始するかどうかを確認します。 |
| AbortAndRollbackChangeOrder | AbortAndRollbackChangeOrder | 変更オーダーを終了し、対応するアプリケーションをロールバックします。 |
| RestartApplication | RestartApplication | アプリケーションを再起動します。 |
| AbortChangeOrder | AbortChangeOrder | この操作は、変更オーダーを停止します。 |
| BatchStopApplications | BatchStopApplications | アプリケーションをバッチで停止します。 |
| BatchStartApplications | BatchStartApplications | 複数のアプリケーションを一度に開始します。 |
| DowngradeApplicationApmService | DowngradeApplicationApmService | ARMS アドバンストエディションのモニタリングを無効にします。 |
| UpgradeApplicationApmService | UpgradeApplicationApmService | Application Real-Time Monitoring Service (ARMS) の高度なモニタリング機能を有効にします。 |
| マイクロサービスリスト | マイクロサービスリスト | |
| ListConsumedServices | ListConsumedServices | \`ListConsumedServices` 操作を呼び出して、サブスクライブしたマイクロサービスのリストを取得できます。 |
| ListPublishedServices | ListPublishedServices | 公開済みのマイクロサービスのリストを照会します。 |
| ListAppServices | ListAppServices | マイクロサービスを一覧表示します。 |
| 設定項目の管理 | 設定項目の管理 | |
| CreateConfigMap | CreateConfigMap | 名前空間に ConfigMap を作成します。 |
| DeleteConfigMap | DeleteConfigMap | ConfigMap インスタンスを削除します。 |
| UpdateConfigMap | UpdateConfigMap | ConfigMap インスタンスを更新します。 |
| DescribeConfigMap | DescribeConfigMap | ConfigMap インスタンスの詳細を照会します。 |
| ListNamespacedConfigMaps | ListNamespacedConfigMaps | 指定された名前空間内の ConfigMap インスタンスを一覧表示します。 |
| カナリアリリースのタグベースルーティング | カナリアリリースのタグベースルーティング | |
| CreateGreyTagRoute | CreateGreyTagRoute | Spring Cloud または Dubbo アプリケーションのカナリアリリースルールを作成します。 |
| DeleteGreyTagRoute | DeleteGreyTagRoute | 指定されたルール ID に基づいてグレイタグのルートを削除します。 |
| UpdateGreyTagRoute | UpdateGreyTagRoute | グレイタグ付けルートを更新します。 |
| DescribeGreyTagRoute | DescribeGreyTagRoute | ルール ID に基づいてカナリアリリースルールを取得します。 |
| ListGreyTagRoute | ListGreyTagRoute | アプリケーション ID に基づいてグレースケールルールの詳細を照会します。 |
| エンドツーエンドのカナリアリリース | エンドツーエンドのカナリアリリース | |
| CreateOrUpdateSwimmingLaneGroup | CreateOrUpdateSwimmingLaneGroup | スイミングレーングループを作成または更新します。 |
| CreateOrUpdateSwimmingLane | CreateOrUpdateSwimmingLane | スイムレーンを作成または更新します。 |
| ListApplicationsForSwimmingLane | ListApplicationsForSwimmingLane | フルリンクカナリアリリースのアプリケーションリストを取得します。 |
| ListSwimmingLaneGatewayRoutes | ListSwimmingLaneGatewayRoutes | スイミングレーンに関連付けることができるゲートウェイルートを一覧表示します。 |
| ListSwimmingLaneGroupTags | ListSwimmingLaneGroupTags | すべてのスイミングレーンタグをリスト表示します。 |
| DescribeSwimmingLane | DescribeSwimmingLane | スイムレーンの詳細を取得します。 |
| ListAllSwimmingLanes | ListAllSwimmingLanes | すべてのスイムレーンを一覧表示します。 |
| ListAllSwimmingLaneGroups | ListAllSwimmingLaneGroups | すべてのスイムレーン・グループのリストを返します。 |
| DeleteSwimmingLaneGroup | DeleteSwimmingLaneGroup | スイミングレーングループを削除します。 |
| UpdateSwimmingLaneEnableAttribute | UpdateSwimmingLaneEnableAttribute | スイミングレーンの有効ステータスを更新します。 |
| アプリケーション情報の照会 | アプリケーション情報の照会 | |
| DescribeApplicationConfig | DescribeApplicationConfig | アプリケーションの構成を取得します。 |
| DescribeInstanceLog | DescribeInstanceLog | インスタンスのログを取得します。 |
| DescribeComponents | DescribeComponents | DescribeComponents API を呼び出して、アプリケーションのデプロイメントの作成に必要なコンポーネントバージョンを取得します。 |
| DescribeEdasContainers | DescribeEdasContainers | アプリケーションのマイクロサービスコンテナコンポーネントを取得します。 |
| DescribeApplicationImage | DescribeApplicationImage | アプリケーションイメージの情報を取得します。 |
| DescribeApplicationInstances | DescribeApplicationInstances | アプリケーションインスタンスのリストを取得します。 |
| DescribeApplicationGroups | DescribeApplicationGroups | `DescribeApplicationGroups` を使用して、アプリケーショングループを取得します。 |
| QueryResourceStatics | QueryResourceStatics | アプリケーションのリソース使用量を取得します。 |
| ListLogConfigs | ListLogConfigs | アプリケーションログのリストを返します。 |
| RestartInstances | RestartInstances | アプリケーション内の 1 つ以上のインスタンスを再起動します。 |
| GetAvailabilityMetric | GetAvailabilityMetric | 異常なインスタンスが存在する上位 N 件のアプリケーションを照会します。アプリケーションは、異常インスタンスの合計数で降順にソートされます。 |
| DescribeAppServiceDetail | DescribeAppServiceDetail | アプリケーションサービスのメタデータの詳細を説明します。 |
| ListAppServicesPage | ListAppServicesPage | `ListAppServicesPage` を呼び出して、アプリケーションサービスのリストを取得します。 |
| SLB 管理 | SLB 管理 | |
| DescribeApplicationNlbs | DescribeApplicationNlbs | アプリケーションの NLB 構成を照会します。 |
| BindNlb | BindNlb | Network Load Balancer (NLB) インスタンスをアプリケーションにバインドします。 |
| DescribeApplicationSlbs | DescribeApplicationSlbs | アプリケーションの Server Load Balancer (SLB) インスタンスの構成を照会します。 |
| BindSlb | BindSlb | Server Load Balancer (SLB) インスタンスをアプリケーションにバインドします。 |
| UnbindSlb | UnbindSlb | パブリックまたはプライベート SLB インスタンスをアプリケーションからバインド解除します。 |
| UnbindNlb | UnbindNlb | アプリケーションから NLB リスナーをアンバインドします。 |
| アプリケーションのスケーリングルール | アプリケーションのスケーリングルール | |
| CreateApplicationScalingRule | CreateApplicationScalingRule | アプリケーションの自動スケーリングポリシーを作成します。 |
| DeleteApplicationScalingRule | DeleteApplicationScalingRule | アプリケーションの Auto Scaling ポリシーを削除します。 |
| DisableApplicationScalingRule | DisableApplicationScalingRule | アプリケーションの Auto Scaling ポリシーを無効にします。 |
| EnableApplicationScalingRule | EnableApplicationScalingRule | アプリケーションのオートスケーリングポリシーを有効化します。 |
| UpdateApplicationScalingRule | UpdateApplicationScalingRule | アプリケーションの auto scaling ポリシーの更新 |
| DescribeApplicationScalingRule | DescribeApplicationScalingRule | アプリケーションの単一のオートスケーリングポリシーについて説明します。 |
| DescribeApplicationScalingRules | DescribeApplicationScalingRules | アプリケーションの Auto Scaling ポリシーについて説明します。 |
ジョブタスク
|
API |
タイトル |
説明 |
| DeleteHistoryJob | DeleteHistoryJob | ジョブを削除します。 |
| DescribeJobStatus | DescribeJobStatus | ジョブのステータスを照会します。 |
| DescribeJob | DescribeJob | `DescribeJob` API を呼び出して、ジョブテンプレートの設定を取得します。 |
| ExecJob | ExecJob | ExecJob を呼び出してジョブを実行します。 |
| SuspendJob | SuspendJob | 1 つ以上のジョブを一時停止します。 |
| DescribeJobHistory | DescribeJobHistory | ジョブに関する情報をクエリします。 |
その他
|
API |
タイトル |
説明 |
| DescribeConfigurationPrice | DescribeConfigurationPrice | 構成の価格を照会します。 |
| GetWebshellToken | GetWebshellToken | インスタンスの Webshell にリモートログインするためのトークンを取得します。 |
| UpdateAppMode | UpdateAppMode | アプリケーションのアイドルモードを更新します。 |
| QueryArmsEnable | QueryArmsEnable | 指定されたアプリケーションで ARMS モニタリングが有効になっているかどうかを照会します。 |
| DescribeApplicationMseService | DescribeApplicationMseService | 関連付けられた MSE マイクロサービスガバナンスアプリケーションの情報をクエリします。 |
| BatchRestartApplications | BatchRestartApplications | アプリケーションをバッチで再起動します。 |
| UpdateNamespaceSlsConfigs | UpdateNamespaceSlsConfigs | 名前空間レベルの SLS 構成を更新します。 |
| DisableArms | DisableArms | ARMS モニタリングを無効にします。 |
| ResumeTraffic | ResumeTraffic | クラシックロードバランサー (CLB)、Network Load Balancer (NLB)、CLB ゲートウェイルーティング、Application Load Balancer (ALB) ゲートウェイルーティング、および Kubernetes サービスからのインスタンスへのトラフィックを再開します。 |
| SuspendTraffic | SuspendTraffic | クラシックロードバランサー (CLB) のアプリケーションアクセス、Network Load Balancer (NLB) のアプリケーションアクセス、CLB ゲートウェイルート、Application Load Balancer (ALB) ゲートウェイルート、または Kubernetes (K8s) サービスから指定されたインスタンスへのトラフィックのルーティングを停止します。 |
Others
|
API |
タイトル |
説明 |
| CreateApplication | CreateApplication | アプリケーションを作成します。 |
| CreateJob | CreateJob | この操作はジョブテンプレートを作成します。 |
| CreateNamespace | CreateNamespace | 名前空間を作成します。 |
| CreateSecret | CreateSecret | 名前空間にシークレットを作成します。 |
| DeleteApplication | DeleteApplication | アプリケーションを削除します。 |
| DeleteInstances | DeleteInstances | 1 つ以上のアプリケーションインスタンスを削除します。 |
| DeleteJob | DeleteJob | ジョブテンプレートを削除します。 |
| DeleteNamespace | DeleteNamespace | 名前空間を削除します。 |
| DeleteSecret | DeleteSecret | シークレットを削除します。 |
| DescribeNamespace | DescribeNamespace | 名前空間の詳細を照会します。 |
| DescribeRegions | DescribeRegions | 利用可能なリージョンを照会します。 |
| DescribeSecret | DescribeSecret | Secret の詳細を照会します。 |
| GetApplication | GetApplication | アプリケーションの基本情報を取得します。 |
| ListAppVersions | ListAppVersions | アプリケーションの履歴バージョンを一覧表示します。 |
| ListApplications | ListApplications | アプリケーションのリストを取得します。 |
| ListJobs | ListJobs | ジョブテンプレートのリストを取得します。 |
| ListSecrets | ListSecrets | ListSecrets を呼び出して、名前空間内のシークレットをリスト表示します。 |
| ListTagResources | ListTagResources | `ListTagResources` API を呼び出して、アプリケーションに関連付けられているタグを一覧表示します。 |
| RescaleApplication | RescaleApplication | アプリケーションを再スケーリングします。 |
| RollbackApplication | RollbackApplication | アプリケーションをロールバックします。 |
| TagResources | TagResources | 指定されたリソースに 1 つ以上のタグを追加します。 |
| UntagResources | UntagResources | 指定されたリソースから 1 つ以上のタグを削除します。 |
| UpdateJob | UpdateJob | UpdateJob API を呼び出してジョブテンプレートを更新します。 |
| UpdateNamespace | UpdateNamespace | 名前空間の情報を更新します。 |
| UpdateSecret | UpdateSecret | Secret インスタンスを更新します。 |