Querying the OBS Capacity

Function

Query the total, allocated, and available OBS capacities.

Precautions

None

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	OBS	Service type
  zone_type	No	string	OBS_POD	OBS pod
  page_size	Yes	int	0~1000	Page size
  offset_value	Yes	int	None	Query start value

• Request body parameters

  None

• Sample request

  GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=OBS 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	Mandatory	Type	Value Range	Description
  code	Yes	String	None	Return code
  msg	Yes	String	None	Returned message
  total	Yes	Integer	None	Data records
  service_type	No	String	None	Cloud service name, which identifies the cloud service to which resources belong. For this API, the value can be OBS.
  timestamp	Yes	Long	None	Timestamp
  region	Yes	String	None	Name of the region to which resources belong
  zone_type	No	String	None	OBS is globally deployed and is not associated with an AZ.
  allocated	Yes	String	None	What storage space in TB has been allocated
  avaliable	Yes	String	None	What storage space in TB still remains
  metric_type	No	String	None	OBS resource type, which can be a single-AZ or multi-AZ architecture

• 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": 1, 
      "list": [ 
               { 
               "service_type": "OBS", 
               "total": "80", 
               "available": "0", 
               "metric_type": "a", 
               "zone_type": "OBS_POD", 
               "used": "20", 
               "free": "0", 
               "used_ratio": "0", 
               "region": "cn-east-264", 
               "resource_count": "0", 
               "allocated": "0", 
               "timestamp": "1649865600000" 
               } 
             ] 
  }

Status Codes