Querying the VPN Capacity

Function

Query resource capacities of the VPN service, such as the quantities of VPN connections and VPN gateways.

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	VPN	Service type.
  zone_type	No	String	VPN_POD	VPN 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=VPN 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 VPN.
  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 VPN_POD (a tenant zone).
  total (in the list section)	No	String	None	How many VPN connections and gateways are available in total.
  allocated	Yes	String	None	How many VPN connections and gateways have been allocated.
  metric_type	No	String	None	VPN capacity metric, which can be the number of VPN connections or the number of gateways.
  avaliable	Yes	String	None	How many VPN connections and gateways 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": 2, 
      "list": [ 
               { 
               "service_type": "VPN", 
               "total": "0", 
               "available": "0", 
               "metric_type": "connection", 
               "zone_type": "VPN_POD", 
               "used": "0", 
               "free": "0", 
               "used_ratio": "0", 
               "region": "cn-east-264", 
               "resource_count": "0", 
               "allocated": "0", 
               "timestamp": "1650211200000" 
                }, 
               { 
               "service_type": "VPN", 
               "total": "5", 
               "available": "5", 
               "metric_type": "gateway", 
               "zone_type": "VPN_POD", 
               "used": "0", 
               "free": "0", 
               "used_ratio": "0", 
               "region": "cn-east-264", 
               "resource_count": "0", 
               "allocated": "0", 
               "timestamp": "1650211200000" 
                } 
              ] 
  }

Status Codes