文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 虚拟igw/ 查询指定租户下的虚拟igw列表
更新时间:2024-08-15 GMT+08:00
分享

查询指定租户下的虚拟igw列表

功能介绍

查询指定租户下的虚拟igw列表

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/geip/vpc-igws

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

最小长度:1

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

fields

String

形式为"fields=id&fields=project_id&...",支持字段:id/project_id/vpc_id/created_at/updated_at/name

最小长度:0

最大长度:1024

id

String

最小长度:1

最大长度:36

project_id

String

租户id

最小长度:0

最大长度:32

vpc_id

String

虚拟igw所在的vpcid

最小长度:1

最大长度:36

name

String

虚拟igw的名称

最小长度:1

最大长度:255

sort_key

String

排序,形式为"sort_key=i2a_id&sort_dir=asc" 支持字段:id/created_at/updated_at

最小长度:0

最大长度:1024

sort_dir

String

排序方向 取值范围:asc、desc

最小长度:0

最大长度:1024

limit

Integer

每页返回的个数取值范围:0~[2000],其中2000为局点差异项,具体取值由局点决定

最小值:0

最大值:2000

offset

Integer

分页起始点

marker

String

分页起始点

最小长度:0

最大长度:36

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

vpc_igws

Array of VpcIgwsTenantResp objects

虚拟IGW列表对象

数组长度:0 - 999999

request_id

String

本次请求编号

最小长度:0

最大长度:36

表4 VpcIgwsTenantResp

参数

参数类型

描述

id

String

虚拟IGW的uuid

最小长度:0

最大长度:36

project_id

String

虚拟IGW的租户id

最小长度:0

最大长度:32

vpc_id

String

虚拟IGW的vpcid

最小长度:0

最大长度:64

name

String

虚拟IGW的名称

最小长度:0

最大长度:255

created_at

String

创建时间

最小长度:0

最大长度:64

updated_at

String

更新时间

最小长度:0

最大长度:64

network_id

String

创建IGW使用的VPC具体子网

最小长度:0

最大长度:64

enable_ipv6

Boolean

是否使能IPV6

请求示例

查询指定租户下的虚拟igw列表

GET https://{Endpoint}/v3/{project_id}/geip/vpc-igws

响应示例

状态码: 200

GET操作正常返回

{
  "vpc_igws" : [ {
    "id" : "33866d83-e3eb-4380-b58d-525a47031435",
    "name" : "sd",
    "project_id" : "034627a12266434b891d718239c93380",
    "network_id" : "c88b8567-bd23-4e75-9257-b3052bd51bc2",
    "enable_ipv6" : false,
    "created_at" : "2021-07-07T13:10:19",
    "updated_at" : "2021-07-07T13:10:19",
    "vpc_id" : "c88b8567-bd23-4e75-9257-b3052bd51bc1"
  } ],
  "request_id" : "6d81f3f0-1c4a-4fba-aaca-1b9e762125d4"
}

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
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.eip.v3.region.EipRegion;
import com.huaweicloud.sdk.eip.v3.*;
import com.huaweicloud.sdk.eip.v3.model.*;


public class ListTenantVpcIgwsSolution {

    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);

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTenantVpcIgwsRequest request = new ListTenantVpcIgwsRequest();
        request.withFields("<fields>");
        request.withId("<id>");
        request.withVpcId("<vpc_id>");
        request.withName("<name>");
        request.withSortKey("<sort_key>");
        request.withSortDir("<sort_dir>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withMarker("<marker>");
        try {
            ListTenantVpcIgwsResponse response = client.listTenantVpcIgws(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v3.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.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 = "&lt;project_id&gt;"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ListTenantVpcIgwsRequest()
        request.fields = "<fields>"
        request.id = "<id>"
        request.vpc_id = "<vpc_id>"
        request.name = "<name>"
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        request.limit = <limit>
        request.offset = <offset>
        request.marker = "<marker>"
        response = client.list_tenant_vpc_igws(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
48
49
50
51
52
53
54
55
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/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 := "&lt;project_id&gt;"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTenantVpcIgwsRequest{}
	fieldsRequest:= "<fields>"
	request.Fields = &fieldsRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	vpcIdRequest:= "<vpc_id>"
	request.VpcId = &vpcIdRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= "<sort_dir>"
	request.SortDir = &sortDirRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListTenantVpcIgws(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码

相关文档