All Products
Search
Document Center

Enterprise Distributed Application Service:ListDeployGroup

Last Updated:Mar 01, 2024

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.

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
edas:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/v5/app/deploy_group_list

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

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

ParameterTypeDescriptionExample
object

The content that is returned.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

3FDE-DS9R-*********************
DeployGroupListobject []

The information about the instance group in which the application is deployed.

VServerGroupIdstring

The ID of the vServer group of the internal-facing Server Load Balancer (SLB) instance associated with the instance group.

rsp-cige6******
Statusstring

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
CpuRequeststring

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
UpdateTimelong

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
MemoryRequeststring

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
NameSpacestring

The namespace.

ping****est
AppVersionIdstring

The ID of the change process for application deployment in the instance group.

changeorder_a**_*******_**
CreateTimelong

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
DeploymentNamestring

The name of the deployment.

test
PreStopstring

The pre-stop script.

{\"exec\":{\"command\":[\"ls\",\"/\"]}}"
PackageUrlstring

The URL of the deployment package.

http://****.oss-cn-shanghai.aliyuncs.com/****/sc-****-consumer-E.jar
PackageVersionstring

The version of the deployment package.

E
BaseComponentMetaNamestring

The name of the basic component.

k8s-sc-consumer-****
CsClusterIdstring

The ID of the Container Service for Kubernetes (ACK) cluster.

c66e65950db****cba92f17434df1****
AppIdstring

The ID of the application.

3616cdca-4f92-4413-****-************
LastUpdateTimelong

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
Envstring

The ID of the ACK cluster.

497806cb-****-6a7
CpuLimitstring

The maximum number of CPU cores allowed for each application instance when the application is running.

400
GroupTypeinteger

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
ClusterIdstring

The ID of the cluster.

0d247b93-8d62-4e34-****-************
PostStartstring

The post-start script.

{\"exec\":{\"command\":[\"ls\",\"/\"]}}"
Labelsstring

The tag.

test
MemoryLimitstring

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
Strategystring

The throttling policy. This parameter is reserved.

RollingUpdate
Selectorstring

The ID of the application deployed in the ACK cluster in Enterprise Distributed Application Service (EDAS).

53dd85cc-25b4-4d0e-****-6bf5465****4
GroupIdstring

The ID of the instance group.

577f4c50-16ee-43d8-****-************
GroupNamestring

The name of the instance group.

_DEFAULT_GROUP
ClusterNamestring

The name of the cluster.

doc-test
PackageVersionIdstring

The version of the deployment package that was used to deploy an application in the instance group.

a7d48fe8-ad8f-****-89bd-74cc1ee6****
Reversionstring

The version of the application. The value progressively increases in the range of 0 to 7.

2
VExtServerGroupIdstring

The ID of the vServer group of the Internet-facing SLB instance associated with the instance group.

rsp-cige6******
PackagePublicUrlstring

The external download URL of the deployment package.

http://****.oss-cn-shanghai.aliyuncs.com/****/sc-****-consumer-E.jar
EphemeralStorageRequeststring

The minimum size of space required by ephemeral storage. Unit: GB. Value 0 indicates that no limit is set on the space size.

4
EphemeralStorageLimitstring

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.