All Products
Search
Document Center

CloudOps Orchestration Service:GetApplicationGroup

Last Updated:Oct 14, 2024

Queries the information about an application group. You can call this operation only for the application groups that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
oos:GetApplicationGroupget
  • ApplicationGroup
    acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region. Set the value to cn-hangzhou.

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 details of 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 tag key.

k1
ApplicationNamestring

The name of the application.

MyApplication
ImportTagValuestring

The tag value.

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

The state of the application group.

Created
StatusReasonstring

The state information of the application group.

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

Examples

Sample success responses

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 Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-08The response structure of the API has changedView Change Details
2022-09-19The response structure of the API has changedView Change Details