更新时间:2024-06-14 GMT+08:00

获取策略列表

功能介绍

获取策略列表

调用方法

请参见如何调用API

URI

GET /v2/{domain_id}/tenant/rule-sets/query

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

租户ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询,offset大于等于0

limit

Integer

每页显示的条目数量

include_tenant_rule_set

Boolean

是否包含租户级规则

name

String

策略名称,用于模糊查询

is_valid

Boolean

是否有效

type

String

策略类型

cloud_project_id

String

项目ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

Array of RuleSet objects

规则实例列表

total

Long

总数

表5 RuleSet

参数

参数类型

描述

id

String

规则模版实例ID

name

String

规则模版实例名称

type

String

类型

version

String

版本

operator

String

最近操作人

operate_time

Long

最近操作时间

is_valid

Boolean

是否生效

level

String

租户级、项目级

is_public

Boolean

是否系统级

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

请求示例

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/query?name=&limit=2&offset=30&cloud_project_id=

响应示例

状态码: 200

OK

{
  "data" : [ {
    "id" : "30782f30c92e4c1dbc3c596075970d67",
    "name" : "DJtest创建租户级策略-apitest-rKaG",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "67e915e472554f719abe513c28728d9f",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1692695390000
  }, {
    "id" : "4f5fb96022974a2781174584f799d8c2",
    "name" : "DJtest创建租户级策略-apitest-S190",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "61ebfef577c34406b5647ac1d83e7bb8",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1692695390000
  } ],
  "total" : 333
}

SDK代码示例

SDK代码示例如下。

 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
47
48
49
50
51
52
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 ListStrategySolution {

    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();
        ListStrategyRequest request = new ListStrategyRequest();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withIncludeTenantRuleSet(<include_tenant_rule_set>);
        request.withName("<name>");
        request.withIsValid(<is_valid>);
        request.withType("<type>");
        request.withCloudProjectId("<cloud_project_id>");
        try {
            ListStrategyResponse response = client.listStrategy(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
32
33
34
35
36
37
# 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 = ListStrategyRequest()
        request.offset = <offset>
        request.limit = <limit>
        request.include_tenant_rule_set = <IncludeTenantRuleSet>
        request.name = "<name>"
        request.is_valid = <IsValid>
        request.type = "<type>"
        request.cloud_project_id = "<cloud_project_id>"
        response = client.list_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
37
38
39
40
41
42
43
44
45
46
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.ListStrategyRequest{}
	request.Offset = int32(<offset>)
	request.Limit = int32(<limit>)
	request.IncludeTenantRuleSet = <include_tenant_rule_set>
	nameRequest:= "<name>"
	request.Name = &nameRequest
	isValidRequest:= <is_valid>
	request.IsValid = &isValidRequest
	typeRequest:= "<type>"
	request.Type = &typeRequest
	cloudProjectIdRequest:= "<cloud_project_id>"
	request.CloudProjectId = &cloudProjectIdRequest
	response, err := client.ListStrategy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码