更新时间:2024-11-29 GMT+08:00
分享

获取策略详情

功能介绍

获取策略详情

调用方法

请参见如何调用API

URI

GET /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/detail

表1 路径参数

参数

是否必选

参数类型

描述

rule_set_id

String

策略ID

domain_id

String

租户ID

表2 Query参数

参数

是否必选

参数类型

描述

cloud_project_id

String

项目ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

规则模板实例ID

name

String

规则模板实例名称

type

String

类型

version

String

版本

creator

String

创建人

create_time

String

创建时间

updater

String

最近更新人

update_time

String

最近更新时间

is_valid

Boolean

是否生效

rule_instances

Array of RuleInstance objects

规则实例集合

表5 RuleInstance

参数

参数类型

描述

id

String

规则实例ID

type

String

规则类型ID

name

String

规则名称

version

String

规则版本

plugin_id

String

插件ID

plugin_name

String

插件名称

plugin_version

String

插件版本号

is_valid

Boolean

是否生效

editable

Boolean

是否可编辑

content

Array of RuleInstanceContent objects

规则属性列表

parent

RuleSet object

父级规则实例模板简要信息

表6 RuleInstanceContent

参数

参数类型

描述

group_name

String

分组名称

type

String

分组类型

can_modify_when_inherit

Boolean

继承后的子策略是否可以修改阈值

properties

Array of RuleInstanceProperty objects

规则属性列表

表7 RuleInstanceProperty

参数

参数类型

描述

key

String

属性键

type

String

类型

name

String

展示名称

operator

String

比较运算符

value

String

属性值

value_type

String

数据类型

表8 RuleSet

参数

参数类型

描述

id

String

规则模板实例ID

name

String

规则模板实例名称

type

String

类型

version

String

版本

operator

String

最近操作人

operate_time

Long

最近操作时间

is_valid

Boolean

是否生效

level

String

租户级、项目级

is_public

Boolean

是否系统级

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/detail?cloud_project_id=

响应示例

状态码: 200

OK

{
  "id" : "6cb18ee5ca1c48caa335706e0e5ee288",
  "name" : "创建一个租户级策略",
  "version" : "c0ca09cfda8a426bbdb8df4c34c4831e",
  "is_valid" : true,
  "creator" : "847a5317086c41798469d0868535943a",
  "create_time" : "2023-09-25T19:32:14",
  "updater" : "847a5317086c41798469d0868535943a",
  "update_time" : "2023-10-20T17:12:41",
  "rule_instances" : [ {
    "id" : "80cfcff078074b8aa7951d7b67b3137b",
    "type" : "Gate",
    "name" : "api自动化创建规则dyEnd",
    "is_valid" : true,
    "version" : "8128ca663cdc4cea9a6dc05e53ae0a55",
    "plugin_id" : "official_devcloud_apiTest",
    "plugin_name" : "official_devcloud_apiTest",
    "plugin_version" : "0.0.6",
    "content" : [ {
      "group_name" : "API测试通过率门禁",
      "can_modify_when_inherit" : false,
      "properties" : [ {
        "key" : "apitest",
        "type" : "judge",
        "name" : "api测试通过率",
        "value_type" : "float",
        "value" : "0.5",
        "operator" : ">="
      } ]
    } ]
  } ]
}

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
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 ShowStrategySolution {

    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();
        ShowStrategyRequest request = new ShowStrategyRequest();
        request.withRuleSetId("{rule_set_id}");
        request.withDomainId("{domain_id}");
        try {
            ShowStrategyResponse response = client.showStrategy(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
# 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 = ShowStrategyRequest()
        request.rule_set_id = "{rule_set_id}"
        request.domain_id = "{domain_id}"
        response = client.show_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
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.ShowStrategyRequest{}
	request.RuleSetId = "{rule_set_id}"
	request.DomainId = "{domain_id}"
	response, err := client.ShowStrategy(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

错误码

请参见错误码

相关文档