Help Center/Config/API Reference/APIs/Compliance/Querying Rules
Updated on 2025-12-15 GMT+08:00
View PDF

Querying Rules

Function

This API is used to query all rules in an account.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/policy-assignments

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

policy_assignment_name

No

String

Specifies the assignment name.

Maximum: 64

limit

No

Integer

Specifies the maximum number of records to return.

Minimum: 1

Maximum: 500

Default: 500

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

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 PolicyAssignment objects

Specifies rules.

page_info

PageInfo object

Specifies the pagination object.

Table 5 PolicyAssignment

Parameter

Type

Description

policy_assignment_type

String

Specifies the rule type, which can be builtin or custom.

id

String

Specifies the rule ID.

name

String

Specifies the rule name.

description

String

Specifies the rule description.

policy_filter

PolicyFilterDefinition object

Specifies the policy filter of a rule.

period

String

Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours.

state

String

Specifies the rule status.

created

String

Specifies the time when the rule was added.

updated

String

Specifies the time when the rule was modified.

policy_definition_id

String

Specifies the ID of the policy associated with a rule.

custom_policy

CustomPolicy object

Specifies the custom rule.

parameters

Map<String,PolicyParameterValue>

Specifies rule parameters.

tags

Array of ResourceTag objects

Tags

created_by

String

Specifies the rule creator.

target_type

String

Execution method of remediation.

target_id

String

The ID of a remediation object.

Table 6 PolicyFilterDefinition

Parameter

Type

Description

region_id

String

Specifies the region ID.

Maximum: 128

resource_provider

String

Specifies the cloud service name.

Maximum: 128

resource_type

String

Specifies the resource type.

Maximum: 128

resource_id

String

Specifies the resource ID.

Maximum: 512

tag_key

String

Specifies the tag key.

Maximum: 128

tag_value

String

Specifies the tag value.

Maximum: 256

Table 7 CustomPolicy

Parameter

Type

Description

function_urn

String

Specifies the URN of a custom function.

Maximum: 1024

auth_type

String

Specifies the method used by a custom rule to call a function.

auth_value

Map<String,Object>

Specifies the value of the method used by a custom rule to call a function.

Table 8 PolicyParameterValue

Parameter

Type

Description

value

Object

Specifies the value of the rule parameter.

Table 9 ResourceTag

Parameter

Type

Description

key

String

Tag key. A tag key can contain up to 128 Unicode characters and must comply with the character set specifications in section 3.1.

Minimum: 1

Maximum: 128

value

String

Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2.

Minimum: 0

Maximum: 255

Table 10 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 11 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 13 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" : [ {
    "policy_assignment_type" : "builtin",
    "id" : "5fb76a240f2daf0b9662a04d",
    "name" : "volume-inuse-check",
    "description" : "An EVS disk is non-compliant if it is not mounted to a cloud server.",
    "policy_filter" : {
      "region_id" : null,
      "resource_provider" : "evs",
      "resource_type" : "volumes",
      "resource_id" : null,
      "tag_key" : null,
      "tag_value" : null
    },
    "state" : "Enabled",
    "period" : null,
    "custom_policy" : null,
    "created" : "2020-11-20T07:03:00",
    "updated" : "2020-11-20T07:03:00",
    "policy_definition_id" : "5fa36558aa1e6afc05a3d0a7",
    "parameters" : { },
    "tags" : [ {
      "key" : "tagkey",
      "value" : "tagValue"
    } ],
    "created_by" : "custom",
    "target_type" : null,
    "target_id" : null
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}

Status Codes

Status Code

Description

200

Operation succeeded.

400

Invalid parameters.

403

Authentication failed or you do not have the operation permissions.

500

Server error.

Error Codes

See Error Codes.

Parent topic:Compliance