Qin Ying, Fan 25ecbe8c03 ER API 20230411 version

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>

2024-01-16 13:22:29 +00:00

11 KiB

Raw Permalink Blame History

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
type	No	Array	You can query the quotas of the following resources: er_instance: Total and used quotas of enterprise routers vpc_attachment: Total and used quotas of VPC attachments 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 connect_attachment: Total and used quotas of Connect attachments. This type of attachments is not supported. dc_attachment: Total and used quotas of virtual gateway attachments. This type of attachments is not supported. vpn_attachment: Total and used quotas of VPN gateway attachments. This type of attachments is not supported. peering_attachment: Total and used quotas of peering connection attachments. This type of attachments is not supported. can_attachment: Total and used quotas of intelligent access gateway attachments. This type of attachments is not supported.
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

**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

Example Requests

Querying the resource quotas

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

Example Responses

Status code: 200

{
  "quotas" : [ {
    "quota_key" : "er_instance",
    "quota_limit" : 1,
    "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"
  } ]
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Quota Management

11 KiB Raw Permalink Blame History