# 查询符合绑定条件的全域互联带宽列表 - ListSupportBindingConnectionBandwidths #### 功能介绍 查询符合绑定条件的全域互联带宽列表。 分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效，单独使用无效。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/doc?api=ListSupportBindingConnectionBandwidths&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cc/cc_02_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cc:gcbandwidth:listSupportBinding | List | gcbandwidth \* | - | cc:gcbandwidths:list | - | | cc:gcbandwidth:listSupportBinding | List | - | g:EnterpriseProjectId | cc:gcbandwidths:list | - | #### URI GET /v3/{domain_id}/gcb/gcbandwidths/support-bindings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 用户的账号ID，即租户ID，用于标识资源所属的华为云账号。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | - 参数解释：每页返回的个数，用于控制分页查询返回的记录数量。 - 约束限制：不涉及。 - 取值范围：1\~2000。 - 默认取值：2000。 | | marker | 否 | String | - 参数解释：翻页信息，从上次API调用返回的翻页数据中获取。可填写前一页marker或者后一页marker，填入前一页previous_marker就向前翻页，后一页next_marker就向后翻页。 - 约束限制：翻页过程中，查询条件不能修改，包括过滤条件、排序条件、limit。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | enterprise_project_id | 否 | Array of strings | 根据企业项目ID过滤列表。 | | local_area | 否 | String | - 参数解释：全域互联带宽的本端接入点编码，用于标识带宽实例的本端地理位置或接入站点。 - 约束限制：长度范围为1\~64个字符，必须通过查询站点列表接口获取有效的站点编码。如果是region类型，则返回所有满足条件的城域带宽，不进行该字段的匹配过滤；如果是其他类型，则会用该字段跟全域互联带宽的local_area进行匹配过滤。限制：local_area和remote_area同为空或者同不为空，且站点类型需一致。 - 取值范围：站点编码格式，通常为大区或区域的英文缩写。 - 默认取值：不涉及。 - 获取方式：调用查询站点列表接口 GET /v3/{domain_id}/ccaas/sites 获取可用的站点编码。 | | remote_area | 否 | String | - 参数解释：全域互联带宽的远端接入点编码，用于标识带宽实例的远端地理位置或接入站点。 - 约束限制：长度范围为1\~64个字符，必须通过查询站点列表接口获取有效的站点编码。如果是region类型，则返回所有满足条件的城域带宽，不进行该字段的匹配过滤；如果是其他类型，则会用该字段跟全域互联带宽的remote_area进行匹配过滤。限制：local_area和remote_area同为空或者同不为空，且站点类型需一致。 - 取值范围：站点编码格式，通常为大区或区域的英文缩写。 - 默认取值：不涉及。 - 获取方式：调用查询站点列表接口 GET /v3/{domain_id}/ccaas/sites 获取可用的站点编码。 附带过滤条件：会通过local_area和remote_area推算最佳全域互联带宽类型进行过滤查询 限制：local_area和remote_area同为空或者同不为空，且站点类型需一致 | | binding_service | 是 | String | 根据支持绑定实例类型过滤全域互联带宽列表。实例类型： - CC: 云连接 - GEIP: 全域弹性公网IP - GCN: 中心网络 - GSN: 分支网络 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，即用户的认证令牌，用于验证用户身份和权限。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | page_info | [PageInfo] object | 分页查询页的信息。 | | globalconnection_bandwidths | Array of [GlobalConnectionBandwidth] objects | 全域互联带宽列表响应体。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 向后分页标识符。 | | previous_marker | String | 向前分页标识符。 | | current_count | Integer | 当前列表中资源数量。 | 表6GlobalConnectionBandwidth | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | name | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | description | String | - 参数解释：实例的描述信息，用于记录实例的用途、归属部门等辅助信息。 - 约束限制：长度范围为0\~255个字符，不能包含"\<"和"\>"字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | domain_id | String | 实例所属账号ID。 | | bordercross | Boolean | 全域互联带宽跨境属性。 | | type | String | 功能说明：描述带宽类型，对应地理区间的城域、区域、大区、跨区四级： - TrsArea: 跨区带宽 - Area: 大区带宽 - SubArea: 区域带宽 - Region: 城域带宽 | | binding_service | String | - 参数解释：全域互联带宽绑定的服务类型，用于区分不同类型的云服务实例。 - 约束限制：不涉及。 - 取值范围： - CC: 云连接，用于实现跨区域网络互联 - GEIP: 全域弹性公网IP，用于提供全域访问能力 - GCN: 中心网络，用于构建企业级骨干网络 - GSN: 分支网络，用于连接分支机构 - ALL: 所有实例类型，表示支持所有类型的实例绑定 - 默认取值：不涉及。 | | enterprise_project_id | String | - 参数解释：实例所属的企业项目ID，用于标识资源所属的企业项目，实现企业内部资源的隔离和管理。 - 约束限制：最大长度不超过36字符，符合UUID格式或为字符串"0"。 - 取值范围：不涉及。 - 默认取值："0"表示默认企业项目。 | | charge_mode | String | 功能说明：描述计费类型，描述可选计费类型。默认开放按带宽计费，传统95计费租户白名单控制。 取值范围： - bwd: 按带宽计费 - 95: 按传统型95计费 - trf: 按流量计费 | | size | Integer | - 参数解释：全域互联带宽实例的带宽值大小，即网络连接的最大传输速率。 - 约束限制：必须为整数，支持步长调整，具体步长根据带宽类型和规格确定。 - 取值范围：2-300Mbit/s，不同带宽类型可能有不同的最小值和最大值限制。 - 默认取值：不涉及。 | | sla_level | String | 功能说明：描述网络等级，从高到低分为铂金、金、银。默认金，其余租户白名单控制。 - Pt: 铂金 - Au: 金 - Ag: 银 | | local_area | String | 功能说明：本端接入点的中英文名。通过HEADER里面的x-language控制，默认英文，zh-cn返回中文。 | | remote_area | String | 功能说明：远端接入点的中英文名。通过HEADER里面的x-language控制，默认英文，zh-cn返回中文。 | | local_site_code | String | - 参数解释：全域互联带宽的本端站点编码，用于标识本端的地理位置或接入站点。 - 约束限制：长度范围为1\~36个字符，必须通过查询站点列表接口获取有效的站点编码。 - 取值范围：站点编码格式，通常为站点的英文缩写。 - 默认取值：不涉及。 - 获取方式：调用查询站点列表接口 GET /v3/{domain_id}/ccaas/sites 获取可用的站点编码。 | | remote_site_code | String | - 参数解释：全域互联带宽的远端站点编码，用于标识远端的地理位置或接入站点。 - 约束限制：长度范围为1\~36个字符，必须通过查询站点列表接口获取有效的站点编码。 - 取值范围：站点编码格式，通常为站点的英文缩写。 - 默认取值：不涉及。 - 获取方式：调用查询站点列表接口 GET /v3/{domain_id}/ccaas/sites 获取可用的站点编码。 | | admin_state | String | - 参数解释：全域互联带宽的管理状态，用于标识带宽实例的启用或禁用状态。 - 约束限制：不涉及。 - 取值范围： - NORMAL: 正常状态，带宽实例正常运行，可以提供网络服务 - FREEZED: 冻结状态，带宽实例被冻结，暂时无法提供网络服务 - 默认取值：NORMAL。 | | frozen | Boolean | - 参数解释：全域互联带宽是否被冻结，用于标识带宽实例的可用性状态。 - 约束限制：不涉及。 - 取值范围： - true: 冻结状态，带宽实例被冻结，暂时无法提供网络服务 - false: 非冻结状态，带宽实例正常运行，可以提供网络服务 - 默认取值：false。 | | spec_code_id | String | - 参数解释：线路规格编码UUID，用于标识全域互联带宽的线路规格类型。 - 约束限制：长度为36个字符，符合UUID格式。 - 取值范围：不涉及。 - 默认取值：不涉及。 - 获取方式：调用查询线路规格接口获取可用的规格编码。 | | tags | Array of [Tag] objects | 实例标签。 | | created_at | String | - 参数解释：实例的创建时间，记录资源首次创建的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | updated_at | String | - 参数解释：实例的最后更新时间，记录资源最后一次被修改的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | directional_connections | Array of [DirectionalConnection] objects | 有向连接列表。 | | enable_share | Boolean | 功能说明: 全域互联带宽是否支持绑定多实例。 取值范围： - true-支持 - false-不支持 | | instances | Array of [GlobalConnectionBandwidthAssociatedInstance] objects | 功能说明: 全域互联带宽绑定实例列表。 | 表7Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | - 参数解释：标签键，用于标识和分类资源的标签属性名。 - 约束限制：最大长度128个unicode字符，不能为空，不能以空格开头或结尾，不能以"*sys*"开头。只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | value | String | - 参数解释：标签值，与标签键对应的标签属性值，用于提供更具体的资源分类信息。 - 约束限制：最大长度255个unicode字符，可以为空，只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符、斜杠"/"。 - 取值范围：不涉及。 - 默认取值：不涉及。 | 表8DirectionalConnection | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | local_site_code | String | - 参数解释：全域互联带宽的本端站点编码，用于标识本端的地理位置或接入站点。 - 约束限制：长度范围为1\~36个字符，必须通过查询站点列表接口获取有效的站点编码。 - 取值范围：站点编码格式，通常为站点的英文缩写。 - 默认取值：不涉及。 - 获取方式：调用查询站点列表接口 GET /v3/{domain_id}/ccaas/sites 获取可用的站点编码。 | | remote_site_code | String | - 参数解释：全域互联带宽的远端站点编码，用于标识远端的地理位置或接入站点。 - 约束限制：长度范围为1\~36个字符，必须通过查询站点列表接口获取有效的站点编码。 - 取值范围：站点编码格式，通常为站点的英文缩写。 - 默认取值：不涉及。 - 获取方式：调用查询站点列表接口 GET /v3/{domain_id}/ccaas/sites 获取可用的站点编码。 | 表9GlobalConnectionBandwidthAssociatedInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 绑定实例ID。 | | type | String | 绑定实例类型，有效值: - CC: 云连接 - GEIP: 全域弹性公网IP - GCN: 中心网络 - GSN: 分支网络 | | region_id | String | 绑定实例的region信息，global服务默认取值"global"。 | | project_id | String | 绑定实例的project id信息。 | #### 请求示例 查询符合绑定条件的全域互联带宽列表 ``` GET https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/support-bindings?binding_service=CC&local_area=site-def&remote_area=site-abc ``` #### 响应示例 **状态码：200** 查询全域互联带宽列表成功。 ``` { "request_id" : "61126320a1802d5c6444f9d2d76526c2", "globalconnection_bandwidths" : [ { "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "name" : "name", "description" : "description", "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76", "bordercross" : false, "type" : "Region", "binding_service" : "CC", "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0", "charge_mode" : "bwd", "size" : 100, "sla_level" : "Au", "local_area" : null, "remote_area" : null, "local_site_code" : "site-def", "remote_site_code" : "site-abc", "admin_state" : "NORMAL", "frozen" : false, "spec_code_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "tags" : [ ], "created_at" : "2024-01-24T08:26:41.914Z", "updated_at" : "2024-01-24T08:26:41.914Z", "enable_share" : false, "instances" : [ ], "directional_connections" : [ ] } ], "page_info" : { "next_marker" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "previous_marker" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "current_count" : 1 } } ``` #### 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 ListSupportBindingConnectionBandwidthsSolution { 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(); ListSupportBindingConnectionBandwidthsRequest request = new ListSupportBindingConnectionBandwidthsRequest(); try { ListSupportBindingConnectionBandwidthsResponse response = client.listSupportBindingConnectionBandwidths(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 = ListSupportBindingConnectionBandwidthsRequest() response = client.list_support_binding_connection_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) ``` - [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.ListSupportBindingConnectionBandwidthsRequest{} response, err := client.ListSupportBindingConnectionBandwidths(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=ListSupportBindingConnectionBandwidths&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询全域互联带宽列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cc/ErrorCode.html)。