Help Center/ CodeArts Pipeline/ API Reference/ API/ Tenant-Level Policy Management/ Querying Information Related to a Policy
Updated on 2025-03-25 GMT+08:00

Querying Information Related to a Policy

Function

This API is used to query information related to a policy.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{domainId}/tenant/rule-sets/{ruleSetId}/children

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domainId

Yes

String

Tenant ID.

ruleSetId

Yes

String

Policy ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Policy ID.

offset

No

Integer

Policy ID.

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

limit

Yes

Integer

Page size.

offset

Yes

Integer

Offset.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Array of SimpleRuleSetVO objects

Data.

total

Long

Total number.

Table 5 SimpleRuleSetVO

Parameter

Type

Description

id

String

Policy ID.

name

String

Policy name.

level

String

Scope identifier: tenant – tenant, other – non-tenant.

is_valid

Boolean

Whether it is valid, true: valid; false: not valid.

version

String

Rule template version.

operator

String

Last operator.

is_public

Boolean

Whether the policy is a system policy.

is_legacy

Boolean

Whether the data is 1.0 data.

operate_time

Integer

Last operation time.

Example Requests

GET https://{endpoint}/v2/9dd3a6d966894e4399d3aafe3ceb4fad/tenant/rule-sets/68b99a225e93441f8d5f111eba6cbf30/children?limit=10&offset=0

Example Responses

Status code: 200

Response body for querying information related to a policy.

{
  "data" : [ {
    "id" : "f9228e23118c4fa5a9c86493ea0cffc2",
    "name" : "System policy",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "ace33a17a73442e398fedc123d047da2",
    "operator" : "north5",
    "is_public" : true,
    "is_legacy" : null,
    "operate_time" : 1672063512000
  }, {
    "id" : "9dd3a6d966894e4399d3aafe3ceb4fad",
    "name" : "API automatic creation rule hC3Ud",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "d4b0df240e06466e91629c65436abe93",
    "operator" : "north5",
    "is_public" : false,
    "is_legacy" : null,
    "operate_time" : 1719220158000
  } ],
  "total" : 199
}

Status Codes

Status Code

Description

200

Response body for querying information related to a policy.

Error Codes

See Error Codes.