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

查询指定租户下的共享带宽类型列表

功能介绍

查询指定租户下的共享带宽类型列表

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/eip/share-bandwidth-types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

fields

String

  • 功能说明:查询字段,形式为"fields=id&fields=bandwidth_type&..."

  • 支持字段:id/bandwidth_type/name_en/name_zh/created_at/update_at/public_border_group/description

最小长度:0

最大长度:1024

id

String

  • 功能说明:支持带宽类型的id

最小长度:0

最大长度:36

bandwidth_type

String

  • 功能说明:带宽支持类型

最小长度:1

最大长度:36

name_en

String

  • 功能说明:带宽类型英文表述

最小长度:0

最大长度:256

name_zh

String

  • 功能说明:带宽类型中文表述

最小长度:0

最大长度:256

public_border_group

String

  • 功能说明:带宽类型所处位置,中心站点or边缘站点

最小长度:0

最大长度:36

sort_key

String

  • 功能说明:排序字段,形式为"sort_key=id&sort_dir=asc"

  • 支持字段:id/bandwidth_type/public_border_group

最小长度:0

最大长度:1024

sort_dir

String

  • 功能说明:排序方向

  • 取值范围:asc、desc

最小长度:0

最大长度:1024

limit

Integer

  • 功能说明:每页返回的个数

  • 取值范围:0~[2000],其中2000为局点差异项,具体取值由局点决定

最小值:0

最大值:2000

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

share_bandwidth_types

Array of ShareBandwidthTypeShowResp objects

共享带宽类型对象

数组长度:0 - 9999

request_id

String

本次请求的编号

page_info

PageInfoOption object

分页页码信息

表4 ShareBandwidthTypeShowResp

参数

参数类型

描述

id

String

支持带宽类型的id

最小长度:0

最大长度:36

bandwidth_type

String

带宽类型

最小长度:0

最大长度:36

public_border_group

String

中心站点or边缘站点,默认展示

最小长度:0

最大长度:64

created_at

String

创建时间

最小长度:0

最大长度:64

updated_at

String

更新时间

最小长度:0

最大长度:64

name_en

String

带宽类型的英文表述

最小长度:0

最大长度:256

name_zh

String

带宽类型的中文表述

最小长度:0

最大长度:256

description

String

带宽类型描述信息

最小长度:0

最大长度:1024

表5 PageInfoOption

参数

参数类型

描述

previous_marker

String

翻页时,作为前一页的marker取值

最小长度:0

最大长度:36

next_marker

String

翻页时,作为后一页的marker取值

最小长度:0

最大长度:36

current_count

Integer

当前页的数据总数

最小值:0

最大值:99999

请求示例

查询租户支持的共享带宽类型列表

GET https://{Endpoint}/v3/{project_id}/eip/share-bandwidth-types

响应示例

状态码: 200

GET操作正常返回

{
  "share_bandwidth_types" : [ {
    "id" : "1b478471-eaf1-4a71-9c77-edba89f62016",
    "bandwidth_type" : "share",
    "name_en" : "share_bandwidth_type",
    "name_zh" : "中心带宽类型",
    "description" : null,
    "created_at" : "2021-09-29T04:19:22Z",
    "updated_at" : "2021-09-29T04:19:22Z",
    "public_border_group" : "center"
  }, {
    "id" : "2bbb2990-e908-46a7-b664-03d3084af032",
    "bandwidth_type" : "edgeshare",
    "name_en" : "edge_share_bandwidth_type",
    "name_zh" : "边缘带宽类型",
    "description" : null,
    "created_at" : "2021-09-29T04:19:22Z",
    "updated_at" : "2021-09-29T04:19:22Z",
    "public_border_group" : "az1"
  } ],
  "request_id" : "07f05e3d-b688-43f8-bda2-e9d10d2352e9",
  "page_info" : {
    "previous_marker" : "1b478471-eaf1-4a71-9c77-edba89f62016",
    "current_count" : 2
  }
}

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


public class ListShareBandwidthTypesSolution {

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

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        ListShareBandwidthTypesRequest request = new ListShareBandwidthTypesRequest();
        request.withFields("<fields>");
        request.withId("<id>");
        request.withBandwidthType("<bandwidth_type>");
        request.withNameEn("<name_en>");
        request.withNameZh("<name_zh>");
        request.withPublicBorderGroup("<public_border_group>");
        request.withSortKey("<sort_key>");
        request.withSortDir("<sort_dir>");
        request.withLimit(<limit>);
        try {
            ListShareBandwidthTypesResponse response = client.listShareBandwidthTypes(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
# 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ListShareBandwidthTypesRequest()
        request.fields = "<fields>"
        request.id = "<id>"
        request.bandwidth_type = "<bandwidth_type>"
        request.name_en = "<name_en>"
        request.name_zh = "<name_zh>"
        request.public_border_group = "<public_border_group>"
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        request.limit = <limit>
        response = client.list_share_bandwidth_types(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
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")

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

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

    request := &model.ListShareBandwidthTypesRequest{}
	fieldsRequest:= "<fields>"
	request.Fields = &fieldsRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	bandwidthTypeRequest:= "<bandwidth_type>"
	request.BandwidthType = &bandwidthTypeRequest
	nameEnRequest:= "<name_en>"
	request.NameEn = &nameEnRequest
	nameZhRequest:= "<name_zh>"
	request.NameZh = &nameZhRequest
	publicBorderGroupRequest:= "<public_border_group>"
	request.PublicBorderGroup = &publicBorderGroupRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= "<sort_dir>"
	request.SortDir = &sortDirRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	response, err := client.ListShareBandwidthTypes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码

相关文档