Help Center/ Config/ API Reference/ APIs/ Advanced Queries/ Running Advanced Queries
Updated on 2024-06-21 GMT+08:00

Running Advanced Queries

Function

This API is used to run advanced queries.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/domains/{domain_id}/run-query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Specifies the invoker's token.

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

expression

Yes

String

Specifies the ResourceQL expression.

Minimum: 1

Maximum: 4096

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

query_info

QueryInfo object

Specifies the ResourceQL query field.

results

Array of objects

Specifies the ResourceQL query result.

Table 5 QueryInfo

Parameter

Type

Description

select_fields

Array of strings

Specifies the ResourceQL query field.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 429

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

  • Querying IDs of all VMs under your account

    POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/run-query
    
    {
      "expression" : "select id from resources where provider = 'ecs' and type = 'cloudservers'"
    }
  • Querying 100-GB Elastic Volume Service (EVS) disks under your account

    POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/run-query
    
    {
      "expression" : "select * from resources where provider = 'evs' and type = 'volumes' and properties.size = 100"
    }

Example Responses

Status code: 200

Operation succeeded.

{
  "query_info" : {
    "select_fields" : [ "id" ]
  },
  "results" : [ {
    "id" : "91252cc9-bfd9-0709-0912-56b397e0ba3f"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

  • Querying IDs of all VMs under your account

     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
    48
    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.config.v1.region.ConfigRegion;
    import com.huaweicloud.sdk.config.v1.*;
    import com.huaweicloud.sdk.config.v1.model.*;
    
    
    public class RunQuerySolution {
    
        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);
    
            ConfigClient client = ConfigClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                    .build();
            RunQueryRequest request = new RunQueryRequest();
            QueryRunRequestBody body = new QueryRunRequestBody();
            body.withExpression("select id from resources where provider = 'ecs' and type = 'cloudservers'");
            request.withBody(body);
            try {
                RunQueryResponse response = client.runQuery(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());
            }
        }
    }
    
  • Querying 100-GB Elastic Volume Service (EVS) disks under your account

     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
    48
    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.config.v1.region.ConfigRegion;
    import com.huaweicloud.sdk.config.v1.*;
    import com.huaweicloud.sdk.config.v1.model.*;
    
    
    public class RunQuerySolution {
    
        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);
    
            ConfigClient client = ConfigClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                    .build();
            RunQueryRequest request = new RunQueryRequest();
            QueryRunRequestBody body = new QueryRunRequestBody();
            body.withExpression("select * from resources where provider = 'evs' and type = 'volumes' and properties.size = 100");
            request.withBody(body);
            try {
                RunQueryResponse response = client.runQuery(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());
            }
        }
    }
    
  • Querying IDs of all VMs under your account

     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
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import GlobalCredentials
    from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkconfig.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 = ConfigClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = RunQueryRequest()
            request.body = QueryRunRequestBody(
                expression="select id from resources where provider = 'ecs' and type = 'cloudservers'"
            )
            response = client.run_query(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Querying 100-GB Elastic Volume Service (EVS) disks under your account

     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
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import GlobalCredentials
    from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkconfig.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 = ConfigClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = RunQueryRequest()
            request.body = QueryRunRequestBody(
                expression="select * from resources where provider = 'evs' and type = 'volumes' and properties.size = 100"
            )
            response = client.run_query(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Querying IDs of all VMs under your account

     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
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
        config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/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 := config.NewConfigClient(
            config.ConfigClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.RunQueryRequest{}
    	request.Body = &model.QueryRunRequestBody{
    		Expression: "select id from resources where provider = 'ecs' and type = 'cloudservers'",
    	}
    	response, err := client.RunQuery(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • Querying 100-GB Elastic Volume Service (EVS) disks under your account

     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
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
        config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/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 := config.NewConfigClient(
            config.ConfigClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.RunQueryRequest{}
    	request.Body = &model.QueryRunRequestBody{
    		Expression: "select * from resources where provider = 'evs' and type = 'volumes' and properties.size = 100",
    	}
    	response, err := client.RunQuery(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

Operation succeeded.

400

Invalid parameters.

403

User authentication failed.

429

Limit exceeded.

500

Server error.

Error Codes

See Error Codes.