更新时间:2024-06-21 GMT+08:00

运行高级查询

功能介绍

执行高级查询。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

调用者token。

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

表3 请求Body参数

参数

是否必选

参数类型

描述

expression

String

ResourceQL表达式。

最小长度:1

最大长度:4096

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

query_info

QueryInfo object

ResourceQL查询字段。

results

Array of objects

ResourceQL查询结果。

表5 QueryInfo

参数

参数类型

描述

select_fields

Array of strings

ResourceQL查询字段。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 429

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

  • 查询当前用户下所有虚拟机的id。

    POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/run-query
    
    {
      "expression" : "select id from resources where provider = 'ecs' and type = 'cloudservers'"
    }
  • 查询当前用户下指定容量为100GB的云硬盘。

    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"
    }

响应示例

状态码: 200

操作成功。

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

SDK代码示例

SDK代码示例如下。

  • 查询当前用户下所有虚拟机的id。

     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());
            }
        }
    }
    
  • 查询当前用户下指定容量为100GB的云硬盘。

     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());
            }
        }
    }
    
  • 查询当前用户下所有虚拟机的id。

     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)
    
  • 查询当前用户下指定容量为100GB的云硬盘。

     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)
    
  • 查询当前用户下所有虚拟机的id。

     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)
        }
    }
    
  • 查询当前用户下指定容量为100GB的云硬盘。

     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)
        }
    }
    

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

用户认证失败。

429

超出频次限制。

500

服务器内部错误。

错误码

请参见错误码