# 查询项目级策略详情 - ShowProjectStrategy #### 功能介绍 查询项目级策略详情 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI GET /v2/{project_id}/rule-sets/{rule_set_id}/gray/detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | rule_set_id | 是 | String | **参数解释**： 策略ID，策略的唯一标识，通过[获取策略列表](https://support.huaweicloud.com/api-pipeline/ListStrategy.html)接口获取，data.id即为策略ID。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-pipeline/pipeline_03_0036.html)。 **约束限制**： 不涉及。 **取值范围**： 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 | **参数解释**： 规则实例集合。 **取值范围**： 不涉及。 | | level | String | **参数解释**： 规则实例生效级别。 **取值范围**： 不涉及。 | | is_public | Boolean | **参数解释**： 规则实例是否系统级。 **取值范围**： - true：规则实例是系统级。 - false：规则实例不是系统级。 | | is_legacy | Boolean | **参数解释**： 规则实例是1.0的数据。 **取值范围**： - true：规则实例是1.0的数据。 - false：规则实例不是1.0的数据。 - null: 规则实例不是1.0的数据。 | 表3RuleInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释**： 父级实例属性。仅通过继承生成的项目级策略拥有，租户级策略不涉及。 **取值范围**： 不涉及。 | | creator | String | **参数解释**： 规则创建人。 **取值范围**： 不涉及。 | | create_time | String | **参数解释**： 规则创建时间。 **取值范围**： 不涉及。 | | updater | String | **参数解释**： 规则最近更新人。 **取值范围**： 不涉及。 | | update_time | String | **参数解释**： 规则最近更新时间。 **取值范围**： 不涉及。 | 表4RuleInstanceContent | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_name | String | **参数解释**： 分组名称。 **取值范围**： 不涉及。 | | editable | Boolean | **参数解释**： 是否可编辑。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 分组类型。 **取值范围**： 不涉及。 | | can_modify_when_inherit | Boolean | **参数解释**： 继承后的子策略是否可以修改阈值。 **取值范围**： - true：可以修改阈值。 - false：不可以修改阈值。 | | properties | Array of [RuleInstanceProperty] objects | **参数解释**： 规则属性列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表5RuleInstanceProperty | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 规则属性键。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 规则类型。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 展示名称。 **取值范围**： 不涉及。 | | operator | String | **参数解释**： 比较运算符。 **取值范围**： 不涉及。 | | value | String | **参数解释**： 属性值。 **取值范围**： 不涉及。 | | value_type | String | **参数解释**： 数据类型。 **取值范围**： - float：数值型。 - string：字符型。 | | is_valid | Boolean | **参数解释**： 是否生效。 **取值范围**： - true：生效。 - false：不生效。 | 表6RuleSet | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 规则模板实例ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 规则模板实例名称。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 规则实例类型。 **取值范围**： 不涉及。 | | version | String | **参数解释**： 规则实例版本。 **取值范围**： 不涉及。 | | is_valid | Boolean | **参数解释**： 规则实例是否生效。 **取值范围**： - true：规则生效。 - false：规则不生效。 | | level | String | **参数解释**： 规则实例生效级别。 **取值范围**： 不涉及。 | | is_public | Boolean | **参数解释**： 规则实例是否系统级。 **取值范围**： - true：规则实例是系统级。 - false：规则实例不是系统级。 | | is_legacy | Boolean | **参数解释**： 规则实例是1.0的数据。 **取值范围**： - true：规则实例是1.0的数据。 - false：规则实例不是1.0的数据。 - null：规则实例不是1.0的数据。 | | creator | String | **参数解释**： 策略创建人。 **取值范围**： 不涉及。 | | create_time | String | **参数解释**： 策略创建时间。 **取值范围**： 不涉及。 | | updater | String | **参数解释**： 策略最近更新人。 **取值范围**： 不涉及。 | | update_time | String | **参数解释**： 策略最近更新时间。 **取值范围**： 不涉及。 | | rule_instances | Array of [RuleInstance] objects | **参数解释**： 规则实例集合。 **取值范围**： 不涉及。 | **状态码：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代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartspipeline.NewCodeArtsPipelineClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsPipeline/sdk?api=ShowProjectStrategy)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。