Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ Instance Management/ Query Instance Details

Updated on 2026-09-01 GMT+08:00

Query Instance Details

Function

Querying details about an IoTDA instance.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:instance:query	Read	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

GET /v5/iot/{project_id}/iotda-instances/{instance_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description : project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Parameter description: instance ID. Value: Enter up to 36 characters, including lowercase letters (a-f), digits, and hyphens (-).

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
instance_type	String	Parameter description: instance type. Options: prePaid: yearly/monthly enterprise
instance_id	String	Parameter description: instance ID. Value: Enter up to 36 characters, including lowercase letters (a-f), digits, and hyphens (-).
charge_mode	String	Parameter description: payment mode of the instance. Options: prePaid: yearly/monthly postPaid: pay-per-use
name	String	Parameter description: instance name. Value: Enter 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-).
flavor	Flavor object	Parameter description: specifications of an IoTDA instance.
status	String	Parameter description: instance status. Options: CREATING: The instance is being created. ACTIVE: The instance is normal. FROZEN: The instance is frozen. TRADING: The instance is in a transaction. MODIFYING: The instance class is being changed. MODIFY_FAILED: The instance modification failed. FAILED: The instance fails to be created.
region_id	String	Parameter description: region to which the instance belongs.
description	String	Parameter description: description of an IoTDA instance. Value: The value can contain a maximum of 256 characters. Use only letters, digits, spaces, and special characters (_,.&-).
access_infos	Array of AccessInfo objects	Parameter description: access information of an IoTDA instance.
create_time	String	Parameter description: time when the instance is created. Example: 2023-01-28T06:57:52Z.
update_time	String	Parameter description: last update time of the instance. Example: 2023-01-28T06:57:52Z.
enterprise_project_id	String	Parameter description: enterprise project ID.
tags	Array of Tag objects	Parameter description: tag information of an IoTDA instance. This field has values if the instance has tags. Or, it is left empty.
order_id	String	Parameter description: order ID.
operate_window	OperateWindow object	Instance maintenance time window. You can specify the time window during which the specifications are modified.
additional_params	AdditionalParamsResp object	Additional parameter information of the enterprise edition.

**Table 3** Flavor
Parameter	Type	Description
type	String	Parameter description : specification name of the IoTDA instance to create. For details, see Specifications.
size	Integer	Parameter description : unit number of the standard IoTDA instances to create. For details, see Specifications. This parameter is mandatory when instance_type is set to standard.

**Table 4** AccessInfo
Parameter	Type	Description
type	String	Parameter description: access address type. For example, if HTTPS is used for application access, the value is APP_HTTPS. If MQTT is used for device access, the value is DEVICE_MQTT. Options: APP_HTTPS: HTTPS for application access APP_AMQP: AMQP for application access APP_MQTT: MQTT for application access DEVICE_COAP: CoAP for device access DEVICE_MQTT: MQTT for device access DEVICE_HTTPS: HTTPS for device access
port	Integer	Parameter description: secure access port of the application or device of the instance.
non_tls_port	Integer	Parameter description: non-secure access port of the application or device of the instance. If null is returned, the access address of this type does not support non-secure port access.
websocket_port	Integer	Parameter description: WebSocket-based MQTT access port. If null is returned, the access address of this type does not support WebSocket port access.
domain_name	String	Parameter description: access domain name of the instance.
private_addresses	Array of strings	Parameter description: private network access address list of the instance.
public_address	Array of strings	Parameter description: public access address of the instance.
ipv6_address	Array of strings	Parameter description: IPv6 access address list of the instance.
ip_whitelist	IPWhiteList object	IP address whitelist. The IP address whitelist can be configured only for the APP_HTTPS, APP_AMQP, and APP_MQTT protocol of the enterprise instances.

**Table 5** IPWhiteList
Parameter	Type	Description
enable	Boolean	Parameter description: whether to enable the IP address whitelist access control.
allow_list	Array of IpAllowList objects	Parameter description: List of IP addresses that are allowed to access the enterprise edition instance.

**Table 6** IpAllowList
Parameter	Type	Description
address	String	Parameter description: whitelist IP address.
description	String	Parameter description: description.

**Table 7** Tag
Parameter	Type	Description
key	String	Parameter description: tag key. Use letters, digits, spaces, and special characters (_.:=+-@). No space is allowed at the beginning or end.
value	String	Parameter description: tag value, which can be an empty string or null. Use letters, digits, spaces, and special characters (_.:=+-@).

**Table 8** OperateWindow
Parameter	Type	Description
start_time	String	Parameter description: start time of the change time window. The value is UTC time in HH:mm format.
end_time	String	Parameter description: end time of the change time window. The value is UTC time in HH:mm format.

**Table 9** AdditionalParamsResp
Parameter	Type	Description
vpc_id	String	Parameter description: VPC ID of the instance of the enterprise edition.
subnet_id	String	Parameter description: subnet ID of the instance of the enterprise edition.
security_group_id	String	Parameter description: security group ID of the instance of the enterprise edition.
ciphering_algorithm	String	Parameter description: encryption algorithm supported by the instance. Options: COMMON_ALGORITHM: common encryption algorithm (international cryptographic algorithms such as RSA and SHA-256) SM_ALGORITHM: SM series commercial encryption algorithms (Chinese cryptographic algorithms such as SM2, SM3, and SM4)
forwarding_info	ForwardingInfo object	SNAT configuration information of the instance of the enterprise edition.

**Table 10** ForwardingInfo
Parameter	Type	Description
eip	String	Parameter description: EIP bound to the NAT gateway.
enable_snat	Boolean	Parameter description: whether to enable the SNAT configuration. Options: true false

Example Requests

Querying an instance.

GET https://{endpoint}/v5/iot/{project_id}/iotda-instances/{instance_id}

Example Responses

Status code: 200

{
  "instance_type" : "standard",
  "instance_id" : "8561675c-d8a3-4956-9884-9cf9cbdd3134",
  "charge_mode" : "prePaid",
  "name" : "iotda_instance",
  "flavor" : {
    "type" : "iotda.standard.s1",
    "size" : 1
  },
  "status" : "ACTIVE",
  "region_id" : "cn-north-4",
  "create_time" : "2023-01-28T06:57:52Z",
  "update_time" : "2023-01-28T06:58:52Z",
  "description" : "IoTDA instance for production.",
  "access_infos" : [ {
    "type" : "APP_AMQP",
    "port" : 5671,
    "non_tls_port" : null,
    "websocket_port" : null,
    "domain_name" : "example.xxxx.com",
    "public_address" : [ ],
    "ipv6_address" : [ ],
    "ip_whitelist" : null
  }, {
    "type" : "APP_HTTPS",
    "port" : 443,
    "non_tls_port" : null,
    "websocket_port" : null,
    "domain_name" : "example1.xxxx.com",
    "public_address" : [ ],
    "ipv6_address" : [ ],
    "ip_whitelist" : null
  }, {
    "type" : "DEVICE_MQTT",
    "port" : 8883,
    "non_tls_port" : 1883,
    "websocket_port" : 443,
    "domain_name" : "example2.xxxx.com",
    "public_address" : [ ],
    "ipv6_address" : [ ],
    "ip_whitelist" : null
  }, {
    "type" : "DEVICE_COAP",
    "port" : 5684,
    "non_tls_port" : 5683,
    "websocket_port" : null,
    "domain_name" : "example3.xxxx.com",
    "public_address" : [ ],
    "ipv6_address" : [ ],
    "ip_whitelist" : null
  } ],
  "enterprise_project_id" : "d22e47e9-cfad-4254-8a29-d2a56a07681d",
  "tags" : [ {
    "key" : "testTagName",
    "value" : "testTagValue"
  } ],
  "order_id" : "CS22121614500ABCD",
  "operate_window" : {
    "start_time" : "22:00",
    "end_time" : "24:00"
  },
  "additional_params" : null
}

SDK Sample Code

The SDK sample code is as follows.

Java

     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.iotdm.v5.region.IoTDMRegion;
import com.huaweicloud.sdk.iotdm.v5.*;
import com.huaweicloud.sdk.iotdm.v5.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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        IoTDMClient client = IoTDMClient.newBuilder()
                .withCredential(auth)
                .withRegion(IoTDMRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowInstanceRequest request = new ShowInstanceRequest();
        request.withInstanceId("{instance_id}");
        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());
        }
    }
}
 
 
  

Python

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkiotdm.v5.region.iotdm_region import IoTDMRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkiotdm.v5 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 = IoTDMClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(IoTDMRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowInstanceRequest()
        request.instance_id = "{instance_id}"
        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)
 
 
  

Go

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    iotdm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotdm/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotdm/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotdm/v5/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := iotdm.IoTDMClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := iotdm.NewIoTDMClient(hcClient)

    request := &model.ShowInstanceRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowInstance(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	Bad Request
401	Unauthorized

Error Codes

See Error Codes.

Parent topic: Instance Management

Previous topic: This API is used to query the instance list.

Next topic: Modify Instance Information