Liu, Siying 61db61b4e5 CTS API 20230612 version.

Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>

2024-04-18 10:17:02 +00:00

26 KiB

Raw Permalink Blame History

Querying Tenant Quota Information

Function

This API is used to querying tenant quota Information.

URI

GET /v3/{project_id}/quotas

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining an Account ID and Project ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameter
Parameter	Type	Description
resources	Array of Quota objects	List of tracker information.

**Table 3** Quota
Parameter	Type	Description
type	String	Quota resource type.
used	Long	Number of used resources.
quota	Long	Total number of resources.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 503

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Example Request

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

Example Response

Status code: 200

The request is successful.

{
    "resources": [
        {
            "quota": 1,
            "used": 1,
            "type": "system_tracker"
        },
        {
            "quota": 100,
            "used": 2,
            "type": "smn_notification"
        }
    ]
}

Status Code

Status Code	Description
200	The request is successful.
400	The server failed to process the request.
401	The request is rejected due to authentication failure.
403	The server understood the request but refused to authorize it.
404	The requested resource does not exist.
500	Failed to complete the request because of an internal service error.
503	The requested service is invalid. The client should not repeat the request without modifications.

Error Code

For details, see Error Codes.

Parent topic: Other APIs

26 KiB Raw Permalink Blame History