Querying the RDS Capacity

Function

Query the allocated and remaining quantities of provisioned RDS instances with different specifications.

Precautions

Currently, this API can only be used to query data from RDS for SQL Server databases.

Calling Method

GET

URI

/rest/dataapi/homs/open-api/v1/CloudService/capacity

Path parameters

None

Query parameters

None

Request

• Request header parameters

  Parameter	Mandatory	Type	Value Range	Description
  X-APIG-Appcode	Yes	String	None	AppCode allocated by SRE
  x-auth-token	Yes	String	None	IAM authentication token for the calling party APIG
  x-hcso-domainid	Yes (HCS Online scenario) No (other scenarios)	String	None	ID of the accessed tenant.
  x-hcso-appcode	Yes	String	None	AppCode allocated by SRE

• Query parameters

  Parameter	Mandatory	Type	Value Range	Description
  begin_time	Yes	int	None	Start timestamp of the query, in milliseconds.
  end_time	Yes	int	None	End timestamp of the query, in milliseconds.
  service_type	No	String	RDS	Service type.
  zone_type	No	String	RDS_POD	RDS pod.
  page_size	Yes	int	0–1000	Page size.
  offset_value	Yes	int	None	Start value for the query.

• Request body parameters

  None

• Sample request

  GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=RDS HTTP/1.1 
  Host: example.com
  Content-Type: application/json 
  Accept: application/json
  X-APIG-Appcode: xxx 
  x-auth-token: xxx 
  x-hcso-domainid: xxx
  x-hcso-appcode: xxx

Response

• Response parameters

  Parameter	Type	Value Range	Description
  resource_type	string	None	Resource type
  available	String	None	How many RDS instances still remain
  az_name	string	None	AZ name
  used	Float64	None	Used resources
  used_ratio	Float64	None	Usage
  az_id	string	None	AZ ID
  service_type	String	None	Type of the cloud service to which the resource belongs. This parameter is fixed to RDS.
  total	Integer	None	How many RDS instances are available in total
  az_name_en	string	None	AZ name (English)
  metric_type	String	None	RDS metric type, for example, SQL Server relational DB instances or NoSQL Server non-relational DB instances.
  zone_type	String	None	Region to which resources belong, which is fixed to RDS_POD (a tenant zone).
  free	Float64	None	Remaining resources
  region	String	None	Name of the region to which resources belong
  resource_count	Float64	None	Total number of resources
  allocated	String	None	How many RDS instances have been allocated
  timestamp	Long	None	Timestamp

• Sample response

  HTTP/1.1 200  OK 
  Date:Tue,18 Jul 2023 09:58:01 GMT
  Server: example.com
  Content-Type: application/json;charset=UTF8 
  { 
      "total":33, 
      "list":[ 
              { 
              "resource_type": "",
              "available": "13.06640625",
               "az_name": "AZ 1",
              "used": "74.2802734375",
              "used_ratio": "0.40409390589222816",
              "az_id": "cn-north-213a",
              "service_type": "RDS",
              "total": "238.96484375",
              "az_name_en": "AZ1",
              "metric_type": "dbtype:sqlServer/nosqlServer",
              "zone_type": "MANAGE",
              "free": "109.5390625",
              "region": "cn-north-213",
              "resource_count": "1690",
              "allocated": "225.8984375",
              "timestamp": "1756742400000"
             }
            ]
  }

Status Codes