文档首页> 云连接 CC> API参考> API> 域间带宽> 查询域间带宽列表
更新时间:2024-03-29 GMT+08:00
分享

查询域间带宽列表

功能介绍

查询域间带宽列表。 分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。

调用方法

请参见如何调用API

URI

GET /v3/{domain_id}/ccaas/inter-region-bandwidths

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账户ID。

最小长度:10

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。 取值范围:1~1000。

最小值:1

最大值:1000

缺省值:1000

marker

String

翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向翻页。 翻页过程中,查询条件不能修改,包括过滤条件,排序条件,limit。

最小长度:1

最大长度:4096

id

Array

根据id查询,可查询多个id。

数组长度:1 - 20

enterprise_project_id

Array

根据企业项目ID过滤列表。

数组长度:1 - 20

cloud_connection_id

Array

根据云连接的ID过滤列表。

数组长度:1 - 20

bandwidth_package_id

Array

根据带宽包列表过滤域间带宽实例列表。

数组长度:1 - 10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

最小长度:0

最大长度:2000000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

资源ID标识符。

最小长度:32

最大长度:36

page_info

PageInfo object

分页查询页的信息。

inter_region_bandwidths

Array of InterRegionBandwidth objects

域间带宽实例列表。

数组长度:0 - 2000

表5 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。

最小长度:1

最大长度:4096

previous_marker

String

向前分页标识符。

最小长度:1

最大长度:4096

current_count

Integer

当前列表中资源数量。

最小值:0

最大值:2000

表6 InterRegionBandwidth

参数

参数类型

描述

id

String

资源ID标识符。

name

String

实例名字。

description

String

实例描述。不支持 <>。

最小长度:0

最大长度:255

domain_id

String

实例所属账号ID。

created_at

String

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

updated_at

String

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

cloud_connection_id

String

资源ID标识符。

bandwidth_package_id

String

资源ID标识符。

inter_regions

Array of InterRegion objects

域间实例信息。

数组长度:2 - 2

bandwidth

Integer

域间带宽的值。

最小值:1

最大值:999999

表7 InterRegion

参数

参数类型

描述

id

String

资源ID标识符。

project_id

String

实例所属项目ID。

local_region_id

String

域间实例本端的RegionID。

最小长度:0

最大长度:36

remote_region_id

String

域间实例对端的RegionID。

最小长度:0

最大长度:36

请求示例

查询域间带宽实例列表

GET https://{cc_endpoint}/v3/{domain_id}/ccaas/inter-region-bandwidths

响应示例

状态码: 200

查询域间带宽实例列表成功。

{
  "request_id" : "fd403735e22a5213845afbf69425a976",
  "inter_region_bandwidths" : [ {
    "id" : "XXX",
    "name" : "",
    "description" : "",
    "domain_id" : "XXX",
    "created_at" : "2023-09-20T11:41:53Z",
    "updated_at" : "2023-09-20T11:41:53Z",
    "bandwidth_package_id" : "XXX",
    "cloud_connection_id" : "XXX",
    "bandwidth" : 5,
    "inter_regions" : [ {
      "id" : "XXX",
      "project_id" : "",
      "local_region_id" : "region_a",
      "remote_region_id" : "region_b"
    }, {
      "id" : "XXX",
      "project_id" : "",
      "local_region_id" : "region_b",
      "remote_region_id" : "region_a"
    } ]
  } ],
  "page_info" : {
    "previous_marker" : "XXX",
    "current_count" : 1
  }
}

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
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 ListInterRegionBandwidthsSolution {

    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();
        ListInterRegionBandwidthsRequest request = new ListInterRegionBandwidthsRequest();
        request.withBandwidthPackageId();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withId();
        request.withEnterpriseProjectId();
        request.withCloudConnectionId();
        try {
            ListInterRegionBandwidthsResponse response = client.listInterRegionBandwidths(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

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

    try:
        request = ListInterRegionBandwidthsRequest()
        request.bandwidth_package_id = 
        request.limit = <limit>
        request.marker = "<marker>"
        request.id = 
        request.enterprise_project_id = 
        request.cloud_connection_id = 
        response = client.list_inter_region_bandwidths(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
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.ListInterRegionBandwidthsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListInterRegionBandwidths(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询域间带宽实例列表成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品