Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Updating Descriptions of VPC Endpoint Connections

Updated on 2025-05-15 GMT+08:00

View PDF

Updating Descriptions of VPC Endpoint Connections

Function

This API is used to update descriptions of VPC endpoint connections.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/description

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the tenant ID.
vpc_endpoint_service_id	Yes	String	Specifies the ID of the VPC endpoint service.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
connections	Yes	Array of ConnectionsDesc objects	Specifies the VPC endpoint connections.

**Table 3** ConnectionsDesc
Parameter	Mandatory	Type	Description
id	Yes	String	Specifies the VPC endpoint ID in UUID format.
description	Yes	String	Specifies the description field. The value can contain characters such as letters and digits, but cannot contain angle brackets (< or >).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
connections	Array of ConnectionEndpoints objects	Specifies the connection list.

**Table 5** ConnectionEndpoints
Parameter	Type	Description
id	String	Specifies the unique ID of the VPC endpoint.
marker_id	Integer	Specifies the packet ID of the VPC endpoint.
created_at	String	Specifies when the VPC endpoint was created. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
updated_at	String	Specifies when the VPC endpoint was updated. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
domain_id	String	Domain ID of a user.
error	Array of QueryError objects	Specifies the error message. This field is returned when the VPC endpoint is abnormal, that is, the value of status is failed.
status	String	Specifies the status of the VPC endpoint. pendingAcceptance: The VPC endpoint is to be accepted. creating: The VPC endpoint is being created. accepted: The VPC endpoint has been accepted. rejected: The VPC endpoint has been rejected. failed: The VPC endpoint failed to be created. deleting: The VPC endpoint is being deleted.
description	String	Specifies the description of a VPC endpoint connection.

**Table 6** QueryError
Parameter	Type	Description
error_code	String	Error code.
error_message	String	Error message.

Example Requests

Updating the description of a VPC endpoint connection

https://{endpoint}/v1/{project_id}/vpc-endpoint-services/813d9300-8473-405b-bfcd-f711117bad65/connections/description

{
  "connections" : [ {
    "id" : "0df78897-35b0-4a93-ad17-0bc0585f546b",
    "description" : "Specifies the VPC endpoint 1, which belongs to account [0605767a3300d5762fb7c0186d9e1779]abc_26."
  }, {
    "id" : "0d837f75-90d5-4528-bd11-5d974238ebca",
    "description" : "Specifies the VPC endpoint 2, which belongs to account [7876999999999]abc_26."
  } ]
}

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "connections" : [ {
    "id" : "0d837f75-90d5-4528-bd11-5d974238ebca",
    "status" : "accepted",
    "description" : "Specifies the VPC endpoint 2, which belongs to account [7876999999999]abc_26.",
    "marker_id" : 302008767,
    "domain_id" : "05b5408a0a80d2b10f06c0184a774460",
    "created_at" : "2022-04-14T02:09:08Z",
    "updated_at" : "2022-04-14T07:55:40Z"
  }, {
    "id" : "0df78897-35b0-4a93-ad17-0bc0585f546b",
    "status" : "accepted",
    "description" : "Specifies the VPC endpoint 1, which belongs to account [0605767a3300d5762fb7c0186d9e1779]abc_26.",
    "marker_id" : 302001833,
    "domain_id" : "05b5408a0a80d2b10f06c0184a774460",
    "created_at" : "2022-04-14T01:59:31Z",
    "updated_at" : "2022-04-14T07:57:39Z"
  } ]
}