ListApplicationGroups - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Queries a list of application groups. The Application Management feature is available only in the China (Hangzhou) region. Ensure that you use the endpoint for this region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:ListApplicationGroups

list

*ApplicationGroup

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

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Only cn-hangzhou is supported.	cn-hangzhou
ApplicationName	string	No	The application name.	MyApplication
DeployRegionId	string	No	The ID of the deployment region. This is the region where the resource is located.	cn-hangzhou
MaxResults	integer	No	The page size.	10
NextToken	string	No	The pagination token.	-
ResourceType	string	No	The type of the cloud resource.	instance
ResourceId	string	No	The ID of the cloud resource.	i-2vcj9raxrhxb48zz3whw
ResourceProduct	string	No	The code of the product to which the cloud resource belongs.	ecs

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token.	-
RequestId	string	The request ID.	69D97BF2-5DF2-544C-A650-36A474E17BC3
MaxResults	integer	The page size.	10
ApplicationGroups	array<object>	The information about the application groups.
	object
CmsGroupId	string	The ID of the CloudMonitor application group.	12345678
DeployRegionId	string	The ID of the deployment region. This is the region where the resource is located.	cn-hangzhou
UpdateDate	string	The update time.	2021-09-08T03:01:53Z
Description	string	The description of the application group.	ApplicationGroup
ImportTagKey	string	The tag key.	k1
ApplicationName	string	The application name.	MyApplication
ImportTagValue	string	The tag value.	v1
Name	string	The name of the application group.	UpdateMyApplicationGroup
CreateDate	string	The creation time.	2021-09-07T10:28:25Z
Status	string	The status of the application group.	Created
DeployParameters	string	The configuration information of the application group.	{ "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	The details of the application group status.	ApplicationGroup is Created.
ErrorType	string	The type of fault that occurred during a failed build.	Build
ErrorDetail	string	The details of the fault that occurred during a failed build.	ERROR: failed to build: executing lifecycle: failed with status code: 51
DeployedRevisionIds	string	A list of deployed revision IDs. Only the 10 most recent IDs are displayed.	["rev-f575b688015442d28d26","rev-b9876a39cf84490db638","rev-782fc7a0c0974d89b1eb"]
ExecutionId	string	The execution ID.	exec-661daf82ad024953a40a

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.