Files
doc-exports/docs/er/api-ref/ShowQuotas.html
fanqinying 2eea95ac58 ER API 20250126 version
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2025-06-24 08:13:54 +00:00

14 KiB

Querying Quotas

Function

This API is used to query the used quotas of resources, such as enterprise routers and VPC attachments.

URI

GET /v3/{project_id}/enterprise-router/quotas

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page. Value range: 0 to 2000

Minimum: 0

Maximum: 2000

marker

No

String

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

Minimum: 1

Maximum: 128

type

No

Array of strings

Quota types that can be filtered:

  • er_instance: Total and used quotas of enterprise routers.

  • vpc_attachment: Total and used quotas of VPC attachments.

  • vpn_attachment: Total and used quotas of VPN gateway attachments.

  • peering_attachment: Total and used quotas of peering connection attachments. This type is not supported.

  • can_attachment: Total and used quotas of intelligent access gateway attachments. This type is not supported.

  • connect_attachment: Total and used quotas of Connect attachments. This type is not supported.

  • multicast_domain: Total and used quotas of multicast domains. This type is not supported.

  • multicast_domain_association: Total and used quotas of multicast domain associations. This type is not supported.

  • route_table: Total and used quotas of route tables.

  • static_route: Total and used quotas of static routes.

  • vpc_er: Total and used quotas of enterprise routers that a VPC can be attached to.

  • flow_log: Total and used quotas of flow logs that can be created for each attachment.

erId

No

Object

Enterprise router ID

routeTableId

No

Object

Route table ID

vpcId

No

Object

VPC ID

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

quotas

Array of Quota objects

Used quota details

page_info

PageInfo object

Pagination query information

Table 4 Quota

Parameter

Type

Description

quota_key

String

Quota type

quota_limit

Long

Available quota. The value -1 indicates that there is no quota limit.

used

Long

Used quota

unit

String

Measurement unit of used quotas

Table 5 PageInfo

Parameter

Type

Description

next_marker

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

Integer

Number of resources in the list

Example Requests

Querying the resource quotas

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

Example Responses

Status code: 200

OK

{
  "quotas" : [ {
    "quota_key" : "er_instance",
    "quota_limit" : 1,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "vpc_attachment",
    "quota_limit" : 2,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "dc_attachment",
    "quota_limit" : 2,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "route_table",
    "quota_limit" : 20,
    "used" : 5,
    "unit" : "count"
  }, {
    "quota_key" : "static_route",
    "quota_limit" : 500,
    "used" : 2,
    "unit" : "count"
  }, {
    "quota_key" : "can_attachment",
    "quota_limit" : 10,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "connect_attachment",
    "quota_limit" : 20,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "peering_attachment",
    "quota_limit" : 10,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "vpn_attachment",
    "quota_limit" : 10,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "flow_log",
    "quota_limit" : 20,
    "used" : 4,
    "unit" : "count"
  } ],
  "page_info" : {
    "next_marker" : "1",
    "current_count" : 9
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.