# 更新云连接实例 - UpdateCloudConnection #### 功能介绍 更新指定云连接实例的基本信息，包括名称和描述。 该接口用于修改云连接实例的显示名称和描述信息，不改变实例的网络配置和连接关系。 适用于需要调整实例标识信息或更新描述内容的场景。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/doc?api=UpdateCloudConnection&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cc/cc_02_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cc:cloudConnections:update | Write | cloudConnection \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI PUT /v3/{domain_id}/ccaas/cloud-connections/{id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 用户的账号ID，即租户ID，用于标识资源所属的华为云账号。 | | id | 是 | String | - 参数解释：实例ID，即资源的唯一标识符。 - 约束限制：符合UUID格式，长度为32\~36个字符，只能包含十六进制数字和连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，即用户的认证令牌，用于验证用户身份和权限。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cloud_connection | 是 | [UpdateCloudConnection] object | 更新云连接实例的详细信息。 | 表4UpdateCloudConnection | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | description | 否 | String | - 参数解释：实例的描述信息，用于记录实例的用途、归属部门等辅助信息。 - 约束限制：长度范围为0\~255个字符，不能包含"\<"和"\>"字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | sync_tag | 否 | Array of strings | - 参数解释：云连接实例的同步标签，用于标识需要同步的资源类型。 - 约束限制：不涉及。 - 取值范围： - gcb: 同步全域互联带宽 - 默认取值：无。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | cloud_connection | [CloudConnectionInstance] object | 云连接实例。 | 表6CloudConnectionInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 实例ID。 | | name | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | description | String | - 参数解释：实例的描述信息，用于记录实例的用途、归属部门等辅助信息。 - 约束限制：长度范围为0\~255个字符，不能包含"\<"和"\>"字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | domain_id | String | 实例所属账号ID。 | | enterprise_project_id | String | - 参数解释：实例所属的企业项目ID，用于标识资源所属的企业项目，实现企业内部资源的隔离和管理。 - 约束限制：最大长度不超过36字符，符合UUID格式或为字符串"0"。 - 取值范围：不涉及。 - 默认取值："0"表示默认企业项目。 | | created_at | String | - 参数解释：实例的创建时间，记录资源首次创建的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | updated_at | String | - 参数解释：实例的最后更新时间，记录资源最后一次被修改的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | tags | Array of [Tag] objects | 实例标签。 | | sync_tag | Array of strings | - 参数解释：云连接实例的同步标签，用于标识需要同步的资源类型。 - 约束限制：不涉及。 - 取值范围： - gcb: 同步全域互联带宽 - 默认取值：无。 | | status | String | 云连接实例的状态，有效值： ACTIVE：状态可用。 | | admin_state_up | Boolean | 云连接实例的管理状态。 | | network_instance_number | Integer | 云连接实例关联网络实例的个数。 | | bandwidth_package_number | Integer | 云连接实例关联带宽包的个数。 | | inter_region_bandwidth_number | Integer | 云连接实例关联域间带宽的个数。 | 表7Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | - 参数解释：标签键，用于标识和分类资源的标签属性名。 - 约束限制：最大长度128个unicode字符，不能为空，不能以空格开头或结尾，不能以"*sys*"开头。只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | value | String | - 参数解释：标签值，与标签键对应的标签属性值，用于提供更具体的资源分类信息。 - 约束限制：最大长度255个unicode字符，可以为空，只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符、斜杠"/"。 - 取值范围：不涉及。 - 默认取值：不涉及。 | #### 请求示例 更新云连接实例的名称和描述 ``` PUT https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connections/{id} { "cloud_connection" : { "name" : "总部云连接-更新", "description" : "用于连接总部与各分支机构的云连接实例-已更新" } } ``` #### 响应示例 **状态码：200** 更新云连接实例成功。 返回更新后的云连接实例详细信息，包括修改后的名称、描述和其他配置信息。 更新操作不会影响实例的网络连接和运行状态。 更新云连接实例成功。 ``` { "request_id" : "0e44ca4e6c250521d154e96a7e2b3cf0", "cloud_connection" : { "status" : "ACTIVE", "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "name" : "总部云连接-更新", "description" : "用于连接总部与各分支机构的云连接实例-已更新", "domain_id" : "f87a4b574ba18fbc43fcbdccdcdf48944caa", "admin_state_up" : true, "enterprise_project_id" : "0", "network_instance_number" : 0, "bandwidth_package_number" : 0, "inter_region_bandwidth_number" : 0, "tags" : [ ], "created_at" : "2023-09-20T08:28:28Z", "updated_at" : "2023-09-20T09:24:38Z" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新云连接实例的名称和描述 ``` 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("")) .build(); UpdateCloudConnectionRequest request = new UpdateCloudConnectionRequest(); request.withId("{id}"); UpdateCloudConnectionRequestBody body = new UpdateCloudConnectionRequestBody(); UpdateCloudConnection cloudConnectionbody = new UpdateCloudConnection(); cloudConnectionbody.withName("总部云连接-更新") .withDescription("用于连接总部与各分支机构的云连接实例-已更新"); 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()); } } } ``` - [Python] 更新云连接实例的名称和描述 ``` # 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("")) \ .build() try: request = UpdateCloudConnectionRequest() request.id = "{id}" cloudConnectionbody = UpdateCloudConnection( name="总部云连接-更新", 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) ``` - [Go] 更新云连接实例的名称和描述 ``` 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cc.CcClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cc.NewCcClient(hcClient) request := &model.UpdateCloudConnectionRequest{} request.Id = "{id}" nameCloudConnection:= "总部云连接-更新" descriptionCloudConnection:= "用于连接总部与各分支机构的云连接实例-已更新" 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/sdk?api=UpdateCloudConnection&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 更新云连接实例成功。 返回更新后的云连接实例详细信息，包括修改后的名称、描述和其他配置信息。 更新操作不会影响实例的网络连接和运行状态。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cc/ErrorCode.html)。