更新时间:2025-08-19 GMT+08:00
分享

查询项目级策略详情

功能介绍

查询项目级策略详情

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/rule-sets/{rule_set_id}/gray/detail

表1 路径参数

参数

是否必选

参数类型

描述

rule_set_id

String

参数解释

策略ID,策略的唯一标识,通过获取策略列表接口获取,data.id即为策略ID。

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释

规则模板实例ID。

取值范围

32位字符,由数字和字母组成。

name

String

参数解释

规则模板实例名称。

取值范围

不涉及。

type

String

参数解释

规则模板类型。

取值范围

不涉及。

version

String

参数解释

规则模板策略。

取值范围

不涉及。

creator

String

参数解释

策略创建人。

取值范围

不涉及。

create_time

String

参数解释

策略创建时间。

取值范围

不涉及。

updater

String

参数解释

策略最近更新人。

取值范围

不涉及。

update_time

String

参数解释

策略最近更新时间。

取值范围

不涉及。

is_valid

Boolean

参数解释

策略是否生效。

取值范围

  • true:策略生效。

  • false:策略不生效。

rule_instances

Array of RuleInstance objects

参数解释

规则实例集合。

取值范围

不涉及。

表3 RuleInstance

参数

参数类型

描述

id

String

参数解释

规则实例ID。

取值范围

32位字符,由数字和字母组成。

type

String

参数解释

规则类型。

取值范围

不涉及。

name

String

参数解释

规则名称。

取值范围

不涉及。

version

String

参数解释

规则版本。

取值范围

不涉及。

plugin_id

String

参数解释

插件ID。

取值范围

不涉及。

plugin_name

String

参数解释

插件名称。

取值范围

不涉及。

plugin_version

String

参数解释

插件版本号。

取值范围

不涉及。

is_valid

Boolean

参数解释

规则是否生效。

取值范围

  • true:规则生效。

  • false:规则不生效。

editable

Boolean

参数解释

规则是否可编辑。

取值范围

  • true:规则可编辑。

  • false:规则不可编辑。

content

Array of RuleInstanceContent objects

参数解释

规则实例集合。

取值范围

不涉及。

parent

RuleSet object

参数解释

规则实例集合。

取值范围

不涉及。

表4 RuleInstanceContent

参数

参数类型

描述

group_name

String

参数解释

分组名称。

取值范围

不涉及。

type

String

参数解释

分组类型。

取值范围

不涉及。

can_modify_when_inherit

Boolean

参数解释

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

取值范围

  • true:可以修改阈值。

  • false:不可以修改阈值。

properties

Array of RuleInstanceProperty objects

参数解释

规则属性列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表5 RuleInstanceProperty

参数

参数类型

描述

key

String

参数解释

规则属性键。

取值范围

不涉及。

type

String

参数解释

规则类型。

取值范围

不涉及。

name

String

参数解释

展示名称。

取值范围

不涉及。

operator

String

参数解释

比较运算符。

取值范围

不涉及。

value

String

参数解释

属性值。

取值范围

不涉及。

value_type

String

参数解释

数据类型。

取值范围

不涉及。

表6 RuleSet

参数

参数类型

描述

id

String

参数解释

规则模板实例ID。

取值范围

不涉及。

name

String

参数解释

规则模板实例名称。

取值范围

不涉及。

type

String

参数解释

规则实例类型。

取值范围

不涉及。

version

String

参数解释

规则实例版本。

取值范围

不涉及。

operator

String

参数解释

规则实例最近操作人。

取值范围

不涉及。

operate_time

Long

参数解释

规则实例最近操作时间。

取值范围

不涉及。

is_valid

Boolean

参数解释

规则实例是否生效。

取值范围

  • true:规则生效。

  • false:规则不生效。

level

String

参数解释

规则实例生效级别。

取值范围

不涉及。

is_public

Boolean

参数解释

规则实例是否系统级。

取值范围

  • true:规则实例是系统级。

  • false:规则实例不是系统级。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求示例

GET https://{endpoint}/v2/d80a8a6530324b7bac972cbb8a9f28ec/rule-sets/f9228e23118c4fa5a9c86493ea0cffc2/gray/detail

响应示例

状态码:200

OK

{
  "id" : "f9228e23118c4fa5a9c86493ea0cffc2",
  "name" : "系统策略",
  "version" : "ace33a17a73442e398fedc123d047da2",
  "is_valid" : true,
  "creator" : "system",
  "create_time" : "2022-11-14T16:12:12",
  "updater" : "system",
  "update_time" : "2023-03-13T20:40:56",
  "rule_instances" : [ {
    "id" : "ee207826d1773f9122857474af314e48",
    "type" : "Gate",
    "name" : "API测试通过率门禁",
    "is_valid" : false,
    "version" : "90cd646fa8cd7f91d38e592dbb76a62e",
    "plugin_id" : "official_devcloud_apiTest",
    "plugin_name" : "official_devcloud_apiTest",
    "plugin_version" : "0.0.1",
    "content" : [ {
      "group_name" : "API测试通过率门禁",
      "can_modify_when_inherit" : true,
      "properties" : [ {
        "key" : "apitest",
        "type" : "judge",
        "name" : "api测试通过率",
        "value_type" : "float",
        "value" : "1.0",
        "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 ShowProjectStrategySolution {

    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();
        ShowProjectStrategyRequest request = new ShowProjectStrategyRequest();
        request.withRuleSetId("{rule_set_id}");
        request.withProjectId("{project_id}");
        try {
            ShowProjectStrategyResponse response = client.showProjectStrategy(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 = ShowProjectStrategyRequest()
        request.rule_set_id = "{rule_set_id}"
        request.project_id = "{project_id}"
        response = client.show_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
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.ShowProjectStrategyRequest{}
	request.RuleSetId = "{rule_set_id}"
	request.ProjectId = "{project_id}"
	response, err := client.ShowProjectStrategy(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

错误码

请参见错误码

相关文档