GetApplicationGroup - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Retrieves the details of an application group. Application Management is available only in the China (Hangzhou) region. You must 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:GetApplicationGroup

get

*ApplicationGroup

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

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region. Only cn-hangzhou is supported.	cn-hangzhou
Name	string	Yes	The name of the application group.	MyApplicationGroup
ApplicationName	string	Yes	The name of the application.	MyApplication

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	92EA60ED-544D-55E9-93D9-237BE9976C0D
ApplicationGroup	object	The details of the application group.
CmsGroupId	string	The ID of the Cloud Monitor application group.	12345678
DeployRegionId	string	The ID of the deployment region.	cn-hangzhou
Description	string	The description of the application group.	ApplicationGroup
UpdateDate	string	The time when the application group was last updated.	2021-09-07T10:28:25Z
ImportTagKey	string	The tag key.	k1
ApplicationName	string	The name of the application.	MyApplication
ImportTagValue	string	The tag value.	v1
Name	string	The name of the application group.	MyApplicationGroup
CreateDate	string	The time when the application group was created.	2021-09-07T10:28:25Z
DeployParameters	string	The deployment configurations 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" }
Status	string	The status of the application group.	Created
StatusReason	string	The reason for the status of the application group.	Stack CREATE completed successfully
DeployOutputs	string	The outputs of the deployment.	{ "Outputs": [ { "Description": "No description given", "OutputKey": "InstanceIds" } ], "StackId": "6ef4b860-f6e7-4145-8d22-f4a2a32363e1" } }
Progress	string	The creation progress of the application instance.	100
OperationMetadata	string	The O&M configuration.	{\"PrometheusConfigMap\":{\"模板1\":{\"EnablePrometheus\":false}}}
ApplicationSource	string	The source of the application.	{"Platform":"github","RepoName":"wenle/springboot-ecs-sourcecode-demo","Owner":"wenle","Branch":"main","CommitHash":"8559ff3ac7568fc7951ff63f841883ee3f06c6fe","CommitMessage":"Init computenest project"}
ErrorType	string	The type of the error that occurred when the build failed.	Build
ErrorDetail	string	The details of the error that occurred when the build failed.	ERROR: failed to build: executing lifecycle: failed with status code: 51
DeployedRevisionIds	string	A list of deployment revision IDs. Only the 10 most recent IDs are displayed.	["rev-f575b688015442d28d26","rev-b9876a39cf84490db638","rev-782fc7a0c0974d89b1eb"]
ExecutionId	string	The execution ID.	exec-f5dee943869c436a9f57

Examples

Success response

JSON format

{
  "RequestId": "92EA60ED-544D-55E9-93D9-237BE9976C0D",
  "ApplicationGroup": {
    "CmsGroupId": "12345678",
    "DeployRegionId": "cn-hangzhou",
    "Description": "ApplicationGroup",
    "UpdateDate": "2021-09-07T10:28:25Z",
    "ImportTagKey": "k1",
    "ApplicationName": "MyApplication",
    "ImportTagValue": "v1",
    "Name": "MyApplicationGroup",
    "CreateDate": "2021-09-07T10:28:25Z",
    "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\"       }",
    "Status": "Created",
    "StatusReason": "Stack CREATE completed successfully",
    "DeployOutputs": "{       \"Outputs\": [         {           \"Description\": \"No description given\",           \"OutputKey\": \"InstanceIds\"         }       ],       \"StackId\": \"6ef4b860-f6e7-4145-8d22-f4a2a32363e1\"     }   }",
    "Progress": "100",
    "OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"模板1\\\":{\\\"EnablePrometheus\\\":false}}}",
    "ApplicationSource": "{\"Platform\":\"github\",\"RepoName\":\"wenle/springboot-ecs-sourcecode-demo\",\"Owner\":\"wenle\",\"Branch\":\"main\",\"CommitHash\":\"8559ff3ac7568fc7951ff63f841883ee3f06c6fe\",\"CommitMessage\":\"Init computenest project\"}",
    "ErrorType": "Build",
    "ErrorDetail": "ERROR: failed to build: executing lifecycle: failed with status code: 51",
    "DeployedRevisionIds": "[\"rev-f575b688015442d28d26\",\"rev-b9876a39cf84490db638\",\"rev-782fc7a0c0974d89b1eb\"]",
    "ExecutionId": "exec-f5dee943869c436a9f57"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.