Help Center/ CodeArts Pipeline/ API Reference/ API/ Rule Management/ Querying Rule Usage
Updated on 2026-07-14 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Rule Usage

Function

This API is used to query rule usage.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{domainId}/rules/{ruleId}/related/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domainId

Yes

String

Tenant ID.

ruleId

Yes

String

Rule ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

rule_set_count

Integer

Number of policies.

project_count

Integer

Number of projects.

pipeline_count

Integer

Number of pipelines.

Example Requests

GET https://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/rules/597c7f2f775740a1bb522b03a16e6864/related/query

Example Responses

Status code: 200

Response body for querying rule usage.

{
  "rule_set_count" : 0,
  "project_count" : 0,
  "pipeline_count" : 0
}

Status Codes

Status Code

Description

200

Response body for querying rule usage.

Error Codes

See Error Codes.

Parent topic: Rule Management