查询互联网关列表信息 - ListConnectGateways
功能介绍
查询互联网关列表信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
dcaas:connectGateway:list
List
connectGateway *
-
-
- eip:globalEips:list
- eip:geipSegments:list
- cc:gcbandwidths:list
URI
GET /v3/{project_id}/dcaas/connect-gateways
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取 约束限制: 不涉及 取值范围: 32 位十六进制字符(0-9, a-f, A-F) 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页返回的个数。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 2000 |
| offset | 否 | Integer | 参数解释: 分页偏移量 约束限制: 不涉及 取值范围: 1~1000 默认取值: 不涉及 |
| marker | 否 | String | 参数解释: 上一页最后一条资源记录的ID,为空时为查询第一页。 约束限制: 必须与limit一起使用。 取值范围: 长度不超过36个字符 默认取值: 不涉及 |
| page_reverse | 否 | Boolean | 参数解释: 是否反向查询。 约束限制: 必须与limit一起使用。 当page_reverse=true时,若要查询上一页,marker取值为当前页返回值的previous_marker。 取值范围: true:查询上一页。 false:查询下一页。 默认取值: false |
| fields | 否 | Array of strings | 参数解释: 显示字段列表,数组中每个字符串为虚拟接口对象的字段名(如 id、name、admin_state_up、bandwidth、status 等) 约束限制: 数组长度为1~5 取值范围: 不涉及 默认取值: 不涉及 |
| ext_fields | 否 | Array of strings | 参数解释: show response ext-fields 约束限制: 数组长度为0~5 |
| sort_key | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及 取值范围: 只能由字母、数字及连字符组成,长度不超过36个字符 默认取值: id |
| sort_dir | 否 | Array of strings | 参数解释: 返回结果按照升序(asc)或降序(desc)排列,默认为asc 约束限制: 不涉及 |
| id | 否 | Array of strings | 参数解释: 根据资源ID过滤实例。获取方式:可通过查询虚拟接口列表(ListVirtualInterfaces)接口获取 约束限制: 数组长度为1~5 |
| name | 否 | Array of strings | 参数解释: 根据名称过滤查询,可查询多个名称。 约束限制: 数组长度为1~5 |
| status | 否 | Array of strings | 参数解释: 根据资源状态过滤实例。可选状态值:ACTIVE、DOWN、BUILD、ERROR、PENDING_CREATE、PENDING_UPDATE、PENDING_DELETE、AUTHORIZATION、REJECTED 约束限制: 数组长度为1~5 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 获取Token,请参考《统一身份认证服务API参考》的「获取用户Token」章节。请求响应成功后在响应消息头中包含的「X-Subject-Token」的值即为Token值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 请求ID 取值范围: 不涉及 |
| connect_gateways | Array of ConnectGatewayResponse objects | 参数解释: 互联网关的详细信息对象 |
| total_count | Integer | 参数解释: 总记录数。 取值范围: 不涉及 |
| page_info | PageInfo object | 参数解释: 分页查询页的信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 唯一ID 取值范围: 不涉及 |
| tenant_id | String | 参数解释: 租户项目ID 取值范围: 不涉及 |
| name | String | 参数解释: 网关名称 取值范围: 不涉及 |
| description | String | 参数解释: 描述信息 取值范围: 不涉及 |
| address_family | String | 参数解释: 地址族信息 取值范围: |
| status | String | 参数解释: 网关状态 取值范围: 不涉及 |
| access_site | String | 参数解释: 网关站点值 取值范围: 不涉及 |
| bgp_asn | Long | 参数解释: BGP类型AS号 取值范围: 不涉及 |
| current_geip_count | Integer | 参数解释: 当前绑定的全域公网IP的数量 取值范围: 不涉及 |
| created_time | String | 参数解释: 创建时间 |
| updated_time | String | 参数解释: 更新时间 |
| gcb_id | String | 参数解释: 带宽包id 取值范围: 不涉及 |
| gateway_site | String | 参数解释: 网关位置 取值范围: 不涉及 |
请求示例
查询互联网关列表信息
GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/connect-gateways 响应示例
状态码:200
互联网关列表查询结果
{
"request_id" : "620dd1f696304f95a5d4fa4b9a21505e",
"connect_gateways" : [ {
"name" : "cgw-test",
"id" : "934aa302-5f1a-44c8-855b-20f715e2dbf3",
"description" : "",
"created_time" : "2024-12-12T06:12:15Z",
"updated_time" : null,
"tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
"status" : "DOWN",
"bgp_asn" : 139144,
"address_family" : "dual",
"access_site" : null,
"current_geip_count" : 0,
"gcb_id" : null,
"gateway_site" : null
} ],
"total_count" : 1,
"page_info" : {
"previous_marker" : "0ffe48a8-053a-483d-aa04-70f675eda4e6",
"current_count" : 1
}
} SDK代码示例
SDK代码示例如下。
Java
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 com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; 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.dc.v3.region.DcRegion; import com.huaweicloud.sdk.dc.v3.*; import com.huaweicloud.sdk.dc.v3.model.*; public class ListConnectGatewaysSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); ListConnectGatewaysRequest request = new ListConnectGatewaysRequest(); try { ListConnectGatewaysResponse response = client.listConnectGateways(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
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdc.v3.region.dc_region import DcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdc.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListConnectGatewaysRequest() response = client.list_connect_gateways(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
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dc.NewDcClient(hcClient) request := &model.ListConnectGatewaysRequest{} response, err := client.ListConnectGateways(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。