Querying Resource Provisioning Information
Function
This API is used to query resource provisioning information and query order details based on the project ID.
URI
GET /v1/{project_id}/period/product/specification
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| orderInfos | Array of ProductOrderInfo objects | Order list |
| Parameter | Type | Description |
|---|---|---|
| tenantId | String | Tenant ID |
| periodType | String | Subscription period type |
| periodNum | Integer | Subscription periods |
| resourceId | String | Resource ID |
| productInfo | ProductInfo object | Product details. |
| Parameter | Type | Description |
|---|---|---|
| allResourceNames | Array of strings | Resource list. |
| cloudServiceType | String | Cloud service type. |
| displayId | String | Display ID. |
| productId | String | Product ID. |
| productSpecDesc | String | Product specification description. |
| resourceName | String | Resource name. |
| resourceSize | Integer | Number of databases supported by the product or the number of OBS scans supported by the product. |
| resourceSizeMeasureId | Integer | Resource capacity measurement ID. The example values are as follows: 15: mbps (used when bandwidth is purchased), 17: gb (used when EVS disks are purchased), 14: number/time. |
| resourceSpecCode | String | Product code. |
| resourceType | String | Resource type. |
| usageFactor | String | Coefficient in use. |
| usageMeasureId | Integer | Capacity measurement ID in use. |
| usageValue | Double | Value in use. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error Code |
| error_msg | String | Error Message |
Example Requests
Query resource provisioning information.
GET /v1/{project_id}/period/product/specification Example Responses
Status code: 200
Request sent
{
"orderInfos" : [ {
"tenantId" : "xxxxxxxxxxxx",
"periodType" : 2,
"periodNum" : 1,
"resourceId" : "xxxxxxxxxxxx",
"productInfo" : {
"cloudServiceType" : "hws.service.type.sdg",
"productId" : "xxxxxxxxxxxx",
"resourceSize" : 30,
"resourceSizeMeasureId" : 30,
"resourceSpecCode" : "base_professional",
"resourceType" : "hws.resource.type.dsc.base"
}
} ]
} Status code: 400
Invalid request.
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Request sent |
| 400 | Invalid request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
