CreateBasicEndpointGroup -

Description

CreateBasicEndpointGroup is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the GetBasicEndpointGroup operation to query the state of an endpoint group.
- If the endpoint group is in the init state, the endpoint is being created. In this case, you can perform only query operations.
- If the endpoint group is in the active state, the endpoint group is created.
The CreateBasicEndpointGroup operation cannot be repeatedly called for the same GA instance within a specific period of time.

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 parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	CreateBasicEndpointGroup	The operation that you want to perform. Set the value to CreateBasicEndpointGroup.
RegionId	String	Yes	cn-hangzhou	The ID of the region where the basic GA instance is deployed. Set the value to cn-hangzhou.
ClientToken	String	No	123e4567-e89b-12d3-a456-426655440000	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The ClientToken value contain only ASCII characters. Note If you do not set this parameter, the system uses RequestId as ClientToken. The value of RequestId of each API request may be different.
AcceleratorId	String	Yes	ga-bp17frjjh0udz4qz****	The ID of the basic GA instance.
EndpointGroupRegion	String	Yes	cn-shanghai	The ID of the region where you want to create the endpoint group. You can call the DescribeRegions operation to obtain the region ID.
Name	String	No	group1	The name of the endpoint group. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
Description	String	No	BasicEndpointGroup	The description of the endpoint group. The description cannot exceed 256 characters in length and cannot contain `http://` or `https://`.
EndpointType	String	No	ENI	The type of endpoint. Valid values: ENI: elastic network interface (ENI) SLB: Classic Load Balancer (CLB) ECS: Elastic Compute Service (ECS)
EndpointAddress	String	No	eni-bp1a05txelswuj8g****	The address of the endpoint.
EndpointSubAddress	String	No	172.16.XX.XX	The secondary address of the endpoint. This parameter is required when the accelerated IP address is associated with the secondary private IP address of an ECS instance or ENI. When the endpoint type is ECS, you can set EndpointSubAddress to the secondary private IP address of the primary ENI. If the parameter is left empty, the primary private IP address of the primary ENI is used. When the endpoint type is ENI, you can set EndpointSubAddress to the secondary private IP address of the secondary ENI. If the parameter is left empty, the primary private IP address of the secondary ENI is used.

Response parameters


Parameter	Type	Example	Description
EndpointGroupId	String	epg-bp1dmlohjjz4kqaun****	The ID of the endpoint group.
RequestId	String	04F0F334-1335-436C-A1D7-6C044FE73368	The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBasicEndpointGroup
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp17frjjh0udz4qz****
&EndpointGroupRegion=cn-shanghai
&Name=group1
&Description=BasicEndpointGroup
&EndpointType=ENI
&EndpointAddress=eni-bp1a05txelswuj8g****
&EndpointSubAddress=172.16.XX.XX
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateBasicEndpointGroupResponse>
    <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</CreateBasicEndpointGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EndpointGroupId" : "epg-bp1dmlohjjz4kqaun****",
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes


HTTP status code	Error code	Error message	Description
400	Resource.QuotaFull	The resource quota is exceeded.	The error message returned because the number of resources has reached the upper limit.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	The error message returned because the current account does not have the permissions to enable health checks.
400	NotExist.Accelerator	The accelerated instance does not exist.	The error message returned because the specified GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The error message returned because the specified GA instance is in an invalid state.
400	NotExist.BusinessRegion	The business region does not exist.	The error message returned because the specified region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	The error message returned because no basic bandwidth plan is specified.
400	Exist.EndpointGroup	The endpoint group already exists.	The error message returned because the specified endpoint group already exists.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	The error message returned because an error occurs when the system processes the request. Try again later. If the error persists, submit a ticket.

For a list of error codes, see Service error codes.