Help Center/ Cloud Connect/ API Reference/ API/ Cloud Connections/ Updating a Cloud Connection
Updated on 2024-11-19 GMT+08:00

Updating a Cloud Connection

Function

This API is used to update a cloud connection.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{domain_id}/ccaas/cloud-connections/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

cloud_connection

Yes

UpdateCloudConnection object

Details of the cloud connection to be updated.

Table 4 UpdateCloudConnection

Parameter

Mandatory

Type

Description

name

No

String

Instance name.

description

No

String

Resource description. Angle brackets (<>) are not allowed.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

cloud_connection

CloudConnection object

Cloud connection.

Table 6 CloudConnection

Parameter

Type

Description

id

String

Instance ID.

name

String

Instance name.

description

String

Resource description. Angle brackets (<>) are not allowed.

domain_id

String

ID of the account that the instance belongs to.

enterprise_project_id

String

ID of the enterprise project that the resource belongs to.

created_at

String

Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format.

updated_at

String

Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format.

tags

Array of Tag objects

Resource tags.

status

String

Cloud connection status.

ACTIVE: The cloud connection is available.

admin_state_up

Boolean

Administrative status of the cloud connection.

used_scene

String

Cloud Connect application scenarios.

VPC: Cloud Connect is used to connect VPCs.

network_instance_number

Integer

Number of the network instances loaded to the cloud connection.

bandwidth_package_number

Integer

Number of the bandwidth packages bound to the cloud connection.

inter_region_bandwidth_number

Integer

Number of the inter-region bandwidths configured for the cloud connection.

Table 7 Tag

Parameter

Type

Description

key

String

Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_).

value

String

Tag value. The value can contain a maximum of 255 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

Example Requests

Updating the name and description of a cloud connection

PUT https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connections/{id}

{
  "cloud_connection" : {
    "name" : "new cloud-connection name",
    "description" : "new cloud-connection description"
  }
}

Example Responses

Status code: 200

The cloud connection has been updated.

{
  "cloud_connection" : {
    "status" : "ACTIVE",
    "id" : "XXX",
    "name" : "new cloud-connection name",
    "description" : "new cloud-connection description",
    "domain_id" : "XXX",
    "created_at" : "2023-09-20T08:28:28Z",
    "updated_at" : "2023-09-20T09:24:38Z",
    "admin_state_up" : true,
    "used_scene" : "vpc",
    "enterprise_project_id" : "0",
    "network_instance_number" : 0,
    "bandwidth_package_number" : 0,
    "inter_region_bandwidth_number" : 0,
    "tags" : [ ]
  },
  "request_id" : "0e44ca4e6c250521d154e96a7e2b3cf0"
}

SDK Sample Code

The SDK sample code is as follows.

Updating the name and description of a cloud 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;


public class UpdateCloudConnectionSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateCloudConnectionRequest request = new UpdateCloudConnectionRequest();
        request.withId("{id}");
        UpdateCloudConnectionRequestBody body = new UpdateCloudConnectionRequestBody();
        UpdateCloudConnection cloudConnectionbody = new UpdateCloudConnection();
        cloudConnectionbody.withName("new cloud-connection name")
            .withDescription("new cloud-connection description");
        body.withCloudConnection(cloudConnectionbody);
        request.withBody(body);
        try {
            UpdateCloudConnectionResponse response = client.updateCloudConnection(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 name and description of a cloud 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.v3 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 = GlobalCredentials(ak, sk)

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

    try:
        request = UpdateCloudConnectionRequest()
        request.id = "{id}"
        cloudConnectionbody = UpdateCloudConnection(
            name="new cloud-connection name",
            description="new cloud-connection description"
        )
        request.body = UpdateCloudConnectionRequestBody(
            cloud_connection=cloudConnectionbody
        )
        response = client.update_cloud_connection(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 name and description of a cloud 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateCloudConnectionRequest{}
	request.Id = "{id}"
	nameCloudConnection:= "new cloud-connection name"
	descriptionCloudConnection:= "new cloud-connection description"
	cloudConnectionbody := &model.UpdateCloudConnection{
		Name: &nameCloudConnection,
		Description: &descriptionCloudConnection,
	}
	request.Body = &model.UpdateCloudConnectionRequestBody{
		CloudConnection: cloudConnectionbody,
	}
	response, err := client.UpdateCloudConnection(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 cloud connection has been updated.

Error Codes

See Error Codes.