Querying the DeH Capacity
Function
Query the allocated and remaining quantities of provisioned DeHs with different specifications.
SLA Item |
Definition |
---|---|
Request success rate |
≥ 99% |
Availability |
Tier 2 |
Data consistency |
Strongly consistent |
Throughput |
60 times/minute |
TP50 request latency |
200 ms |
TP99.9 request latency |
300 ms |
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
DeH
Service type.
zone_type
No
String
DeH_POD
DeH 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=DeH 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 deh.
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 DeH_POD (a tenant zone).
total (in the list section)
No
String
None
How many dedicated hosts or servers are available in total.
allocated
Yes
String
None
How many dedicated hosts or servers have been allocated.
metric_type
No
String
None
DeH specifications type, for example, the S and X series.
avaliable
Yes
String
None
How many dedicated hosts or servers 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":33, "list":[ { "service_type":"deh", "metric_type": "DeH flavor type: s3/l5", "total":"Total number", "used":"Used capacity", "free":"Remaining capacity", "allocated":"Allocatable capacity", "available":"Available capacity", "used_ratio":"Usage", "allocated_ratio":"Allocation rate", "resource_count":"null", "zone_type":"DEH_POD", "timestamp":"timestamp", "region":"cn-north-1" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Operation successful. |
400 |
Parameter error. |
401 |
Token authentication failed. |
403 |
Authentication failed. |
404 |
The REST API was not found. |
500 |
An internal application error occurred. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot