Querying the EIP Capacity

Function

Query the total, allocated, and remaining quantities of EIPs.

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	EIP	Service type
  zone_type	No	string	EIP_POD	EIP 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=EIP 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 EIP.
  timestamp	Yes	Long	None	Timestamp
  region	Yes	String	None	Name of the region to which resources belong
  zone_type	No	String	None	Indicates the type of the region to which the resource belongs. The value can be EIP_POD.
  total (in the list section)	No	String	None	How many EIPs are available in total
  allocated	Yes	String	None	How many EIPs have been allocated
  avaliable	Yes	String	None	How many EIPs still remain

• 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": "EIP", 
               "total": "490", 
               "available": "132", 
               "metric_type": "5_bgp", 
               "zone_type": "EIP_POD", 
               "used": "0", 
               "free": "0", 
               "used_ratio": "0", 
               "region": "cn-east-264", 
               "resource_count": "0", 
               "allocated": "358", 
               "timestamp": "1650211200000" 
               } 
             ] 
  }

Status Codes