ListApplicationGroups API リファレンス - CloudOps Orchestration Service

アプリケーショングループのリストを照会します。アプリケーション管理機能は、中国 (杭州) リージョンでのみ利用可能です。このリージョンのエンドポイントを使用していることを確認してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:ListApplicationGroups

list

*ApplicationGroup

acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/*

oos:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。cn-hangzhou のみがサポートされています。	cn-hangzhou
ApplicationName	string	任意	アプリケーション名。	MyApplication
DeployRegionId	string	任意	デプロイメントリージョンの ID。これは、リソースが配置されているリージョンです。	cn-hangzhou
MaxResults	integer	任意	ページサイズ。	10
NextToken	string	任意	ページネーショントークン。	-
ResourceType	string	任意	クラウドリソースのタイプ。	instance
ResourceId	string	任意	クラウドリソースの ID。	i-2vcj9raxrhxb48zz3whw
ResourceProduct	string	任意	クラウドリソースが属するプロダクトのコード。	ecs

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	ページネーショントークン。	-
RequestId	string	リクエスト ID。	69D97BF2-5DF2-544C-A650-36A474E17BC3
MaxResults	integer	ページサイズ。	10
ApplicationGroups	array<object>	アプリケーショングループに関する情報。
	object
CmsGroupId	string	CloudMonitor アプリケーショングループの ID。	12345678
DeployRegionId	string	デプロイメントリージョンの ID。これは、リソースが配置されているリージョンです。	cn-hangzhou
UpdateDate	string	更新時間。	2021-09-08T03:01:53Z
Description	string	アプリケーショングループの説明。	ApplicationGroup
ImportTagKey	string	タグキー。	k1
ApplicationName	string	アプリケーション名。	MyApplication
ImportTagValue	string	タグの値。	v1
Name	string	アプリケーショングループの名前。	UpdateMyApplicationGroup
CreateDate	string	作成時間。	2021-09-07T10:28:25Z
Status	string	アプリケーショングループのステータス。	Created
DeployParameters	string	アプリケーショングループの構成情報。	{ "TemplateURL": "https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json", "Parameters": { "ZoneId": "cn-hangzhou-k", "ProjectName": "test", "SystemDiskSize": 40, "InstanceChargeType": "PostPaid", "SecurityGroupId": "sg-bp1a4374akk63jl8tddy", "VSwitchId": "vsw-bp1fcvc3zn0jrag86rrlm", "SystemDiskCategory": "cloud_essd", "InstancePassword": "******", "InternetChargeType": "PayByTraffic", "InstanceCount": 1, "InternetMaxBandwidthOut": 0, "VpcId": "vpc-bp1i99boyas8i8m9t3skp", "EcsImageId": "centos_8_5_x64_20G_alibase_20211228.vhd", "DataDiskSize": 100, "EcsInstanceType": "ecs.s6-c1m4.small", "DataDiskCategory": "cloud_efficiency", "EnvironmentCommandId": "c-hz028fc3g031gcg" }, "RegionId": "cn-hangzhou", "StackName": "stack-1645688523068-3no_AKhOJ", "DisableRollback": true }
StatusReason	string	アプリケーショングループのステータスの詳細。	ApplicationGroup is Created.
ErrorType	string	失敗したビルド中に発生したエラーのタイプ。	Build
ErrorDetail	string	失敗したビルド中に発生したエラーの詳細。	ERROR: failed to build: executing lifecycle: failed with status code: 51
DeployedRevisionIds	string	デプロイされたリビジョン ID のリスト。最新の 10 個の ID のみが表示されます。	["rev-f575b688015442d28d26","rev-b9876a39cf84490db638","rev-782fc7a0c0974d89b1eb"]
ExecutionId	string	実行 ID。	exec-661daf82ad024953a40a

例

成功レスポンス

JSONJSON

{
  "NextToken": "-",
  "RequestId": "69D97BF2-5DF2-544C-A650-36A474E17BC3",
  "MaxResults": 10,
  "ApplicationGroups": [
    {
      "CmsGroupId": "12345678",
      "DeployRegionId": "cn-hangzhou",
      "UpdateDate": "2021-09-08T03:01:53Z",
      "Description": "ApplicationGroup",
      "ImportTagKey": "k1",
      "ApplicationName": "MyApplication",
      "ImportTagValue": "v1",
      "Name": "UpdateMyApplicationGroup",
      "CreateDate": "2021-09-07T10:28:25Z",
      "Status": "Created",
      "DeployParameters": "{   \"TemplateURL\": \"https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json\",   \"Parameters\": {     \"ZoneId\": \"cn-hangzhou-k\",     \"ProjectName\": \"test\",     \"SystemDiskSize\": 40,     \"InstanceChargeType\": \"PostPaid\",     \"SecurityGroupId\": \"sg-bp1a4374akk63jl8tddy\",     \"VSwitchId\": \"vsw-bp1fcvc3zn0jrag86rrlm\",     \"SystemDiskCategory\": \"cloud_essd\",     \"InstancePassword\": \"******\",     \"InternetChargeType\": \"PayByTraffic\",     \"InstanceCount\": 1,     \"InternetMaxBandwidthOut\": 0,     \"VpcId\": \"vpc-bp1i99boyas8i8m9t3skp\",     \"EcsImageId\": \"centos_8_5_x64_20G_alibase_20211228.vhd\",     \"DataDiskSize\": 100,     \"EcsInstanceType\": \"ecs.s6-c1m4.small\",     \"DataDiskCategory\": \"cloud_efficiency\",     \"EnvironmentCommandId\": \"c-hz028fc3g031gcg\"   },   \"RegionId\": \"cn-hangzhou\",   \"StackName\": \"stack-1645688523068-3no_AKhOJ\",   \"DisableRollback\": true }",
      "StatusReason": "ApplicationGroup is Created.",
      "ErrorType": "Build\n",
      "ErrorDetail": "ERROR: failed to build: executing lifecycle: failed with status code: 51",
      "DeployedRevisionIds": "[\"rev-f575b688015442d28d26\",\"rev-b9876a39cf84490db638\",\"rev-782fc7a0c0974d89b1eb\"]\n",
      "ExecutionId": "exec-661daf82ad024953a40a"
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。