All Products
Search
Document Center

Global Accelerator:DeleteBasicEndpoint

Last Updated:May 16, 2024

Deletes an endpoint that is associated with a basic Global Accelerator (GA) instance.

Operation description

  • DeleteBasicEndpoint is an asynchronous operation. After you send a request, 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 the endpoint is in the deleting state, it indicates that the endpoint is being deleted. In this case, you can perform only query operations.
    • If the endpoint cannot be found, it indicates that the endpoint is deleted.
  • The DeleteBasicEndpoint API operation cannot be repeatedly called for the same basic GA instance within a period of time.

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:DeleteBasicEndpointWrite
  • BasicEndpoint
    acs:ga:{#regionId}:{#accountId}:basicendpoint/{#basicendpointId}
    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
EndpointGroupIdstringYes

The ID of the endpoint group to which the endpoint to be deleted belongs.

epg-bp1dmlohjjz4kqaun****
EndpointIdstringYes

The ID of the endpoint that you want to delete.

ep-bp14sz7ftcwwjgrdm****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

EndpointIdstring

The ID of the endpoint.

ep-bp14sz7ftcwwjgrdm****
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

{
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status codeError codeError messageDescription
400Exist.EndpointGroupThe endpoint group already exists.The endpoint group already exists.

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

Change history

Change timeSummary of changesOperation
No change history