Help Center/ Global Accelerator/ API Reference/ API/ Endpoint Group/ Updating an Endpoint Group

Updated on 2024-11-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Updating an Endpoint Group

Function

This API is used to update an endpoint group.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/endpoint-groups/{endpoint_group_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
endpoint_group_id	Yes	String	Specifies the endpoint group ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
endpoint_group	Yes	UpdateEndpointGroupOption object	Specifies the detailed information about updating an endpoint group.

**Table 4** UpdateEndpointGroupOption
Parameter	Mandatory	Type	Description
name	No	String	Specifies the endpoint group name. The name can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.
description	No	String	Specifies the information about the endpoint group. The value can contain 0 to 255 characters. The following characters are not allowed: <>
traffic_dial_percentage	No	Integer	Specifies the percentage of traffic distributed to the endpoint group.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
endpoint_group	EndpointGroupDetail object	Specifies the endpoint group.
request_id	String	Specifies the request ID.

**Table 6** EndpointGroupDetail
Parameter	Type	Description
id	String	Specifies the endpoint group ID.
name	String	Specifies the endpoint group name. The name can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.
description	String	Specifies the information about the endpoint group. The value can contain 0 to 255 characters. The following characters are not allowed: <>
status	String	Specifies the provisioning status. The value can be one of the following: ACTIVE: The resource is running. PENDING: The status is to be determined. ERROR: Failed to create the resource. DELETING: The resource is being deleted.
traffic_dial_percentage	Integer	Specifies the percentage of traffic distributed to the endpoint group.
region_id	String	Specifies the region where the endpoint group belongs.
listeners	Array of Id objects	Specifies the listeners associated with the endpoint group.
created_at	String	Specifies when the endpoint group was added.
updated_at	String	Specifies when the endpoint group was updated.
domain_id	String	Specifies the tenant ID.
frozen_info	FrozenInfo object	Specifies the frozen details of cloud services or resources.

**Table 7** Id
Parameter	Type	Description
id	String	Specifies the ID of the associated listener.

**Table 8** FrozenInfo
Parameter	Type	Description
status	Integer	Specifies the status of a cloud service or resource. The value can be one of the following: 0: unfrozen/normal (The cloud service will recover after being unfrozen.) 1: frozen (Resources and data will be retained, but the cloud service cannot be used.) 2: deleted/terminated (Both resources and data will be cleared.)
effect	Integer	Specifies the status of the resource after being frozen. The value can be one of the following: 1 (default): The resource is frozen and can be released. 2: The resource is frozen and cannot be released. 3: The resource is frozen and cannot be renewed.
scene	Array of strings	Specifies the service scenario. The value can be one of the following: ARREAR: The cloud service is in arrears, including expiration of yearly/monthly resources and fee deduction failure of pay-per-use resources. POLICE: The cloud service is frozen for public security. ILLEGAL: The cloud service is frozen due to violation of laws and regulations. VERIFY: The cloud service is frozen because the user fails to pass the real-name authentication. PARTNER: A partner freezes their customer's resources.

Example Requests

Changing traffic dial to 5 and modifying the name and description of an endpoint group

PUT https://{ga_endpoint}/v1/endpoint-groups/3a9f50bb-f041-4eac-a117-82472d8a0007

{
  "endpoint_group" : {
    "name" : "endpoint-group-name-new",
    "description" : "endpoint-group description new",
    "traffic_dial_percentage" : 5
  }
}

Example Responses

Status code: 200

Operation succeeded.

{
  "endpoint_group" : {
    "id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "name" : "endpoint-group-name-new",
    "description" : "endpoint-group description new",
    "status" : "ACTIVE",
    "traffic_dial_percentage" : 5,
    "region_id" : "ap-southeast-1",
    "listeners" : [ {
      "id" : "1b11747a-b139-492f-9692-2df0b1c87193"
    } ],
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}