Updated on 2025-08-19 GMT+08:00

Modifying an Endpoint

Function

Modifying an Endpoint

Calling Method

For details, see Calling APIs.

URI

PUT /v2.1/endpoints/{endpoint_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

endpoint_id

Yes

String

Endpoint ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, seeObtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Endpoint name.

It can contain 1 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

endpoint

EndpointResp object

Endpoint

Table 5 EndpointResp

Parameter

Type

Description

id

String

Endpoint ID, which is a UUID used to identify the endpoint

name

String

Endpoint name

direction

String

Endpoint direction.

The value can be:

  • inbound: indicates an inbound endpoint.

  • outbound: indicates an outbound endpoint.

status

String

Resource status. The value can be PENDING_CREATE, ACTIVE, PENDING_DELETE, or ERROR.

vpc_id

String

ID of the VPC to which the endpoint belongs.

ipaddress_count

Integer

Number of IP addresses of the endpoint

resolver_rule_count

Integer

Number of endpoint rules in the endpoint

This parameter is returned only for outbound endpoints.

create_time

String

The creation time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

update_time

String

The update time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

Modifying the endpoint name

PUT https://{endpoint}/v2.1/endpoints/{endpoint_id}

{
  "name" : "2118"
}

Example Responses

Status code: 202

Request accepted

{
  "endpoint" : {
    "id" : "ff80808169bf16c70169bf1d02270000",
    "name" : "2118",
    "direction" : "inbound",
    "status" : "ACTIVE",
    "vpc_id" : "02443811-acf1-4c22-8f44-e3adf19f6097",
    "ipaddress_count" : 6,
    "resolver_rule_count" : 0,
    "create_time" : "2019-03-27T12:25:43.181",
    "update_time" : "2019-03-27T12:25:43.181"
  }
}

Status Codes

Status Code

Description

202

Request accepted

400

Error response

500

Error response

Error Codes

See Error Codes.