GetApplicationGroup-阿里云帮助中心

Retrieves the details of an application group. The application management service is available only in the China (Hangzhou) region. Use the Hangzhou endpoint.

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 region ID. Currently, only cn-hangzhou is supported.	cn-hangzhou
Name	string	Yes	The name of the application group.	MyApplicationGroup
ApplicationName	string	Yes	The application name.	MyApplication
ShowMonitorURL	boolean	No	Specifies whether to return the application monitoring URL.	true

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.