Wei, Hongmin 8ce662c4dc CSBS API initial version

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>

2022-10-24 21:06:50 +00:00

14 KiB

Raw Permalink Blame History

Querying Quotas

Function

This API is used to query tenant quotas.

URI

URI format
GET https://{endpoint}/v1/{project_id}/quotas
Parameter description
Table 1 Parameter description
Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request

Parameter description
None

Example request

GET https://{endpoint}/v1/{project_id}/quotas

Response

Parameter description
Table 2 Parameter description
Parameter

Type

Description

quotas

quota

See the quota field description.
Parameter description of field quota
Table 3 Parameter description of field quota
Parameter

Type

Description

resources

List<resource_resp>

Quota resources

**Table 2** Parameter description
Parameter	Type	Description
quotas	quota	See the quota field description.

**Table 3** Parameter description of field **quota**
Parameter	Type	Description
resources	List<resource_resp>	Quota resources

Parameter description of field resource_resp

**Table 4** Parameter description of field **resource_resp**
Parameter	Type	Description
unit	String	Unit
used	Integer	Used quota
quota	Integer	Quota size
type	String	Type backup_capacity specifies the backup storage capacity quota. Value -1 indicates no restriction on the quota size. backups specifies the number of retained backups.

Example response

{
  "quotas" : {
    "resources" : [{
      "type" : "backup_capacity",
      "unit" : "GB",
      "quota" : -1,
      "used" : 0
    },
    {
        "used": 0,
        "type": "backups",
        "quota": 600
    }]
  }
}

Status Codes

Normal
Status Code

Description

200

OK

Status Code	Description
200	OK

Abnormal

Status Code	Description
400	Invalid request parameters.
401	Authentication failed.
403	No operation permission.
404	Requested object not found.
500	Service internal error.
503	Service unavailable.

Error Codes

For details, see Error Codes.

Parent topic: Quota Management

14 KiB Raw Permalink Blame History