Help Center/ CodeArts Pipeline/ API Reference/ API/ Project-Level Policy Management/ Obtaining the Project-Level Policy List
Updated on 2025-09-08 GMT+08:00

Obtaining the Project-Level Policy List

Function

This API is used to obtain the project-level policy list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/rule-sets/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

Yes

Integer

Definition:

Offset where the query starts.

Constraints:

N/A

Value range:

The value is no less than 0.

Default value:

N/A

limit

Yes

Integer

Definition:

Number of records of each query.

Constraints:

N/A

Value range:

The value is no less than 0.

Default value:

N/A

include_tenant_rule_set

Yes

Boolean

Definition:

Whether tenant-level rules are included.

Constraints:

N/A

Value range:

  • true: Tenant-level rules are included.

  • false: Tenant-level rules are not included.

Default value:

N/A

name

No

String

Definition:

Policy name, which can be used for fuzzy query.

Constraints:

The policy name can contain only characters, letters, digits, hyphens (-), and underscores (_).

Value range:

Enter a maximum of 128 characters.

Default value:

N/A

is_valid

No

Boolean

Definition:

Whether the policy is valid.

Constraints:

N/A

Value range:

  • true: The policy is valid.

  • false: The policy is invalid.

Default value:

N/A

type

No

String

Definition:

Policy type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Array of RuleSet objects

Definition:

List of rule instances.

Value range:

N/A

total

Long

Definition:

Total number of rules.

Value range:

N/A

Table 5 RuleSet

Parameter

Type

Description

id

String

Definition:

Rule template instance ID.

Value range:

N/A

name

String

Definition:

Rule template instance name.

Value range:

N/A

type

String

Definition:

Rule instance type.

Value range:

N/A

version

String

Definition:

Rule instance version.

Value range:

N/A

operator

String

Definition:

Latest operator of the rule instance.

Value range:

N/A

operate_time

Long

Definition:

Time when the rule was last operated.

Value range:

N/A

is_valid

Boolean

Definition:

Whether the rule instance takes effect.

Value range:

  • true: The rule takes effect.

  • false: The rule does not take effect.

level

String

Definition:

Effective level of a rule instance.

Value range:

N/A

is_public

Boolean

Definition:

Whether the rule instance is system-level.

Value range:

  • true: The rule instance is system-level.

  • false: The rule instance is not system-level.

is_legacy

Boolean

Definition:

Whether the rule instance data is from version 1.0.

Value range:

  • true: The rule instance data is from version 1.0.

  • false: The rule instance data is not from version 1.0.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

GET https://{endpoint}/v2/d80a8a6530324b7bac972cbb8a9f28ec/rule-sets/query?name=&limit=10&offset=0&include_tenant_rule_set=false

Example Responses

Status code: 200

OK

{
  "data" : [ {
    "id" : "98183e0e70634f4d99da7dc549496652",
    "name" : "Creating a Policy - 20230915203425",
    "level" : "project",
    "is_valid" : true,
    "version" : "82ed35e3ecd041ebace8d62347042368",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1694781278000
  }, {
    "id" : "becbd00aa13147c6a226283a4bad57e0",
    "name" : "Creating a Policy - 20230817183223",
    "level" : "project",
    "is_valid" : true,
    "version" : "e3cc0a3df511486ea36bdcb46df724f8",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1693900336000
  }, {
    "id" : "52b24f9add844832a2af11f2e760c730",
    "name" : "codecheck-copy",
    "level" : "project",
    "is_valid" : true,
    "version" : "a2e50e1972f348e0838679eabe0b4467",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1693900325000
  }, {
    "id" : "d899845c2eff4fa18860fa4b31c5ee31",
    "name" : "codecheck",
    "level" : "project",
    "is_valid" : true,
    "version" : "20f79c6ff8844f5391882d7b3497761b",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1693300726000
  } ],
  "total" : 4
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion;
import com.huaweicloud.sdk.codeartspipeline.v2.*;
import com.huaweicloud.sdk.codeartspipeline.v2.model.*;


public class ListProjectStrategySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>"))
                .build();
        ListProjectStrategyRequest request = new ListProjectStrategyRequest();
        request.withProjectId("{project_id}");
        try {
            ListProjectStrategyResponse response = client.listProjectStrategy(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartspipeline.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsPipelineClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListProjectStrategyRequest()
        request.project_id = "{project_id}"
        response = client.list_project_strategy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListProjectStrategyRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ListProjectStrategy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.