ListDeployGroup - Enterprise Distributed Application Service

Call the ListDeployGroup operation to obtain a list of deployment groups.

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

edas:ReadApplication

get

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

None

Request syntax

POST /pop/v5/app/deploy_group_list HTTP/1.1

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The response.
Code	integer	The status code of the request or a POP error code.	200
Message	string	The returned message.	success
RequestId	string	The ID of the request.	3FDE-DS9R-*********************
DeployGroupList	object
DeployGroup	array<object>	The list of deployment groups.
	object	A deployment group.
VServerGroupId	string	The ID of the vServer group for the internal-facing SLB instance that is associated with the deployment group.	rsp-cige6******
Status	string	The status of the group. 0: ready 1: in progress 2: successful 3: failed 6: stopped 10: failed due to a system exception	2
CpuRequest	string	The number of CPU cores requested for the application instance. A value of 0 indicates that no limit is set.	1
UpdateTime	integer	The UNIX timestamp when the deployment group was updated.	1573627695779
MemoryRequest	string	The amount of memory requested for the application instance. Unit: MB. A value of 0 indicates that no limit is set.	512
NameSpace	string	The namespace.	ping****est
AppVersionId	string	The ID of the deployment record for the group.	changeorder_a_***_
CreateTime	integer	The UNIX timestamp when the deployment group was created.	1573627695779
DeploymentName	string	The name of the deployment.	test
PreStop	string	The script that is run before the instance is stopped.	{\"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 base component.	k8s-sc-consumer-****
CsClusterId	string	The ID of the container cluster.	c66e65950db**cba92f17434df1**
AppId	string	The ID of the application.	3616cdca-4f92-4413-**-**********
LastUpdateTime	integer	The UNIX timestamp of the last update.	1587888503825
Env	string	The ID of the container service cluster.	497806cb-****-6a7
CpuLimit	string	The maximum number of CPU cores allowed for the application instance.	400
GroupType	integer	The type of the group. 0: default group. 1: Grayscale release is disabled for traffic management. 2: Grayscale release is enabled for traffic management.	1
ClusterId	string	The ID of the cluster.	0d247b93-8d62-4e34-**-**********
PostStart	string	The script that is run after the instance is started.	{\"exec\":{\"command\":[\"ls\",\"/\"]}}"
Labels	string	The labels.	test
MemoryLimit	string	The maximum amount of memory allowed for the application instance. Unit: MB. A value of 0 indicates that no limit is set.	0
Strategy	string	The throttling policy. This is a reserved field.	RollingUpdate
Selector	string	The ID of the application that is deployed in an Enterprise Distributed Application Service (EDAS) Kubernetes cluster.	53dd85cc-25b4-4d0e-**-6bf5465**4
GroupId	string	The ID of the group.	577f4c50-16ee-43d8-**-**********
GroupName	string	The name of the group.	_DEFAULT_GROUP
ClusterName	string	The name of the cluster.	doc-test
PackageVersionId	string	The ID of the version that was deployed in the group.	a7d48fe8-ad8f-**-89bd-74cc1ee6**
Reversion	string	The application version. The value is an integer that is incremented from 0 to 7.	2
VExtServerGroupId	string	The ID of the vServer group for the Internet-facing SLB instance that is associated with the deployment group.	rsp-cige6******
PackagePublicUrl	string	The public URL of the deployment package.	http://**.oss-cn-shanghai.aliyuncs.com//sc-**-consumer-E.jar
EphemeralStorageRequest	string	The minimum temporary storage required. Unit: GB. A value of 0 indicates that no limit is set.	4
EphemeralStorageLimit	string	The maximum temporary storage allowed. Unit: GB. A value of 0 indicates that no limit is set.	8

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.