All Products
Search
Document Center

Enterprise Distributed Application Service:InsertDeployGroup

Last Updated:Jan 08, 2024

Creates an instance group for a specified application.

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.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ManageApplicationWrite
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/v5/deploy_group

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

3616cdca-4f92-4413-***********
GroupNamestringYes

The name of the instance group. The name can be up to 64 characters in length.

test
InitPackageVersionIdstringNo

The version of the initial deployment package associated with the instance group. You can call the ListHistoryDeployVersion operation to query the version. For more information, see ListHistoryDeployVersion .

441beb18-da42-44dc-****-****

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

3RD9-D3FRE****************
DeployGroupEntityobject

The information about the instance group.

UpdateTimelong

The time when the instance group 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
GroupNamestring

The name of the instance group.

test
CreateTimelong

The time when the instance group 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
AppVersionIdstring

The version of the deployment package for the application.

  • If the application is deployed, a string of random numbers is returned.
  • If the application is not deployed, the return value is empty.
****f4c50-16ee-a02b-667*****
AppIdstring

The ID of the application.

3616cdca-4f92-4413-***********
PackageVersionIdstring

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

  • If an application is deployed in the instance group, a string of random numbers is returned.
  • If no application is deployed in the instance group, the return value is empty.
****7b93-8d62-4e34***********
GroupTypeinteger

The type of the instance group. Valid values:

  • 0: the default group.
  • 1: a group for which canary traffic management is not enabled.
  • 2: a group for which canary traffic management is enabled.
1
Idstring

The ID of the instance group.

577f4c50-16ee-43d8-a02b-667*********
ClusterIdstring

The ID of the cluster.

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

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "3RD9-D3FRE****************",
  "DeployGroupEntity": {
    "UpdateTime": 1573627695779,
    "GroupName": "test",
    "CreateTime": 1573627695779,
    "AppVersionId": "****f4c50-16ee-a02b-667*****",
    "AppId": "3616cdca-4f92-4413-***********",
    "PackageVersionId": "****7b93-8d62-4e34***********",
    "GroupType": 1,
    "Id": "577f4c50-16ee-43d8-a02b-667*********",
    "ClusterId": "0d247b93-8d62-4e34***********"
  }
}

Error codes

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