Querying Instance Details
Function
This API is used to query instance details.
Calling Method
For details, see Calling APIs.
URI
GET /v2/aad/instances/{instance_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
token |
|
Content-Type |
Yes |
String |
Content-Type |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
instance_name |
String |
Instance name. |
|
enterprise_project_id |
String |
Enterprise project ID. |
|
version |
String |
Version |
|
expire_time |
Integer |
Expiration time. |
|
create_time |
Integer |
Creation time. |
|
current_time |
Integer |
Current time |
|
product_spec_data |
ProductSpecData object |
Product specification data |
|
instance_config |
InstanceConfig object |
Instance configurations |
|
elastic_service_bw_update_enable |
Boolean |
Whether the elastic bandwidth can be updated. |
|
Parameter |
Type |
Description |
|---|---|---|
|
product_uuid |
String |
Product specification UUID |
|
isp_spec |
String |
Package line |
|
data_center |
String |
Equipment room |
|
spec_type |
Integer |
Product specification type |
|
basic_bandwidth |
Integer |
Baseline bandwidth. |
|
elastic_bandwidth |
Integer |
Elastic bandwidth. |
|
service_bandwidth |
Integer |
Service bandwidth |
|
port_num |
Integer |
Number of ports |
|
bind_domain_num |
Integer |
Number of domain names. |
|
elastic_service_bandwidth |
Integer |
Elastic bandwidth |
|
elastic_service_bandwidth_type |
Integer |
Elastic service bandwidth type. 0: disabled. 3: monthly 95th percentile billing. |
|
main_resource_type |
String |
Primary resource type. |
|
main_resource_spec_code |
String |
Primary resource specification code. |
|
main_resource_product_id |
String |
Primary resource product ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
tags |
Array of strings |
Instance-level tag. |
|
freeze_type |
Array of integers |
Freezing type. The options are as follows: 1: frozen by the police department; 3: frozen due to arrears. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_description |
String |
Error description. |
Example Requests
None
Example Responses
None
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 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.aad.v2.region.AadRegion; import com.huaweicloud.sdk.aad.v2.*; import com.huaweicloud.sdk.aad.v2.model.*; public class ShowInstanceByInstanceIdSolution { 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 GlobalCredentials() .withAk(ak) .withSk(sk); AadClient client = AadClient.newBuilder() .withCredential(auth) .withRegion(AadRegion.valueOf("<YOUR REGION>")) .build(); ShowInstanceByInstanceIdRequest request = new ShowInstanceByInstanceIdRequest(); request.withInstanceId("{instance_id}"); try { ShowInstanceByInstanceIdResponse response = client.showInstanceByInstanceId(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 GlobalCredentials from huaweicloudsdkaad.v2.region.aad_region import AadRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaad.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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = AadClient.new_builder() \ .with_credentials(credentials) \ .with_region(AadRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowInstanceByInstanceIdRequest() request.instance_id = "{instance_id}" response = client.show_instance_by_instance_id(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aad.NewAadClient( aad.AadClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowInstanceByInstanceIdRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowInstanceByInstanceId(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 |
OK |
|
400 |
Error response |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot