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 when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service. |
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 |
Region ID. You can obtain it from the response message of the "Querying the Region List" API of the IAM service. |
|
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}"
}
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListDataArtsStudioInstancesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListDataArtsStudioInstancesRequest request = new ListDataArtsStudioInstancesRequest(); try { ListDataArtsStudioInstancesResponse response = client.listDataArtsStudioInstances(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDataArtsStudioInstancesRequest() response = client.list_data_arts_studio_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDataArtsStudioInstancesRequest{} response, err := client.ListDataArtsStudioInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot