All Products
Search
Document Center

Global Accelerator:UpdateBasicEndpoint

Last Updated:Apr 28, 2024

Modifies the name of an endpoint that is associated with a basic Global Accelerator (GA) instance.

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:UpdateBasicEndpointWrite
  • BasicEndpoint
    acs:ga:{#regionId}:{#accountId}:basicendpoint/{#EndPointId}
    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 that you want to modify belongs.

epg-bp1dmlohjjz4kqaun****
EndpointIdstringYes

The ID of the endpoint that you want to modify.

ep-bp14sz7ftcwwjgrdm****
NamestringYes

The name of the endpoint that is associated with the basic GA instance.

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIdstring

The ID of the endpoint group to which the endpoints belong.

epg-bp1dmlohjjz4kqaun****
EndpointIdstring

The ID of the endpoint.

ep-bp14sz7ftcwwjgrdm****
Namestring

The name of the endpoint.

ep01

Examples

Sample success responses

JSONformat

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
  "Name": "ep01"
}

Error codes

HTTP status codeError codeError messageDescription
400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.

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

Change history

Change timeSummary of changesOperation
2024-01-23The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400