查询云连接列表 - ListCloudConnections
功能介绍
查询当前账号下的云连接实例列表,支持按名称、状态、企业项目等多维度过滤。
该接口适用于需要查看、管理或监控云连接实例的场景,如资源盘点、状态监控、批量操作等。
分页查询:使用marker和limit参数进行分页,marker和limit必须一起使用才能生效。marker从上次查询结果的next_marker或previous_marker字段获取,用于翻页查询。翻页过程中查询条件不能修改。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cc:cloudConnections:list
List
cloudConnection *
-
-
-
URI
GET /v3/{domain_id}/ccaas/cloud-connections
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 用户的账号ID,即租户ID,用于标识资源所属的华为云账号。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | |
| marker | 否 | String | |
| id | 否 | Array of strings | 根据ID查询,可查询多个ID。 |
| name | 否 | Array of strings | 根据名称查询,可查询多个名称。 |
| description | 否 | Array of strings | 根据描述查询,可查询多个描述。 |
| enterprise_project_id | 否 | Array of strings | 根据企业项目ID过滤列表。 |
| status | 否 | Array of strings |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token,即用户的认证令牌,用于验证用户身份和权限。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 请求ID。 |
| page_info | PageInfo object | 分页查询页的信息。 |
| cloud_connections | Array of CloudConnectionInstance objects | 云连接实例列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 向后分页标识符。 |
| previous_marker | String | 向前分页标识符。 |
| current_count | Integer | 当前列表中资源数量。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 实例ID。 |
| name | String | |
| description | String | |
| domain_id | String | 实例所属账号ID。 |
| enterprise_project_id | String | |
| created_at | String | |
| updated_at | String | |
| tags | Array of Tag objects | 实例标签。 |
| status | String | 云连接实例的状态,有效值: ACTIVE:状态可用。 |
| admin_state_up | Boolean | 云连接实例的管理状态。 |
| network_instance_number | Integer | 云连接实例关联网络实例的个数。 |
| bandwidth_package_number | Integer | 云连接实例关联带宽包的个数。 |
| inter_region_bandwidth_number | Integer | 云连接实例关联域间带宽的个数。 |
请求示例
查询云连接实例列表
GET https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connections 响应示例
状态码:200
查询云连接实例列表成功。
返回符合条件的云连接实例列表,包含每个实例的ID、名称、状态、描述等基本信息。
当使用分页查询时,响应中会包含分页信息,支持通过marker进行翻页查询。
查询云连接实例列表成功。
{
"request_id" : "ab44eb7776995d84a7580fe6a7bd7629",
"cloud_connections" : [ {
"status" : "ACTIVE",
"id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"name" : "总部云连接",
"description" : "用于连接总部与各分支机构的云连接实例",
"domain_id" : "f87a4b574ba18fbc43fcbdccdcdf48944caa",
"created_at" : "2023-09-20T08:28:28Z",
"updated_at" : "2023-09-20T08:28:28Z",
"admin_state_up" : true,
"enterprise_project_id" : "0",
"tags" : [ ]
} ],
"page_info" : {
"previous_marker" : "f4bb2b35-438d-42a1-a281-76f30794a0b0",
"current_count" : 30
}
} SDK代码示例
SDK代码示例如下。
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 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 ListCloudConnectionsSolution { 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(); ListCloudConnectionsRequest request = new ListCloudConnectionsRequest(); try { ListCloudConnectionsResponse response = client.listCloudConnections(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()); } } } |
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 | # 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 = ListCloudConnectionsRequest() response = client.list_cloud_connections(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cc.NewCcClient(hcClient) request := &model.ListCloudConnectionsRequest{} response, err := client.ListCloudConnections(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询云连接实例列表成功。 返回符合条件的云连接实例列表,包含每个实例的ID、名称、状态、描述等基本信息。 当使用分页查询时,响应中会包含分页信息,支持通过marker进行翻页查询。 |
错误码
请参见错误码。