Querying the Cloud Connection List
Function
This API is used to query the cloud connection list.
Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{domain_id}/ccaas/cloud-connections
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 1 to 1000 |
marker |
No |
String |
Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified. |
id |
No |
Array of arrays |
Resource ID. Multiple IDs can be queried. |
name |
No |
Array of strings |
Resource name. Multiple names can be queried. |
description |
No |
Array of strings |
Description. Multiple descriptions can be queried. |
enterprise_project_id |
No |
Array of strings |
Enterprise project IDs. |
status |
No |
Array of strings |
Cloud connection status. ACTIVE: Cloud connections are available. |
type |
No |
Array of strings |
Type (application scenario) used to query cloud connections. |
used_scene |
No |
Array of strings |
Searching for cloud connections by application scenario |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
page_info |
PageInfo object |
Pagination query information. |
cloud_connections |
Array of CloudConnection objects |
Cloud connection list. |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Backward pagination identifier. |
previous_marker |
String |
Forward pagination identifier. |
current_count |
Integer |
Number of the resources in the current list. |
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. |
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
Querying the cloud connection list
GET https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connections
Example Responses
Status code: 200
The cloud connection list has been queried.
{ "request_id" : "ab44eb7776995d84a7580fe6a7bd7629", "cloud_connections" : [ { "status" : "ACTIVE", "id" : "XXX", "name" : "cloud-connenction name", "description" : "cloud-connection description", "domain_id" : "XXX", "created_at" : "2023-09-20T08:28:28Z", "updated_at" : "2023-09-20T08:28:28Z", "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" : [ ] } ], "page_info" : { "previous_marker" : "XXX", "current_count" : 30 } }
SDK Sample Code
The SDK sample code is as follows.
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 |
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.ListCloudConnectionsRequest{} response, err := client.ListCloudConnections(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 list has been queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot