ListDeployGroup - Enterprise Distributed Application Service

Queries the instance groups to which an application is deployed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadApplication	Read	Application acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}	none	none

Request syntax

POST /pop/v5/app/deploy_group_list

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application. You can call the ListApplication operation to query the application ID. For more information, see ListApplication .	3616cdca-4f92-4413-**-**********

Response parameters

Parameter	Type	Description	Example
	object	The content that is returned.
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	3FDE-DS9R-*********************
DeployGroupList	object []	The information about the instance group in which the application is deployed.
VServerGroupId	string	The ID of the vServer group of the internal-facing Server Load Balancer (SLB) instance associated with the instance group.	rsp-cige6******
Status	string	The state of the application instance group. Valid values: 0: ready 1: in progress 2: successful 3: failed 6: terminated 10: failed due to a system exception	2
CpuRequest	string	The number of CPU cores requested for each application instance when the application is running. Unit: cores. Value 0 indicates that no limit is set on CPU cores.	1
UpdateTime	long	The time when the application was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1573627695779
MemoryRequest	string	The size of memory requested for each application instance when the application is running. Unit: MB. Value 0 indicates that no limit is set on the memory size.	512
NameSpace	string	The namespace.	ping****est
AppVersionId	string	The ID of the change process for application deployment in the instance group.	changeorder_a_***_
CreateTime	long	The time when the application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1573627695779
DeploymentName	string	The name of the deployment.	test
PreStop	string	The pre-stop script.	{\"exec\":{\"command\":[\"ls\",\"/\"]}}"
PackageUrl	string	The URL of the deployment package.	http://**.oss-cn-shanghai.aliyuncs.com//sc-**-consumer-E.jar
PackageVersion	string	The version of the deployment package.	E
BaseComponentMetaName	string	The name of the basic component.	k8s-sc-consumer-****
CsClusterId	string	The ID of the Container Service for Kubernetes (ACK) cluster.	c66e65950db**cba92f17434df1**
AppId	string	The ID of the application.	3616cdca-4f92-4413-**-**********
LastUpdateTime	long	The time when the application was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1587888503825
Env	string	The ID of the ACK cluster.	497806cb-****-6a7
CpuLimit	string	The maximum number of CPU cores allowed for each application instance when the application is running.	400
GroupType	integer	The type of the instance group. Valid values: 0: default group. 1: Canary release is disabled for traffic management. 2: Canary release is enabled for traffic management.	1
ClusterId	string	The ID of the cluster.	0d247b93-8d62-4e34-**-**********
PostStart	string	The post-start script.	{\"exec\":{\"command\":[\"ls\",\"/\"]}}"
Labels	string	The tag.	test
MemoryLimit	string	The maximum size of memory allowed for each application instance when the application is running. Unit: MB. Value 0 indicates that no limit is set on the memory size.	0
Strategy	string	The throttling policy. This parameter is reserved.	RollingUpdate
Selector	string	The ID of the application deployed in the ACK cluster in Enterprise Distributed Application Service (EDAS).	53dd85cc-25b4-4d0e-**-6bf5465**4
GroupId	string	The ID of the instance group.	577f4c50-16ee-43d8-**-**********
GroupName	string	The name of the instance group.	_DEFAULT_GROUP
ClusterName	string	The name of the cluster.	doc-test
PackageVersionId	string	The version of the deployment package that was used to deploy an application in the instance group.	a7d48fe8-ad8f-**-89bd-74cc1ee6**
Reversion	string	The version of the application. The value progressively increases in the range of 0 to 7.	2
VExtServerGroupId	string	The ID of the vServer group of the Internet-facing SLB instance associated with the instance group.	rsp-cige6******
PackagePublicUrl	string	The external download URL of the deployment package.	http://**.oss-cn-shanghai.aliyuncs.com//sc-**-consumer-E.jar
EphemeralStorageRequest	string	The minimum size of space required by ephemeral storage. Unit: GB. Value 0 indicates that no limit is set on the space size.	4
EphemeralStorageLimit	string	The maximum size of space required by ephemeral storage. Unit: GB. Value 0 indicates that no limit is set on the space size.	8

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "3FDE-DS9R-*********************",
  "DeployGroupList": {
    "DeployGroup": [
      {
        "VServerGroupId": "rsp-cige6******",
        "Status": "2",
        "CpuRequest": "1",
        "UpdateTime": 1573627695779,
        "MemoryRequest": "512",
        "NameSpace": "ping****est",
        "AppVersionId": "changeorder_a**_*******_**",
        "CreateTime": 1573627695779,
        "DeploymentName": "test",
        "PreStop": "{\\\"exec\\\":{\\\"command\\\":[\\\"ls\\\",\\\"/\\\"]}}\"",
        "PackageUrl": "http://****.oss-cn-shanghai.aliyuncs.com/****/sc-****-consumer-E.jar",
        "PackageVersion": "E",
        "BaseComponentMetaName": "k8s-sc-consumer-****",
        "CsClusterId": "c66e65950db****cba92f17434df1****",
        "AppId": "3616cdca-4f92-4413-****-************",
        "LastUpdateTime": 1587888503825,
        "Env": "497806cb-****-6a7",
        "CpuLimit": "400",
        "GroupType": 1,
        "ClusterId": "0d247b93-8d62-4e34-****-************",
        "PostStart": "{\\\"exec\\\":{\\\"command\\\":[\\\"ls\\\",\\\"/\\\"]}}\"",
        "Labels": "test",
        "MemoryLimit": "0",
        "Strategy": "RollingUpdate",
        "Selector": "53dd85cc-25b4-4d0e-****-6bf5465****4",
        "GroupId": "577f4c50-16ee-43d8-****-************",
        "GroupName": "_DEFAULT_GROUP",
        "ClusterName": "doc-test",
        "PackageVersionId": "a7d48fe8-ad8f-****-89bd-74cc1ee6****",
        "Reversion": "2",
        "VExtServerGroupId": "rsp-cige6******",
        "PackagePublicUrl": "http://****.oss-cn-shanghai.aliyuncs.com/****/sc-****-consumer-E.jar",
        "EphemeralStorageRequest": "4",
        "EphemeralStorageLimit": "8"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.