Help Center/ Config/ API Reference/ APIs/ Advanced Queries/ Querying Advanced Queries

Updated on 2025-12-15 GMT+08:00

View PDF

Querying Advanced Queries

Function

This API is used to list all advanced queries.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/stored-queries

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies the account ID. Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200
marker	No	String	Specifies the pagination parameter. You can use the marker value in a subsequent call to request the next set of list items. Minimum: 4 Maximum: 400
name	No	String	Specifies the ResourceQL name. Minimum: 1 Maximum: 64

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Specifies the invoker's token.
X-Security-Token	No	String	Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
value	Array of StoredQuery objects	Specifies the list of advanced queries.
page_info	PageInfo object	Specifies the pagination object.

**Table 5** StoredQuery
Parameter	Type	Description
id	String	ResourceQL ID. Maximum: 256
name	String	Specifies the ResourceQL name. Minimum: 1 Maximum: 64
type	String	Indicates a customized query type. The options are account and aggregator. account: customized query statement for a single account. If the value is aggregator, it indicates the customized query statement of the aggregator. The default value is account.
description	String	Specifies the ResourceQL description. Minimum: 0 Maximum: 512
expression	String	Specifies the ResourceQL expression. Minimum: 1 Maximum: 4096
created	String	Specifies when ResourceQL was created. Minimum: 1 Maximum: 64
updated	String	Specifies when ResourceQL was updated. Minimum: 1 Maximum: 64

**Table 6** PageInfo
Parameter	Type	Description
current_count	Integer	Specifies the resource quantity on the current page. Minimum: 0 Maximum: 200
next_marker	String	Specifies the marker value of the next page. Minimum: 4 Maximum: 400

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**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

None

Example Responses

Status code: 200

Operation succeeded.

{
  "value" : [ {
    "id" : "62b9126566d400721efceffa",
    "name" : "stopped-ecs",
    "type" : "account",
    "description" : "Querying stopped ECSs",
    "expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'SHUTOFF'",
    "created" : "2022-06-27T02:13:57.107Z",
    "updated" : "2022-06-27T02:13:57.107Z"
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}