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

Querying the AAD Instance List

Function

This API is used to query the AAD instance list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/aad/instances

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Content-Type

Yes

String

Content-Type

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

count

Integer

Total number of instances.

items

Array of InstanceInfo objects

Instance

Table 3 InstanceInfo

Parameter

Type

Description

instance_id

String

Instance ID.

instance_name

String

Instance name

ips

Array of InstanceIpInfo objects

Instance IP address.

expire_time

Long

Instance expiration time.

service_bandwidth

Integer

Service bandwidth.

instance_status

Integer

Instance status.

enterprise_project_id

String

Enterprise project ID.

overseas_type

Integer

Instance type. 0: the Chinese mainland. 1: outside the Chinese mainland.

Table 4 InstanceIpInfo

Parameter

Type

Description

ip_id

String

IP ID

ip

String

Advanced Anti-DDoS IP address

basic_bandwidth

Integer

Baseline bandwidth.

elastic_bandwidth

Integer

Elastic bandwidth.

ip_status

Integer

IP address status. 0: normal.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "count" : 2,
  "items" : [ {
    "ips" : [ {
      "ip" : "103.239.246.6",
      "ip_id" : "4f1XXXX-XXXX-XXXX-XXXX-XXXXd4b1",
      "basic_bandwidth" : 10,
      "elastic_bandwidth" : 20,
      "ip_status" : 0
    } ],
    "instance_id" : "74acXXXX-XXXX-XXXX-XXXX-XXXXd012",
    "instance_name" : "example 1",
    "expire_time" : 1675926787000,
    "service_bandwidth" : 0,
    "instance_status" : 0,
    "enterprise_project_id" : "0"
  }, {
    "ips" : [ {
      "ip" : "103.239.246.156",
      "ip_id" : "d6f9XXXX-XXXX-XXXX-XXXX-XXXXd4b1",
      "basic_bandwidth" : 20,
      "elastic_bandwidth" : 30,
      "ip_status" : 0
    } ],
    "instance_id" : "6a7fXXXX-XXXX-XXXX-XXXX-XXXXd4a6",
    "instance_name" : "example 2",
    "expire_time" : 1674909266000,
    "service_bandwidth" : 0,
    "instance_status" : 0,
    "enterprise_project_id" : "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
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.v1.region.AadRegion;
import com.huaweicloud.sdk.aad.v1.*;
import com.huaweicloud.sdk.aad.v1.model.*;


public class ListInstanceSolution {

    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();
        ListInstanceRequest request = new ListInstanceRequest();
        try {
            ListInstanceResponse response = client.listInstance(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkaad.v1.region.aad_region import AadRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaad.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"]

    credentials = GlobalCredentials(ak, sk)

    client = AadClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AadRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListInstanceRequest()
        response = client.list_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/global"
    aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aad.NewAadClient(
        aad.AadClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListInstanceRequest{}
	response, err := client.ListInstance(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

Error Codes

See Error Codes.