API 標準および多言語対応の SDK
本製品 (eas/2021-07-01) の 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 |
タイトル |
説明 |
| CreateService | CreateService | Elastic Algorithm Service (EAS) でモデルサービスを作成します。 |
| CreateServiceAutoScaler | CreateServiceAutoScaler | オートスケーラー機能を有効にし、サービスのオートスケーラーコントローラーを作成します。 |
| CreateServiceCronScaler | CreateServiceCronScaler | サービスに対して、スケジュールベースの自動スケーリングルールを作成します。 |
| CreateServiceMirror | CreateServiceMirror | サービスのトラフィックミラーリング機能を有効にします。この機能を有効にすると、サービスが受信したリクエストを別のサービスにミラーリングできます。 |
| CreateAppService | CreateAppService | 大規模モデルの推論機能を取得するためのアプリケーションサービスを作成します。 |
| CreateServiceInstanceToken | CreateServiceInstanceToken | コンテナにログインするためのトークンと WebSocket URL を取得するには、この操作を呼び出します。 |
| DescribeGroupEndpoints | DescribeGroupEndpoints | サービスグループのエンドポイントのリストを取得します。 |
| DescribeServiceEndpoints | DescribeServiceEndpoints | サービスエンドポイントのリストを取得します。 |
| DescribeServiceSignedUrl | DescribeServiceSignedUrl | サービスのログイン不要の URL を取得します。 |
| DeleteService | DeleteService | サービスを削除します。 |
| CloneService | CloneService | サービスをクローンします。 |
| ScaleService | ScaleService | サービスをスケーリングします。 |
| UpdateServiceVersion | UpdateServiceVersion | サービスのバージョンを更新するか、サービスを特定のバージョンにロールバックします。 |
| DeleteServiceLabel | DeleteServiceLabel | サービスラベルを削除します。 |
| DeleteServiceAutoScaler | DeleteServiceAutoScaler | 既存のオートスケーラーコントローラーを削除し、サービスのオートスケーラー機能を無効にします。 |
| DeleteServiceCronScaler | DeleteServiceCronScaler | サービスの Cronscaler 機能を無効にします。 |
| DeleteServiceInstances | DeleteServiceInstances | サービスの指定されたインスタンスを再起動します。 |
| DeleteServiceMirror | DeleteServiceMirror | サービスのトラフィックミラーリング機能を無効にします。 |
| UpdateServiceLabel | UpdateServiceLabel | サービス タグを追加するか、既存のサービス タグを更新します。 |
| ListServices | ListServices | サービスを一覧表示します。 |
| UpdateService | UpdateService | サービスのモデルまたはプロセッサを更新します。`metadata.instance` フィールドのみを更新する場合、手動スケーリングを実行できます。 |
| StartService | StartService | サービスを開始します。 |
| StopService | StopService | 実行中のサービスを停止します。 |
| RestartService | RestartService | サービスを再起動します。 |
| UpdateServiceAutoScaler | UpdateServiceAutoScaler | サービスのオートスケーラー構成を更新します。 |
| UpdateServiceCronScaler | UpdateServiceCronScaler | サービスの定時自動スケーリング設定を更新します。 |
| DevelopService | DevelopService | コンテナサービスを開発モードに切り替えるか、開発モードを終了します。 |
| CommitService | CommitService | カスタムコンテナーサービスの Worker0 コンテナーをコミットし、そのコンテナーを新しいイメージとしてデプロイします。 |
| UpdateServiceMirror | UpdateServiceMirror | サービスのトラフィックミラーリング構成を更新します。 |
| UpdateServiceSafetyLock | UpdateServiceSafetyLock | サービスの安全ロックを更新して、サービスでの誤操作を最小限に抑えます。 |
| UpdateServiceInstance | UpdateServiceInstance | サービスインスタンスのプロパティを更新します。この操作は、隔離サービスインスタンスにのみ適用されます。 |
| UpdateAppService | UpdateAppService | アプリケーションサービスを更新します。 |
| UpdateGroup | サービスグループを更新します | サービスグループの特定のフィールドを更新します。 |
| ReleaseService | ReleaseService | サービスのトラフィック状態または重みを切り替えます。 |
| DescribeService | DescribeService | サービスの詳細を照会します。 |
| DescribeServiceAutoScaler | DescribeServiceAutoScaler | サービスのオートスケーラー構成に関する情報を照会します。 |
| DescribeServiceCronScaler | DescribeServiceCronScaler | サービスの Cron Horizontal Pod Autoscaler (CronHPA) 構成を照会します。 |
| DescribeServiceDiagnosis | DescribeServiceDiagnosis | サービスの診断詳細を照会します。 |
| DescribeServiceInstanceDiagnosis | DescribeServiceInstanceDiagnosis | Elastic Algorithm Service (EAS) を実行するインスタンスの診断詳細を照会します。 |
| DescribeServiceLog | DescribeServiceLog | サービスのログ情報を照会します。 |
| DescribeServiceEvent | DescribeServiceEvent | 指定されたサービスの最近のデプロイメントイベントをクエリします。 |
| DescribeServiceMirror | DescribeServiceMirror | サービスのトラフィックミラーリング設定の詳細をクエリします。 |
| DescribeGroup | DescribeGroup | サービスグループの情報を照会します。 |
| DescribeSpotDiscountHistory | DescribeSpotDiscountHistory | プリエンプティブルインスタンスの価格履歴を照会します。プリエンプティブルインスタンスの詳細については、「プリエンプティブルインスタンスの作成と使用」をご参照ください。 |
| ListServiceInstances | ListServiceInstances | 指定されたサービスのインスタンスを一覧表示します。 |
| ListServiceVersions | ListServiceVersions | サービスの履歴バージョンに関する情報を照会します。 |
| ListServiceContainers | ListServiceContainers | サービスのコンテナーを照会します。 |
| ListGroups | サービスグループを一覧表示します | 作成済みのサービスグループを一覧表示します。 |
| DescribeMachineSpec | DescribeMachineSpec | 利用可能なマシンスペックのリストを返します。 |
| CreateServiceRollout | CreateServiceRollout | サービスロールアウトを作成します。 |
| DescribeServiceRollout | DescribeServiceRollout | サービスロールアウトの詳細を取得します。 |
| DeleteServiceRollout | DeleteServiceRollout | サービスロールアウトを削除します。 |
| UpdateServiceRollout | UpdateServiceRollout | サービスロールアウトを更新します。 |
| CreateFaultInjection | CreateFaultInjection | フォールトインジェクションタスクを作成します。 |
| DeleteFaultInjection | DeleteFaultInjection | エラー注入タスクを削除します。 |
| ListServiceInstanceFaultInjectionInfo | ListServiceInstanceFaultInjectionInfo | 障害注入情報を取得します。 |
リソースグループ
|
API |
タイトル |
説明 |
| UpdateVirtualResource | UpdateVirtualResource | 仮想リソースグループの情報を更新します。 |
| ListVirtualResource | ListVirtualResource | 現在のユーザーの仮想リソースグループを照会します。 |
| DescribeVirtualResource | DescribeVirtualResource | 仮想リソースグループの詳細を照会します。 |
| DeleteVirtualResource | DeleteVirtualResource | リソースやインスタンスを含まない仮想リソースグループを削除します。 |
| CreateVirtualResource | CreateVirtualResource | 仮想リソースグループを作成します。 |
| CreateResource | CreateResource | 新しいリソースグループを作成します。 |
| CreateResourceInstances | CreateResourceInstances | 専用リソースグループにマシンインスタンスを作成します。 |
| CreateResourceLog | CreateResourceLog | リソースグループに対して Log Service の LogShipper 機能を有効にします。 |
| DeleteResource | DeleteResource | リソースやインスタンスを含まないリソースグループを削除します。 |
| DeleteResourceDLink | DeleteResourceDLink | 専用リソースグループの VPC ダイレクト接続機能を無効にします。 |
| DeleteResourceInstances | DeleteResourceInstances | 専用リソースグループ内のインスタンスを削除します。一般ユーザーは、従量課金インスタンスのみを削除できます。 |
| DeleteResourceLog | DeleteResourceLog | 専用リソースグループの Log Service の LogShipper 機能を無効にします。 |
| DeleteResourceInstanceLabel | リソースグループのマシンインスタンスタグを削除します | リソースグループからインスタンスタグを削除します。 |
| MigrateResourceInstance | MigrateResourceInstance | インスタンスを指定されたリソースグループに移行します。 |
| UpdateResourceInstanceLabel | UpdateResourceInstanceLabel | リソースグループ内のインスタンスのラベルを更新します。 |
| UpdateResource | UpdateResource | 専用リソースグループの情報を更新します。専用リソースグループの名前のみ更新できます。 |
| UpdateResourceDLink | UpdateResourceDLink | 専用リソースグループの VPC ダイレクト接続の構成を更新します。 |
| UpdateResourceInstance | UpdateResourceInstance | 専用リソースグループ内のインスタンスのスケジューリングステータスを更新します。 |
| DescribeResource | DescribeResource | リソースグループの詳細を取得します。 |
| DescribeResourceDLink | DescribeResourceDLink | 専用リソースグループの VPC ダイレクト接続に関する詳細な構成を照会します。 |
| DescribeResourceLog | DescribeResourceLog | 専用リソースグループにおける Log Service の LogShipper 構成の詳細をクエリします。 |
| ListResourceInstances | ListResourceInstances | 指定された専用リソースグループ内のインスタンスを一覧表示します。 |
| ListResourceInstanceWorker | ListResourceInstanceWorker | リソースインスタンスのサービスワーカーを一覧表示します。 |
| ListResources | ListResources | 現在のユーザーのリソースグループをリスト表示します。 |
| ListResourceServices | ListResourceServices | 専用のリソースグループにデプロイされているサービスのリストをクエリします。 |
ストレステストタスク
|
API |
タイトル |
説明 |
| CreateBenchmarkTask | CreateBenchmarkTask | ストレステストタスクを作成します。 |
| DeleteBenchmarkTask | DeleteBenchmarkTask | ストレステストタスクを削除します。 |
| DescribeBenchmarkTask | DescribeBenchmarkTask | ストレステストタスクの構成に関する詳細を照会します。 |
| DescribeBenchmarkTaskReport | DescribeBenchmarkTaskReport | ストレステストタスクのレポートを照会します。 |
| ListBenchmarkTask | ListBenchmarkTask | デプロイされたすべてのストレステストタスクをリストします。 |
| StartBenchmarkTask | StartBenchmarkTask | ストレステストタスクを開始します。 |
| StopBenchmarkTask | StopBenchmarkTask | ストレステストタスクを停止します。 |
| UpdateBenchmarkTask | UpdateBenchmarkTask | ストレステストタスクを更新します。 |
専用ゲートウェイ
|
API |
タイトル |
説明 |
| CreateGateway | CreateGateway | ゲートウェイを作成します。 |
| DeleteGateway | DeleteGateway | 非公開ゲートウェイを削除します。 |
| DeleteGatewayLabel | DeleteGatewayLabel | ゲートウェイのラベルを削除します。 |
| UpdateGatewayLabel | UpdateGatewayLabel | ゲートウェイラベルを追加するか、既存のラベルを更新します。 |
| DetachGatewayDomain | DetachGatewayDomain | プライベートゲートウェイからカスタムドメイン名のバインドを解除します。 |
| AttachGatewayDomain | AttachGatewayDomain | カスタムドメイン名をプライベートゲートウェイにバインドします。 |
| ListGatewayDomains | ListGatewayDomains | プライベートゲートウェイのカスタムドメイン名をリストします。 |
| ListGateway | ListGateway | 非公開ゲートウェイを一覧表示します。 |
| ListAclPolicy | ListAclPolicy | プライベートゲートウェイ用に作成されたアクセス制御リスト (ACL) を照会します。 |
| DeleteAclPolicy | DeleteAclPolicy | 非公開ゲートウェイのアクセス制御リスト (ACL) を削除します。ACL から削除された IP CIDR ブロックは、非公開ゲートウェイにアクセスできなくなります。 |
| CreateAclPolicy | CreateAclPolicy | 非公開ゲートウェイのアクセス制御リスト (ACL) を作成します。ACL に追加された IP CIDR ブロックは、非公開ゲートウェイにアクセスできます。 |
| DescribeGateway | 専用ゲートウェイの詳細を照会します | 専用ゲートウェイの詳細を照会します。 |
| UpdateGateway | UpdateGateway | 非公開ゲートウェイを更新します。 |
| CreateGatewayIntranetLinkedVpc | CreateGatewayIntranetLinkedVpc | プライベートゲートウェイの内部エンドポイントを作成します。 |
| ListGatewayIntranetLinkedVpc | ListGatewayIntranetLinkedVpc | プライベートゲートウェイの内部アクセスエンドポイントを一覧表示します。 |
| ListGatewayIntranetSupportedZone | ListGatewayIntranetSupportedZone | イントラネット内のゲートウェイでサポートされているゾーンを取得します。 |
| DeleteGatewayIntranetLinkedVpc | DeleteGatewayIntranetLinkedVpc | 非公開ゲートウェイの内部エンドポイントを削除します。 |
| ListGatewayIntranetLinkedVpcPeer | ListGatewayIntranetLinkedVpcPeer | ゲートウェイのプライベートネットワークエンドポイントの VPC ピアリング接続をリストします。 |
| CreateGatewayIntranetLinkedVpcPeer | CreateGatewayIntranetLinkedVpcPeer | ゲートウェイの内部エンドポイントに VPC ピアリング接続を作成します。 |
| DeleteGatewayIntranetLinkedVpcPeer | DeleteGatewayIntranetLinkedVpcPeer | ゲートウェイの内部エンドポイントから VPC ピアリング接続を削除します。 |
その他
|
API |
タイトル |
説明 |
| ReinstallTenantAddon | ReinstallTenantAddon | テナントの構成をリセットします。 |
| ListTenantAddons | ListTenantAddons | テナントのプラグインリストを照会します。 |
| CreateConfig | CreateConfig | 指定されたサービスに単一の動的パラメータを作成します。 |
| DeleteConfig | DeleteConfig | 指定されたサービスの動的パラメーターを削除します。 |
| DescribeRegions | DescribeRegions | 利用可能なリージョンを照会します。 |
| ListConfigs | ListConfigs | 指定したサービスの動的パラメータのリストを取得します。 |
| UpdateConfig | UpdateConfig | 特定のクラスターとサービスの動的パラメーターを更新します。 |
Others
|
API |
タイトル |
説明 |
| CreateGroup | サービスグループを作成します | サービスグループを作成します。 |
| DeleteGroup | サービスグループを削除します。 | サービスグループを削除します。 |