更新时间:2024-03-30 GMT+08:00
分享

查询VPC连接列表

功能介绍

查询企业路由器实例下的VPC连接列表。

接口约束

  • 支持过滤查询,过滤条件有id,state,enterprise_project_id,vpc_id,过滤条件可以重复和组合。

  • 支持分页查询,limit和marker组合实现分页查询。

  • 支持单字段排序功能,排序字段有[id,name,description,created_at,updated_at],不支持多字段排序。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

er_id

String

企业路由器实例ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。 取值范围:0~2000。

最小值:0

最大值:2000

marker

String

查询的页码id,为空时为查询第一页。 使用说明:必须与limit一起使用。

最小长度:1

最大长度:128

state

Array

连接状态:pending|available|modifying|deleting|deleted|failed|pending_acceptance|rejected|initiating_request

id

Array

根据资源ID查询,可同时查询多个。

sort_key

Array

按关键字排序,默认按照id排序,可选值:id|name|state

sort_dir

Array

返回结果按照升序或降序排列,默认为asc,降序为desc

vpc_id

Array

VPC id

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

vpc_attachments

Array of VpcAttachmentDetails objects

VPC连接列表

page_info

PageInfo object

分页查询的信息

request_id

String

请求ID

表4 VpcAttachmentDetails

参数

参数类型

描述

id

String

VPC连接ID

name

String

VPC连接名称

vpc_id

String

VPC id

virsubnet_id

String

VPC子网id

auto_create_vpc_routes

Boolean

默认为false,当设置true时,会自动为VPC配置10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16三条路由,下一跳指向企业路由器。

缺省值:false

state

String

VPC连接状态:pending|available|modifying|deleting|deleted|failed|initiating_request|rejected|pending_acceptance|freezed

created_at

String

创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

String

更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

tags

Array of Tag objects

标签信息

description

String

VPC连接描述信息

project_id

String

项目ID

vpc_project_id

String

vpc所属项目ID

表5 Tag

参数

参数类型

描述

key

String

标签键,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • _sys_开头属于系统标签,租户不能输入。

  • 标签key不能为空(长度不能为0)。

  • 长度在1-128之间。

最小长度:1

最大长度:128

value

String

标签值,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • 资源标签值可以为空(empty or null)。

  • 长度在0-255之间。

最小长度:0

最大长度:255

表6 PageInfo

参数

参数类型

描述

next_marker

String

下一个marker标识,为空时表示最后一页

current_count

Integer

当前列表中资源数量

请求示例

  • 分页查询VPC连接信息

    GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments?limit=10
  • 查询全量VPC连接信息

    GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments

响应示例

状态码: 200

OK

{
  "vpc_attachments" : [ {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "name" : "vpc-attach-01",
    "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
    "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "state" : "available",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z"
  }, {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "name" : "vpc-attach-01",
    "vpc_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f",
    "virsubnet_id" : "2b55f334-a15e-43a9-ab11-b34c2dbb6fac",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "state" : "available",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z"
  } ],
  "page_info" : {
    "next_marker" : "1",
    "current_count" : 2
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

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

import java.util.List;
import java.util.ArrayList;

public class ListVpcAttachmentsSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ErClient client = ErClient.newBuilder()
                .withCredential(auth)
                .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                .build();
        ListVpcAttachmentsRequest request = new ListVpcAttachmentsRequest();
        request.withVpcId();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withState();
        request.withId();
        request.withSortKey();
        request.withSortDir();
        try {
            ListVpcAttachmentsResponse response = client.listVpcAttachments(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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdker.v3.region.er_region import ErRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdker.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 = BasicCredentials(ak, sk) \

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

    try:
        request = ListVpcAttachmentsRequest()
        request.vpc_id = 
        request.limit = <limit>
        request.marker = "<marker>"
        request.state = 
        request.id = 
        request.sort_key = 
        request.sort_dir = 
        response = client.list_vpc_attachments(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/basic"
    er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := er.NewErClient(
        er.ErClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListVpcAttachmentsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListVpcAttachments(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品