Creating a Query

Scenarios

You can use the query statements preset by Config or customize query statements based on resource configuration attributes to query specific cloud resource configurations.

This section includes the following content:

• Creating a Query
• Saving a Query
• Configuration Examples of Advanced Queries

Creating a Query

1. Sign in to Config console.
2. Click in the upper left corner. Under Management & Governance, click Config.
3. In the left navigation, choose Advanced Queries.
4. Choose the Custom Queries tab and click New Query at the upper right corner.
5. In the query editor, enter the query statement as prompted.

   The Schema information used for advanced query is displayed on the left of the page. The properties parameter included in a request should be set to the Schema information which shows the detailed attributes of a cloud service resource. For details about the configuration example of the query statement, see Configuration Examples of Advanced Queries.

6. Click Save Query and enter the query name and description.

   The query name can contain only digits, letters, underscores (_), and hyphens (-).

7. Click OK.
   Figure 1 Save Query
   
   

   There is a limit to how many custom queries you can create. If you exceed this limit, you will receive a notification: "The maximum number of custom queries has been reached." You will still be able to run custom queries and export the results, but no more custom queries can be saved.

8. Click Run and then view the query results. Only the first 4000 query results can be displayed and saved.
9. Click Export and select the format of the file to be exported (CSV or JSON).

Saving a Query

You can modify the name, description, and query statement of a query. After you click Save As, a new query is created. The following procedure uses a default query as an example to describe how to modify a query.

1. Choose Advanced Queries > Default Queries.

   All default queries are displayed in a list.

2. Click Query in the Operation column for the target query.

   Alternatively, click the query name and then click Query in the lower right corner of the query overview page.

   Figure 2 Default queries
   

3. In the query editor, modify the query statement as prompted.

   For details, see Configuration Examples of Advanced Queries.

4. Click Save As and enter the query name and description.
5. In the dialog box that is displayed, click OK.
   

   New queries generated through the Save As operation is updated in the custom query list.

Configuration Examples of Advanced Queries

Advanced queries use ResourceQL, a subset of SQL SELECT syntax, to query resource configuration data. You do not need to call specific APIs for the query or use multiple APIs to download full data and manually analyze the data. ResourceQL can only query data from the resources table.

Example quires are as follows:

• Example 1: List ECSs in the Stopped state.

  SELECT name
  FROM resources
  WHERE provider = 'ecs'
  	AND type = 'cloudservers'
  	AND properties.status = 'SHUTOFF'

• Example 2: List EVS disks with certain specifications.

  SELECT *
  FROM resources
  WHERE provider = 'evs'
  	AND type = 'volumes'
  	AND properties.size = 100

• Example 3: List OBS buckets queried by fuzzy search.

  SELECT *
  FROM resources
  WHERE provider = 'obs'
  	AND 'type' = 'buckets'
  	AND name LIKE '%figure%'

• Example 4: List ECSs and the EVS disks attached to each ECS.

  SELECT ECS_EVS.id AS ecs_id, EVS.id AS evs_id
  FROM (
      SELECT id, evs_id
      FROM (
  	SELECT id, transform(properties.ExtVolumesAttached, x -> x.id) AS evs_list
  	FROM resources
  	WHERE provider = 'ecs'
  		AND type = 'cloudservers'
  	) ECS
  	   CROSS JOIN UNNEST(evs_list) AS t (evs_id)
  ) ECS_EVS, (
  	SELECT id
  	FROM resources
  	WHERE provider = 'evs'
  		AND type = 'volumes'
  	) EVS
  WHERE ECS_EVS.evs_id = EVS.id

• Example 5: List ECSs and the EIPs bound to each ECS.

  SELECT ECS.id AS ECS_id, publicIpAddress AS ip_address
  FROM (
      SELECT id, transform(properties.addresses, x -> x.addr) AS ip_list
      FROM resources
      WHERE provider = 'ecs'
          AND type = 'cloudservers'
  ) ECS, (
          SELECT name, properties.publicIpAddress
          FROM resources
          WHERE provider = 'vpc'
              AND type = 'publicips'
              AND properties.type = 'EIP'
              AND properties.status = 'ACTIVE'
      ) EIP
  WHERE CONTAINS (ECS.ip_list, EIP.name)

• Example 6: List resources with a quantity greater than 100 in each region.

  WITH counts AS (
      SELECT region_id, provider, type, count(*) AS number
      FROM resources
      GROUP BY region_id, provider, type
  )
  SELECT *
  FROM counts
  WHERE number > 100

  For details about query statements, see ResourceQL Syntax.