Obtaining the Instance List
Function
Obtaining the instance list
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/instances
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Maximum number of data connections that can be queried each time. The default value is 20. |
| offset | No | Integer | Pagination offset. The default value is 0. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. This parameter is mandatory for token authentication. Call the "Obtaining the User Token" API of IAM to obtain the value of X-Subject-Token in the response header. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| billing_check | Boolean | Whether a bill is required |
| count | Integer | Number of all returned records |
| commodity_orders | Array of ApigCommodityOrder objects | Go to the instance list. |
| Parameter | Type | Description |
|---|---|---|
| project_id | String | ID of the project to which the instance belongs. For details about how to obtain the project ID, see Project ID and Account ID. |
| order_id | String | Order ID |
| region_id | String | Call the "Querying the Region List" API of ManageOneIAM to obtain the region ID in the response message. |
| resource_id | String | Instance ID |
| resource_name | String | Instance name |
| subscription_id | String | Subscription ID |
| resource_type | String | Resource type. The value is hws.resource.type.dayu. |
| resource_spec_code | String | Product specifications code, such as dayu.starter, dayu.basic, and dayu.advanced |
| product_id | String | Product ID. This parameter is not required if CBC is unavailable. |
| order_type | String | Order type |
| charge_type | String | Payment type. Leave it blank. |
| is_auto_renew | Integer | Auto renewal. This parameter is mandatory for pay-per-use instances. Value 0 indicates that auto renewal is disabled, and value 1 indicates the opposite. |
| status | Integer | Instance status. 1: not effective; 2: in effect; 3: deleted (unsubscribed); 4: in retention period (frozen); 5: in grace period; 6: deleting. |
| vpc_id | String | VPC ID, which can be obtained from the VPC list |
| security_group_id | String | Security group ID, which can be obtained from the current security group list |
| eps_id | String | Enterprise project ID. For details about how to obtain the enterprise project ID, see Project ID and Account ID. |
| effective_time | Number | Time when the order started taking effect. This parameter is available for yearly/monthly instances. |
| expire_days | String | Days before expiration. This parameter is available for yearly/monthly instances. |
| expire_time | Number | Expiration time. This parameter is available for yearly/monthly instances. |
| lock_check_endpoint | String | Lock check endpoint |
| create_user | String | User who created the order |
| create_time | Number | Creation time |
| domain_id | String | Domain ID |
| is_trial_order | Integer | Whether the order is a trial order |
| work_space_mode | String | Workspace mode |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Returned error information. |
| error_code | String | Returned error code. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Returned error information. |
| error_code | String | Returned error code. |
Example Requests
None
Example Responses
Status code: 400
Bad request.
{
"error_code" : "DAYU.4402",
"error_msg" : "The operation failed, detail msg {0}."
} Status code: 500
Internal server error.
{
"error_code" : "DAYU.3531",
"error_msg" : "Internal server error: {0}"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | This operation succeeds, and the DataArtsStudio instance list is returned. |
| 400 | Bad request. |
| 500 | Internal server error. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.