Querying an Instance
Function
This API is used to query an instance.
Call Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the ID, see Obtaining Project ID. |
instance_id |
Yes |
String |
Instance ID |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
configuration_status |
String |
Configuration status |
params_group_id |
String |
Parameter group ID |
type |
String |
Type |
subnet_id |
String |
Subnet ID |
role |
String |
Role |
internal_subnet_id |
String |
Internal subnet ID |
group |
String |
Group |
secure_group |
String |
Security group |
vpc |
String |
VPC. |
azcode |
String |
Code |
region |
String |
Region |
cluster_id |
String |
Cluster ID |
created |
String |
Time when the instance is created |
updated |
String |
Time when the instance is updated |
status |
String |
Running status |
name |
String |
Name |
links |
Array of LinkResp objects |
Connections |
id |
String |
ID |
flavor |
ClusterFlavorResp object |
Flavor |
volume |
CompatibleInstanceVolumeResp object |
Capacity |
datastore |
CompatibleDataStoreResp object |
Data warehouse |
fault |
CompatibleFaultResp object |
Whether the flavor is the currently used flavor |
configuration |
CompatibleConfigurationResp object |
Whether the flavor is the currently used flavor |
locality |
String |
Location |
replicas |
Array of CompatibleReplicasResp objects |
Backup |
db_user |
String |
Database user |
storage_engine |
String |
Storage engine |
pay_model |
Integer |
Payment method |
public_ip |
String |
Public IP address |
traffic_ip |
String |
Traffic IP address |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID |
links |
Array of LinkResp objects |
Connections |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Type |
used |
Float |
Connections |
size |
Integer |
Size |
Parameter |
Type |
Description |
---|---|---|
message |
String |
Information |
created |
String |
Creator |
details |
String |
Details |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID |
name |
String |
Name |
links |
Array of LinkResp objects |
Connections |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID |
name |
String |
Name |
links |
Array of LinkResp objects |
Connections |
Example Request
GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/instances/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
Example Response
Status code: 200
{ "configuration_status" : "In-Sync", "params_group_id" : "53cb2c86-a598-58ca-8c2c-0389f4b78912", "type" : "dws-cn", "subnet_id" : "43cb2c86-a598-59ca-8c2c-0380f4b78613", "role" : "Standalone", "internal_subnet_id" : "73cb3c86-a598-59ca-8c2c-0380f4b78659", "group" : "cn-1", "secure_group" : null, "vpc" : "62cb2c86-a598-58ca-8c2c-0389f4b78954", "azcode" : "cn-north-854a", "region" : "cn-north-854", "cluster_id" : "85cb3c86-a598-59ca-8c2c-0380f4b78613", "created" : "2023-02-24T02:25:36", "updated" : "2023-02-24T09:25:36", "status" : null, "name" : "test-dws-cn-cn-1-1", "links" : [ { "rel" : "self", "href" : null }, { "rel" : "bookmark", "href" : null } ], "id" : "13cb2c86-a598-48ca-8c2c-0389f4b78963", "flavor" : { "id" : "46cb2c86-a598-48ca-8c2c-0389f4b78545", "links" : [ { "rel" : "self", "href" : null }, { "rel" : "bookmark", "href" : null } ] }, "volume" : null, "datastore" : { "type" : "dws3.0", "version" : "9.0.0" }, "fault" : null, "configuration" : { "id" : "56cb2c86-a598-48ca-8c2c-0389f4b78549", "name" : "test", "links" : [ { "rel" : "self", "href" : null }, { "rel" : "bookmark", "href" : null } ] }, "locality" : null, "replicas" : null, "db_user" : "admin", "storage_engine" : null, "pay_model" : 0, "public_ip" : null, "traffic_ip" : "192.168.13.132" }
SDK Sample Code
The 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 |
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.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; public class ShowInstanceSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("cn-north-4")) .build(); ShowInstanceRequest request = new ShowInstanceRequest(); try { ShowInstanceResponse response = client.showInstance(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 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.v2 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("cn-north-4")) \ .build() try: request = ShowInstanceRequest() response = client.show_instance(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.ShowInstanceRequest{} response, err := client.ShowInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.
Status Code
Status Code |
Description |
---|---|
200 |
The instance is queried. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
The service was unavailable. |
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