文档首页/ 云专线 DC/ API参考/ API/ 互联网关/ 查询互联网关详细信息
更新时间:2024-12-27 GMT+08:00
分享

查询互联网关详细信息

功能介绍

查询互联网关详细信息

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/dcaas/connect-gateways/{connect_gateway_id}

表1 路径参数

参数

是否必选

参数类型

描述

connect_gateway_id

String

互联网关ID

project_id

String

租户项目ID

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

connect_gateway

ConnectGatewayResponse object

互联网关的相信信息对象

表4 ConnectGatewayResponse

参数

参数类型

描述

id

String

唯一ID

tenant_id

String

租户项目ID

name

String

网关名字

description

String

描述信息

address_family

String

地址族信息

  • ipv4: 仅支持ipv4模式

  • dual: 支持ipv4 和 ipv6 模式

status

String

网关状态

  • DOWN 未使用或关联设备状态为DOWN

  • ACTIVE 正常

  • ERROR 异常

access_site

String

网关站点值

bgp_asn

Long

BGP类型AS号

current_geip_count

Integer

当前绑定的global eip数量

created_time

String

创建时间

updated_time

String

更新时间

gcb_id

String

带宽包id

gateway_site

String

网关位置

请求示例

查询互联网关详细信息

GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/connect-gateways/934aa302-5f1a-44c8-855b-20f715e2dbf3

响应示例

状态码: 200

OK

  • 互联网关详情查询结果

    {
      "request_id" : "ecf6442668da7d4adf0dfaf4bded8840",
      "connect_gateway" : {
        "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
      }
    }

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

    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();
        ShowConnectGatewayRequest request = new ShowConnectGatewayRequest();
        request.withConnectGatewayId("{connect_gateway_id}");
        try {
            ShowConnectGatewayResponse response = client.showConnectGateway(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
# 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 = ShowConnectGatewayRequest()
        request.connect_gateway_id = "{connect_gateway_id}"
        response = client.show_connect_gateway(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowConnectGatewayRequest{}
	request.ConnectGatewayId = "{connect_gateway_id}"
	response, err := client.ShowConnectGateway(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档