Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Updating Descriptions of VPC Endpoint Connections
Updated on 2024-08-12 GMT+08:00

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.

Minimum: 1

Maximum: 64

vpc_endpoint_service_id

Yes

String

Specifies the ID of the VPC endpoint service.

Minimum: 1

Maximum: 64

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.

Minimum: 1

Maximum: 64

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 (>).

Minimum: 0

Maximum: 512

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.

Minimum: 1

Maximum: 64

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.

Minimum: 1

Maximum: 64

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.

Minimum: 0

Maximum: 512

Table 6 QueryError

Parameter

Type

Description

error_code

String

Error code.

Minimum: 0

Maximum: 10

error_message

String

Error message.

Minimum: 0

Maximum: 1024

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"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Updating the description of a VPC endpoint connection

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpcep.v1.region.VpcepRegion;
import com.huaweicloud.sdk.vpcep.v1.*;
import com.huaweicloud.sdk.vpcep.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateEndpointConnectionsDescSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        VpcepClient client = VpcepClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcepRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateEndpointConnectionsDescRequest request = new UpdateEndpointConnectionsDescRequest();
        UpdateEndpointConnectionsDescRequestBody body = new UpdateEndpointConnectionsDescRequestBody();
        List<ConnectionsDesc> listbodyConnections = new ArrayList<>();
        listbodyConnections.add(
            new ConnectionsDesc()
                .withId("0df78897-35b0-4a93-ad17-0bc0585f546b")
                .withDescription("Specifies the VPC endpoint 1, which belongs to account [0605767a3300d5762fb7c0186d9e1779]abc_26.")
        );
        listbodyConnections.add(
            new ConnectionsDesc()
                .withId("0d837f75-90d5-4528-bd11-5d974238ebca")
                .withDescription("Specifies the VPC endpoint 2, which belongs to account [7876999999999]abc_26.")
        );
        body.withConnections(listbodyConnections);
        request.withBody(body);
        try {
            UpdateEndpointConnectionsDescResponse response = client.updateEndpointConnectionsDesc(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Updating the description of a VPC endpoint connection

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpcep.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = VpcepClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcepRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateEndpointConnectionsDescRequest()
        listConnectionsbody = [
            ConnectionsDesc(
                id="0df78897-35b0-4a93-ad17-0bc0585f546b",
                description="Specifies the VPC endpoint 1, which belongs to account [0605767a3300d5762fb7c0186d9e1779]abc_26."
            ),
            ConnectionsDesc(
                id="0d837f75-90d5-4528-bd11-5d974238ebca",
                description="Specifies the VPC endpoint 2, which belongs to account [7876999999999]abc_26."
            )
        ]
        request.body = UpdateEndpointConnectionsDescRequestBody(
            connections=listConnectionsbody
        )
        response = client.update_endpoint_connections_desc(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Updating the description of a VPC endpoint connection

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := vpcep.NewVpcepClient(
        vpcep.VpcepClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateEndpointConnectionsDescRequest{}
	var listConnectionsbody = []model.ConnectionsDesc{
        {
            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.",
        },
    }
	request.Body = &model.UpdateEndpointConnectionsDescRequestBody{
		Connections: listConnectionsbody,
	}
	response, err := client.UpdateEndpointConnectionsDesc(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The server has successfully processed the request.

Error Codes

See Error Codes.