All Products
Search
Document Center

Global Accelerator:UpdateEndpointGroupAttribute

Last Updated:Jul 31, 2024

Modifies the name and description of an endpoint group.

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:UpdateEndpointGroupAttributeupdate
  • EndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (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 value, but make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

123e4567-e89b-12d3-a456-426655440000
EndpointGroupIdstringYes

The ID of the endpoint group.

epg-bp1ple63864a5hyj5****
NamestringNo

The name of the endpoint group that you want to modify.

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

test
DescriptionstringNo

The description of the endpoint group that you want to modify. The description can be up to 200 characters in length and cannot start with http:// or https://.

testEndpointGroup

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

6FEA0CF3-D3B9-43E5-A304-D217037876A8

Examples

Sample success responses

JSONformat

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}

Error codes

HTTP status codeError codeError messageDescription
400Resource.QuotaFullThe resource quota is exceeded.The number of resources has reached the upper limit.
400NotExist.EndPointGroupThe endpoint group does not exist.The endpoint group does not exist.
400StateError.EndPointGroupThe specified state of endpoint group is invalid.The endpoint group is in an invalid state.
403Forbbiden.SubUserYou are not authorized to operate on the specified resource because your account was created by another user.The current account is a RAM user and does not have permissions to manage the specified resources.
403ForbiddenThe user is not authorized to operate on the specified resource.The current account does not have permissions to manage the specified resources.
500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.An error occurred while the request was being processed. Try again later.

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

Change history

Change timeSummary of changesOperation
No change history