Updated on 2024-06-14 GMT+08:00

Querying Project-level Policy Details

Function

This API is used to query the project-level policy details.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

rule_set_id

Yes

String

Policy ID.

project_id

Yes

String

Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

id

String

Rule template instance ID.

name

String

Rule template instance name.

type

String

Type.

version

String

Version.

creator

String

Creator.

create_time

String

Creation time.

updater

String

Last updater.

update_time

String

Last update time.

is_valid

Boolean

Whether it is effective.

rule_instances

Array of RuleInstance objects

Rule instance set.

Table 3 RuleInstance

Parameter

Type

Description

id

String

Rule instance ID.

type

String

Rule type ID.

name

String

Rule name.

version

String

Rule version.

plugin_id

String

Extension ID.

plugin_name

String

Extension name.

plugin_version

String

Extension version.

is_valid

Boolean

Whether it is effective.

editable

Boolean

Editable or not.

content

Array of RuleInstanceContent objects

Rule attribute list.

parent

RuleSet object

Basic information of parent rule template.

Table 4 RuleInstanceContent

Parameter

Type

Description

group_name

String

Group name.

type

String

Group type.

can_modify_when_inherit

Boolean

Whether thresholds of an inherited policy can be modified.

properties

Array of RuleInstanceProperty objects

Rule attribute list.

Table 5 RuleInstanceProperty

Parameter

Type

Description

key

String

Attribute key.

type

String

Type.

name

String

Display name.

operator

String

Comparison operators.

value

String

Attribute value.

value_type

String

Data type.

Table 6 RuleSet

Parameter

Type

Description

id

String

Rule template instance ID.

name

String

Rule template instance name.

type

String

Type.

version

String

Version.

operator

String

Latest operator.

operate_time

Long

Latest operation time.

is_valid

Boolean

Whether it is effective.

level

String

Tenant-level, project-level

is_public

Boolean

System level or not.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

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

Example Responses

Status code: 200

OK

{
  "id" : "f9228e23118c4fa5a9c86493ea0cffc2",
  "name" : "System-defined policies",
  "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 test pass rate access control",
    "is_valid" : false,
    "version" : "90cd646fa8cd7f91d38e592dbb76a62e",
    "plugin_id" : "official_devcloud_apiTest",
    "plugin_name" : "official_devcloud_apiTest",
    "plugin_version" : "0.0.1",
    "content" : [ {
      "group_name" : "API test pass rate access control",
      "can_modify_when_inherit" : true,
      "properties" : [ {
        "key" : "apitest",
        "type" : "judge",
        "name" : "API test pass rate",
        "value_type" : "float",
        "value" : "1.0",
        "operator" : ">="
      } ]
    } ]
  } ]
}

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
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();
        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
# 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()
        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
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{}
	response, err := client.ShowProjectStrategy(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.