ListDeployGroup - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request header. For more information, see the topic about common request parameters.

Request syntax

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

Request parameters


Parameter	Type	Position	Required	Example	Description
AppId	String	Query	Yes	3616cdca-4f92-4413-**-**********	The ID of the application. You can query the ID by calling the ListApplication operation. For more information, see ListApplication.

Response parameters


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

Examples

Sample requests

POST /pop/v5/app/deploy_group_list HTTP/1.1
Common request header
{
  "AppId": ""
}

Sample success responses

XML format

<DeployGroupList>
    <DeployGroup>
        <GroupName>_DEFAULT_GROUP</GroupName>
        <MemoryRequest>512</MemoryRequest>
        <NameSpace>ping****est</NameSpace>
        <AppVersionId>""</AppVersionId>
        <Env>497806cb-****-6a7</Env>
        <CsClusterId>c66e65950db****cba92f17434df1****</CsClusterId>
        <PackageVersion>E</PackageVersion>
        <Reversion>2</Reversion>
        <PreStop>""</PreStop>
        <LastUpdateTime>1587888503825</LastUpdateTime>
        <ClusterName>doc-test</ClusterName>
        <Selector>53dd85cc-25b4-4d0e-****-6bf5465****4</Selector>
        <Status>2</Status>
        <DeploymentName>test</DeploymentName>
        <CpuLimit>400</CpuLimit>
        <ClusterId>0d247b93-8d62-4e34-****-************</ClusterId>
        <CreateTime>1573627695779</CreateTime>
        <PostStart>""</PostStart>
        <Labels>test</Labels>
        <PackageVersionId>""</PackageVersionId>
        <BaseComponentMetaName>k8s-sc-consumer-****</BaseComponentMetaName>
        <GroupId>577f4c50-16ee-43d8-****-************</GroupId>
        <MemoryLimit>0</MemoryLimit>
        <AppId>3616cdca-4f92-4413-****-************</AppId>
        <GroupType>1</GroupType>
        <UpdateTime>1573627695779</UpdateTime>
        <PackageUrl>http://****.oss-cn-shanghai.aliyuncs.com/****/sc-****-consumer-E.jar</PackageUrl>
        <Strategy>RollingUpdate</Strategy>
        <CpuRequest>1</CpuRequest>
        <PackagePublicUrl>http://****.oss-cn-shanghai.aliyuncs.com/****/sc-****-consumer-E.jar</PackagePublicUrl>
    </DeployGroup>
</DeployGroupList>
<Message>success</Message>
<RequestId>3FDE-DS9R-*********************</RequestId>
<Code>200</Code>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.