All Products
Search

This Product

    Global Accelerator:CreateBasicEndpoints

    Document Center

    Global Accelerator:CreateBasicEndpoints

    Last Updated:Apr 28, 2024

    Creates multiple endpoints for a basic Global Accelerator (GA) instance.

    Operation description

    • CreateBasicEndpoints is an asynchronous operation. After you call this operation, the system returns a request ID and runs the task in the background. You can call the ListBasicEndpoints operation to query the status of endpoints. - If one or more endpoints are in the init state, it indicates that the endpoints are being created. In this case, you can continue to perform query operations on the endpoints. If all endpoints are in the active state, it indicates that the endpoints are created.
    • You cannot call the CreateBasicEndpoints operation again on the same GA instance before the previous operation is complete.

    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
    ga:CreateBasicEndpointsWrite
    • BasicEndpoint
      acs:ga:{#regionId}:{#accountId}:basicendpoint/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

    		cn-hangzhou
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-426655440000
    AcceleratorIdstringYes

    The ID of the basic GA instance.

    		ga-bp17frjjh0udz4qz****
    EndpointGroupIdstringYes

    The ID of the endpoint group.

    		epg-bp1dmlohjjz4kqaun****
    Endpointsobject []Yes

    The endpoints.

    NamestringNo

    The name of the endpoint.

    The name must be 1 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

    		ep01
    EndpointTypestringNo

    The type of the endpoint. Valid values:

    • ENI: elastic network interface (ENI).
    • SLB: Classic Load Balancer (CLB) instance.
    • ECS: Elastic Compute Service (ECS) instance.
    • NLB: Network Load Balancer (NLB) instance.
    Note This parameter is required.
    		ENI
    EndpointAddressstringNo

    The address of the endpoint.

    		eni-bp1a05txelswuj8g****
    EndpointSubAddressstringNo

    The secondary address of the endpoint.

    This parameter is required only if you set the endpoint type to ECS, ENI, or NLB.

    • If you set the endpoint type to ECS, you can set EndpointSubAddress to the secondary private IP address of the primary ENI. If you leave this parameter empty, the primary private IP address of the primary ENI is used.
    • If you set the endpoint type to ENI, you can set EndpointSubAddress to the secondary private IP address of the secondary ENI. If you leave this parameter empty, the primary private IP address of the secondary ENI is used.
    • If you set the endpoint type to NLB, you can set EndpointSubAddress to the primary private IP address of the NLB backend server.
    		172.16.XX.XX
    EndpointSubAddressTypestringNo

    The secondary address type of the endpoint. Valid values:

    • primary: a primary private IP address.
    • secondary: a secondary private IP address.

    This parameter is required only if you set the endpoint type to ECS, ENI, or NLB. If you set the endpoint type to NLB, only primary is supported.

    		primary
    EndpointZoneIdstringNo

    The ID of the zone where the endpoint resides.

    This parameter is required only if you set the endpoint type to NLB.

    		cn-hangzhou-g

    Response parameters

    ParameterTypeDescriptionExample
    object

    A list of response parameters.

    RequestIdstring

    The ID of the request.

    		04F0F334-1335-436C-A1D7-6C044FE73368
    EndpointGroupIdstring

    The ID of the endpoint group.

    		epg-bp1dmlohjjz4kqaun****
    Endpointsobject []

    The endpoints in the endpoint group.

    EndpointIdstring

    The ID of the endpoint.

    		ep-bp14sz7ftcwwjgrdm****
    EndpointTypestring

    The type of the endpoint. Valid values:

    • ENI: ENI.
    • SLB: CLB instance.
    • ECS: ECS instance.
    • NLB: NLB instance.
    		ENI
    EndpointAddressstring

    The address of the endpoint.

    		eni-bp1a05txelswuj8g****
    EndpointSubAddressstring

    The secondary address of the endpoint.

    This parameter is returned if the endpoint type is ECS, ENI, or NLB.

    • If the endpoint type is ECS, EndpointSubAddress returns the primary or secondary private IP address of the primary ENI.
    • If the endpoint type is ENI, EndpointSubAddress returns the primary or secondary private IP address of the secondary ENI.
    • If the endpoint type is NLB, EndpointSubAddress returns the primary private IP address of the NLB backend server.
    		172.16.XX.XX

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "Endpoints": [
    {
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointType": "ENI",
      "EndpointAddress": "eni-bp1a05txelswuj8g****",
      "EndpointSubAddress": "172.16.XX.XX"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.
    400NotFound.ENIInstanceThe ENI instance is not found.The ENI instance does not exist in the region where the Endpoint Group belongs.
    400Invalidate.SlbAddressTypeThe SLB instance must be internal-facing.The SLB instance must be internal-facing.

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

    Change history

    Change timeSummary of changesOperation
    2023-04-27The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-04-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400