Querying the SFS Capacity

Function

Query the total, used, and remaining capacities of the SFS service.

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	SFS	Service type.
  zone_type	No	String	SFS_POD	SFS 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=SFS 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	Response code.
  msg	Yes	String	None	Response message.
  total	Yes	Integer	None	Number of data records.
  service_type	No	String	None	Type of the cloud service to which the resource belongs. This parameter is fixed to SFS.
  timestamp	Yes	Long	None	Timestamp.
  region	Yes	String	None	Name of the region to which resources belong.
  zone_type	No	String	None	Region to which resources belong, which is fixed to SFS_POD (a tenant zone).
  total (in the list section)	No	String	None	What SFS storage space in TB is available in total.
  allocated	Yes	String	None	What storage space in TB has been allocated.
  metric_type	No	String	None	SFS specifications type, which does not include backend specifications as virtual storage space is used.
  avaliable	Yes	String	None	What storage space in TB still remains.

• 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":[ 
              { 
              "service_type":"sfs", 
              "metric_type":"null", 
  "total":"Total capacity, in TB",
  "used":"Used capacity",
  "free":"Remaining capacity",
  "allocated":"Allocatable capacity",
  "available":"Available capacity",
  "used_ratio":"Usage",
  "allocated_ratio":"Allocation rate",
              "resource_count":"null", 
              "zone_type":"SFS_POD", 
  "timestamp":"timestamp",
              "region":"cn-north-1" 
               }
             ]
  }

Status Codes