Help Center/ Cloud Eye/ API Reference/ API v2/ Resource Groups/ Querying Resource Groups
Updated on 2024-05-16 GMT+08:00

Querying Resource Groups

Function

This API is used to query resource groups.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/resource-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the tenant ID.

Minimum: 1

Maximum: 64

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Specifies the ID of the enterprise project to which a resource group belongs.

Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

group_name

No

String

Specifies the resource group name. Fuzzy search is supported.

Minimum: 1

Maximum: 128

group_id

No

String

Specifies the resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

Minimum: 2

Maximum: 24

offset

No

Integer

Specifies the start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0.

Minimum: 0

Maximum: 10000

limit

No

Integer

Specifies the number of items on each page during pagination query. The value ranges from 1 to 100 (default).

Minimum: 1

Maximum: 100

type

No

String

Specifies the method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources). If this parameter is not specified, all resource groups are queried.

Enumeration values:

  • EPS

  • TAG

  • Manual

origin_flag

No

String

Specifies the source ID. The value can only be resourcegroup or monitoroverview. If this parameter is not specified, resourcegroup is used by default.

Enumeration values:

  • resourcegroup

  • monitoroverview

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the tenant token.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Specifies the total number of resource groups.

Minimum: 0

Maximum: 1000

resource_groups

Array of OneResourceGroupResp objects

Specifies the resource group list.

Array Length: 0 - 100

Table 5 OneResourceGroupResp

Parameter

Type

Description

group_name

String

Specifies the resource group name.

Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

group_id

String

Specifies the resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

Minimum: 2

Maximum: 24

create_time

String

Specifies the time when a resource group was created.

enterprise_project_id

String

Specifies the ID of the enterprise project to which a resource group belongs.

Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

type

String

Specifies the method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources).

Enumeration values:

  • EPS

  • TAG

  • Manual

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Example Requests

Querying resource groups

/v2/{project_id}/resource-groups?offset=0&limit=100

Example Responses

Status code: 200

OK

{
  "resource_groups" : [ {
    "group_name" : "group1",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg0123456789xxxx",
    "enterprise_project_id" : "0",
    "type" : "Manual"
  }, {
    "group_name" : "band",
    "type" : "EPS",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg0123456789xxxx",
    "enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02"
  }, {
    "group_name" : "group2",
    "type" : "TAG",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg0123456789xxxx",
    "enterprise_project_id" : "0"
  } ],
  "count" : 3
}

Status Codes

Status Code

Description

200

OK

400

Failed to verify parameters.

401

Not authenticated.

403

Authentication failed.

500

Internal system error.

Error Codes

See Error Codes.