All Products
Search
Document Center

Operation Orchestration Service:GetApplicationGroup

Last Updated:Feb 07, 2023

Queries the details of an application group.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
oos:GetApplicationGroupRead
  • OOS
    acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
NamestringYes

The name of the application group.

MyApplicationGroup
ApplicationNamestringYes

The name of the application.

MyApplication

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

92EA60ED-544D-55E9-93D9-237BE9976C0D
ApplicationGroupobject

The information about the application group.

CmsGroupIdstring

The ID of the application group in CloudMonitor.

12345678
DeployRegionIdstring

The ID of the region in which you deploy the application group.

cn-hangzhou
Descriptionstring

The description of the application group.

ApplicationGroup
UpdateDatestring

The time when the application group was last modified.

2021-09-07T10:28:25Z
ImportTagKeystring

The key of the tag.

k1
ApplicationNamestring

The name of the application.

MyApplication
ImportTagValuestring

The value of the tag.

v1
Namestring

The name of the application group.

MyApplicationGroup
CreateDatestring

The time when the application group was created.

2021-09-07T10:28:25Z
DeployParametersstring

The deployment 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" }
Statusstring

The status of the application group.

Created
StatusReasonstring

The details of the group status.

Stack CREATE completed successfully
DeployOutputsstring

The output of the deployment result.

{ "Outputs": [ { "Description": "No description given", "OutputKey": "InstanceIds" } ], "StackId": "6ef4b860-f6e7-4145-8d22-f4a2a32363e1" } }
Progressstring

The creation progress of the application instance.

100

Example

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2022-09-19The response structure of the API operation has changed
Change itemChange content
Output ParametersThe response structure of the API operation has changed