文档首页/ 云连接 CC/ API参考/ API/ 云连接实例/ 通过标签过滤云连接实例
更新时间:2024-11-25 GMT+08:00

通过标签过滤云连接实例

功能介绍

通过标签过滤云连接实例。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v3/{domain_id}/ccaas/cloud-connections/filter

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

tags

Array of MultivaluedTag objects

包含标签。

表4 MultivaluedTag

参数

是否必选

参数类型

描述

key

String

标签键,最大长度128个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

values

Array of strings

相同键的值列表

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

page_info

PageInfo object

分页查询页的信息。

cloud_connections

Array of CloudConnection objects

云连接实例列表。

表6 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。

previous_marker

String

向前分页标识符。

current_count

Integer

当前列表中资源数量。

表7 CloudConnection

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

description

String

实例描述。不支持 <>。

domain_id

String

实例所属账号ID。

enterprise_project_id

String

实例所属企业项目ID。

created_at

String

实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

updated_at

String

实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

tags

Array of Tag objects

实例标签。

status

String

云连接实例的状态。ACTIVE:表示状态可用。

admin_state_up

Boolean

云连接实例的管理状态。

used_scene

String

云连接使用场景。

  • VPC:虚拟私有云。

network_instance_number

Integer

云连接实例关联网络实例的个数。

bandwidth_package_number

Integer

云连接实例关联带宽包的个数。

inter_region_bandwidth_number

Integer

云连接实例关联域间带宽的个数。

表8 Tag

参数

参数类型

描述

key

String

标签键,最大长度128个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

value

String

标签值,最大长度255个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

请求示例

通过标签过滤云连接实例

POST https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connections/filter

{
  "tags" : [ {
    "key" : "key",
    "values" : [ "value" ]
  } ]
}

响应示例

状态码: 200

通过标签过滤云连接实例成功。

{
  "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" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  } ],
  "page_info" : {
    "previous_marker" : "XXX",
    "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
46
47
48
49
50
51
52
53
54
55
56
57
58
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.*;

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

public class ListCloudConnectionsByTagsSolution {

    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();
        ListCloudConnectionsByTagsRequest request = new ListCloudConnectionsByTagsRequest();
        ListCloudConnectionsByTagsRequestBody body = new ListCloudConnectionsByTagsRequestBody();
        List<String> listTagsValues = new ArrayList<>();
        listTagsValues.add("value");
        List<MultivaluedTag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new MultivaluedTag()
                .withKey("key")
                .withValues(listTagsValues)
        );
        body.withTags(listbodyTags);
        request.withBody(body);
        try {
            ListCloudConnectionsByTagsResponse response = client.listCloudConnectionsByTags(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
31
32
33
34
35
36
37
38
39
40
41
42
# 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 = ListCloudConnectionsByTagsRequest()
        listValuesTags = [
            "value"
        ]
        listTagsbody = [
            MultivaluedTag(
                key="key",
                values=listValuesTags
            )
        ]
        request.body = ListCloudConnectionsByTagsRequestBody(
            tags=listTagsbody
        )
        response = client.list_cloud_connections_by_tags(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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

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

    request := &model.ListCloudConnectionsByTagsRequest{}
	var listValuesTags = []string{
        "value",
    }
	var listTagsbody = []model.MultivaluedTag{
        {
            Key: "key",
            Values: listValuesTags,
        },
    }
	request.Body = &model.ListCloudConnectionsByTagsRequestBody{
		Tags: listTagsbody,
	}
	response, err := client.ListCloudConnectionsByTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

通过标签过滤云连接实例成功。

错误码

请参见错误码