On this page

Show all

Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ This API is used to update the description of the VPC endpoint connection.

This API is used to update the description of the VPC endpoint connection.

Updated on 2022-12-13 GMT+08:00

View PDF

Function

Function This API is used to update the description of a VPC endpoint.

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. Minimum: 36 Maximum: 64
vpc_endpoint_service_id	Yes	String	Specifies the ID of the VPC endpoint service. Minimum: 36 Maximum: 64

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
connections	Yes	Array of ConnectionsDesc objects	Specifies description fields of connection management.

**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 less than signs (<) and great than signs (>).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
connections	Array of ConnectionEndpoints objects	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 the creation time of the VPC endpoint. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ.
updated_at	String	Specifies the update time of the VPC endpoint. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ.
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 connection status of the VPC endpoint. ● pendingAcceptance: The VPC endpoint connection is to be accepted. ● creating: The VPC endpoint connection is being created. ● accepted: The VPC endpoint connection has been accepted. ● rejected: The VPC endpoint connection has been rejected. ● failed: The VPC endpoint connection failed. ● deleting: The VPC endpoint connection 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.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 8** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 10** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 12** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 404

**Table 13** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 14** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 405

**Table 15** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 16** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 406

**Table 17** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 18** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 407

**Table 19** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 20** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 408

**Table 21** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 22** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 409

**Table 23** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 24** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 500

**Table 25** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 26** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 501

**Table 27** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 28** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 502

**Table 29** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 30** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 503

**Table 31** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 32** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 504

**Table 33** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 34** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Example Requests

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 2, which belongs to account [0605767a3300d5762fb7c0186d9e1779]iaas_commonnet_odin_26."
  }, {
    "id" : "0d837f75-90d5-4528-bd11-5d974238ebca",
    "description" : "Specifies the VPC endpoint 2, which belongs to account [7876999999999]iaas_commonnet_odin_26."
  } ]
}

{
  "endpoint_service_name" : "test222_name_23432"
}

Example Responses

Status code: 200

{
  "connections" : [ {
    "id" : "0d837f75-90d5-4528-bd11-5d974238ebca",
    "status" : "accepted",
    "description" : "Specifies the VPC endpoint 2, which belongs to account [0605767a3300d5762fb7c0186d9e1779]iaas_commonnet_odin_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 2, which belongs to account [0605767a3300d5762fb7c0186d9e1779]iaas_commonnet_odin_26.",
    "marker_id" : 302001833,
    "domain_id" : "05b5408a0a80d2b10f06c0184a774460",
    "created_at" : "2022-04-14T01:59:31Z",
    "updated_at" : "2022-04-14T07:57:39Z"
  } ]
}

Status Codes

Status Code	Description
200	The server has successfully processed the request.
400	The server failed to process the request.
401	Username and password are required to access the requested page.
403	The access to the requested page is forbidden.
404	The server could not find the requested page.
405	The method specified in the request is not allowed.
406	The response generated by the server could not be accepted by the client.
407	Proxy authentication is required before the request is processed.
408	The request timed out.
409	The request could not be processed due to a conflict.
500	Request failed. A service error occurred.
501	Request failed. The server does not support the requested function.
502	Request failed. The server has received an invalid response from the upstream server.
503	Request failed. The system is unavailable.
504	Gateway timed out.