Listing 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
Parameter  | Mandatory  | Type  | Description  | 
|---|---|---|---|
domain_id  | Yes  | String  | Specifies tags. Maximum: 36  | 
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. Minimum: 4 Maximum: 400  | 
name  | No  | String  | Specifies the ResourceQL name. Minimum: 1 Maximum: 64  | 
Request 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.  | 
Response Parameters¶
Status code: 200
Parameter  | Type  | Description  | 
|---|---|---|
value  | Array of StoredQuery objects  | Specifies the list of advanced queries.  | 
page_info  | PageInfo object  | Specifies the pagination object.  | 
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  | 
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
Parameter  | Type  | Description  | 
|---|---|---|
error_code  | String  | Specifies the error code.  | 
error_msg  | String  | Specifies the error message.  | 
Status code: 403
Parameter  | Type  | Description  | 
|---|---|---|
error_code  | String  | Specifies the error code.  | 
error_msg  | String  | Specifies the error message.  | 
Status code: 500
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
  }
}
Status Codes¶
Status Code  | Description  | 
|---|---|
200  | Operation succeeded.  | 
400  | Invalid parameters.  | 
403  | User authentication failed.  | 
500  | Server error.  | 
Error Codes¶
See Error Codes.