Help Center/ Workspace/ API Reference/ Workspace APIs/ Policy Group/ Querying Policy Group Brief Information
Updated on 2026-07-24 GMT+08:00
View PDF
Share

Querying Policy Group Brief Information

Function

Queries brief information of a policy group, excluding policy information and application object information.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:policyGroups:list

    List

    policyGroup *

    -

    -

    -

URI

GET /v2/{project_id}/policy-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Limits the quantity of returned policy groups in pagination query. If this parameter is not specified, all policy groups that meet the search criteria are returned. The value ranges from 0 to 100.

offset

No

Integer

Where the pagination query starts. The value ranges from 0 to 1,000.

policy_group_id

No

String

Filters results by policy group ID.

policy_group_name

No

String

Filters results by policy group name.

priority

No

Integer

Filters results by priority. The value cannot exceed the maximum value of the existing policy group's priority.

update_time

No

String

Filters results by update time. The time format is yyyy-MM-dd HH:mm:ss.

description

No

String

Policy group description.

is_group_name_accurate

No

Boolean

Exact query by policy group name.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

policy_groups

Array of PolicyGroupForBaseList objects

Policy group.

total_count

Integer

Total quantity.
Table 4 PolicyGroupForBaseList

Parameter

Type

Description

policy_group_id

String

Policy group ID.

policy_group_name

String

Policy group name.

priority

Integer

Priority.

update_time

String

Update date.

description

String

Policy group description.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/089b2f9a3d80d3062f24c00ca4ed5cbd/policy-groups

Example Responses

Status code: 200

Response to policy group information query.

{
  "total_count" : 2,
  "policy_groups" : [ {
    "priority" : 1,
    "description" : "Policy group description 1.",
    "policy_group_id" : "8ac225c2781f230a01781f29b2e7xxxx",
    "policy_group_name" : "Policy group 1",
    "update_time" : "2021-03-12 12:02:01"
  }, {
    "priority" : 2,
    "description" : "Policy group description 2.",
    "policy_group_id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "policy_group_name" : "Policy group 2",
    "update_time" : "2021-03-12 09:06:44"
  } ]
}

Status Codes

Status Code

Description

200

Response to policy group information query.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details about the error code, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Policy Group