Help Center> Config> API Reference> APIs> Compliance> Querying All Built-in Policies
Updated on 2024-03-18 GMT+08:00

Querying All Built-in Policies

Function

This API is used to query all built-in policies.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/policy-definitions

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Specifies the language of the information to return. The default name is zh-cn, which can be zh-cn and en-us.

Default: zh-cn

X-Auth-Token

No

String

Specifies the invoker's token.

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

value

Array of PolicyDefinition objects

Specifies the policy definition list.

page_info

PageInfo object

Specifies the pagination object.

Table 3 PolicyDefinition

Parameter

Type

Description

id

String

Specifies the policy ID.

name

String

Specifies the policy name.

display_name

String

Specifies the policy display name.

policy_type

String

Specifies the policy type.

description

String

Specifies the description of the policy definition.

policy_rule_type

String

Specifies the syntax type of the policy.

policy_rule

Object

Specifies the policy rule.

trigger_type

String

Specifies the trigger type.

keywords

Array of strings

Specifies keywords.

default_resource_types

Array of default_resource_types objects

Specifies the list of default resource types.

parameters

Map<String,PolicyParameterDefinition>

Specifies the policy parameter.

Table 4 default_resource_types

Parameter

Type

Description

provider

String

Specifies the cloud service name.

type

String

Specifies the resource type.

Table 5 PolicyParameterDefinition

Parameter

Type

Description

name

String

Specifies the name of the policy parameter.

description

String

Specifies the description of the policy parameter.

allowed_values

Array of objects

Specifies the allowed values of the policy parameter.

default_value

String

Specifies the default value of the policy parameter.

minimum

Float

Specifies the minimum value of the policy parameter.

maximum

Float

Specifies the maximum value of the policy parameter.

min_items

Integer

Specifies the minimum number of the policy parameter.

max_items

Integer

Specifies the maximum number of the policy parameter.

min_length

Integer

Specifies the minimum string length for policy parameters or for each item.

max_length

Integer

Specifies the maximum string length for policy parameters or for each item.

pattern

String

Specifies the pattern for policy parameters or for each item.

type

String

Specifies the type of the policy parameter.

Table 6 PageInfo

Parameter

Type

Description

current_count

Integer

Specifies the resource quantity on the current page.

Minimum: 0

Maximum: 200

next_marker

String

Specifies the marker value of the next page.

Minimum: 4

Maximum: 400

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

None

Example Responses

Status code: 200

Operation succeeded.

{
  "value" : [ {
    "id" : "5fa365476eed194ccb2c04d1",
    "name" : "volumes-encrypted-check",
    "policy_type" : "builtin",
    "description" : "An EVS disk is non-compliant if it has been mounted but not encrypted.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "evs"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "volumes"
      }, {
        "value" : "${resource().properties.status}",
        "comparator" : "equals",
        "pattern" : "in-use"
      }, {
        "anyOf" : [ {
          "value" : "${resource().properties.metadata}",
          "comparator" : "notContainsKey",
          "pattern" : "systemEncrypted"
        }, {
          "value" : "${resource().properties.metadata.systemEncrypted}",
          "comparator" : "equals",
          "pattern" : "0"
        } ]
      } ]
    },
    "keywords" : [ "evs", "ecs" ],
    "parameters" : { }
  }, {
    "id" : "5fa9f89b6eed194ccb2c04db",
    "name" : "required-tag-check",
    "policy_type" : "builtin",
    "description" : "A resource is non-compliant if it does not have a specified tag.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "anyOf" : [ {
        "value" : "${contains(resource().tags, parameters('specifiedTagKey'))}",
        "comparator" : "equals",
        "pattern" : false
      }, {
        "allOf" : [ {
          "value" : "${length(parameters('specifiedTagValue'))}",
          "comparator" : "greater",
          "pattern" : 0
        }, {
          "value" : "${getValue(resource().tags, parameters('specifiedTagKey'))}",
          "comparator" : "notIn",
          "pattern" : "${parameters('specifiedTagValue')}"
        } ]
      } ]
    },
    "keywords" : [ "tag" ],
    "parameters" : {
      "specifiedTagKey" : {
        "name" : null,
        "description" : "the specified tag key.",
        "allowed_values" : null,
        "default_value" : null,
        "type" : "String"
      },
      "specifiedTagValue" : {
        "name" : null,
        "description" : "The list of allowed tag value, permit all if empty.",
        "allowed_values" : null,
        "default_value" : null,
        "type" : "Array"
      }
    }
  }, {
    "id" : "5fa265c0aa1e6afc05a0ff07",
    "name" : "allowed-images-by-id",
    "policy_type" : "builtin",
    "description" : "An ECS is non-compliant if its image ID is not in the specified image ID list.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "ecs"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "cloudservers"
      }, {
        "value" : "${resource().properties.metadata.meteringImageId}",
        "comparator" : "notIn",
        "pattern" : "${parameters('listOfAllowedImages')}"
      } ]
    },
    "keywords" : [ "ecs", "ims" ],
    "parameters" : {
      "listOfAllowedImages" : {
        "name" : null,
        "description" : "The list of allowed image IDs.",
        "allowed_values" : null,
        "default_value" : null,
        "type" : "Array"
      }
    }
  }, {
    "id" : "5fa36558aa1e6afc05a3d0a7",
    "name" : "volume-inuse-check",
    "policy_type" : "builtin",
    "description" : "An EVS disk is non-compliant if it is not mounted to a cloud server.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "evs"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "volumes"
      }, {
        "value" : "${resource().properties.status}",
        "comparator" : "equals",
        "pattern" : "available"
      } ]
    },
    "keywords" : [ "evs" ],
    "parameters" : { }
  }, {
    "id" : "5fa3a1196eed194ccb2c04d7",
    "name" : "allowed_volume_specs",
    "policy_type" : "builtin",
    "description" : "An EVS disk is non-compliant if its type is not in the specified disk type list.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "evs"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "volumes"
      }, {
        "value" : "${resource().properties.volumeType}",
        "comparator" : "notIn",
        "pattern" : "${parameters('listOfAllowedSpecs')}"
      } ]
    },
    "keywords" : [ "evs" ],
    "parameters" : {
      "listOfAllowedSpecs" : {
        "name" : null,
        "description" : "The list of allowed disk specifications.",
        "allowed_values" : null,
        "default_value" : null,
        "type" : "Array"
      }
    }
  }, {
    "id" : "5f8d549bffeecc14f1fb522a",
    "name" : "allowed_ecs_flavors",
    "policy_type" : "builtin",
    "description" : "An ECS is non-compliant if its flavor is not in the specified flavor list.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "ecs"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "cloudservers"
      }, {
        "value" : "${resource().properties.flavor.name}",
        "comparator" : "notIn",
        "pattern" : "${parameters('listOfAllowedFlavors')}"
      } ]
    },
    "keywords" : [ "ecs" ],
    "parameters" : {
      "listOfAllowedFlavors" : {
        "name" : null,
        "description" : "The list of allowed flavor types.",
        "allowed_values" : null,
        "default_value" : null,
        "type" : "Array"
      }
    }
  }, {
    "id" : "5fa3a1196eed194ccb2c04d5",
    "name" : "eip-unbound-check",
    "policy_type" : "builtin",
    "description" : "An EIP is non-compliant if it is not bound to any resources.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "vpc"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "publicips"
      }, {
        "value" : "${resource().properties.status}",
        "comparator" : "equals",
        "pattern" : "DOWN"
      } ]
    },
    "keywords" : [ "vpc" ],
    "parameters" : { }
  }, {
    "id" : "5f8d5428ffeecc14f1fb5205",
    "name" : "ecs-instance-no-public-ip",
    "policy_type" : "builtin",
    "description" : "An ECS is non-compliant if it has an EIP.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "ecs"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "cloudservers"
      }, {
        "value" : "${length(filter(resource().properties.addresses, lambda x: equals(x.OsExtIpsType, 'floating')))}",
        "comparator" : "greater",
        "pattern" : 0
      } ]
    },
    "keywords" : [ "ecs" ],
    "parameters" : { }
  }, {
    "id" : "5fa265c0aa1e6afc05a0ff10",
    "name" : "ecs-instance-in-vpc",
    "policy_type" : "builtin",
    "description" : "An ECS is non-compliant if it does not belong to a specified VPC.",
    "policy_rule_type" : "dsl",
    "policy_rule" : {
      "allOf" : [ {
        "value" : "${resource().provider}",
        "comparator" : "equals",
        "pattern" : "ecs"
      }, {
        "value" : "${resource().type}",
        "comparator" : "equals",
        "pattern" : "cloudservers"
      }, {
        "value" : "${resource().properties.metadata.vpcId}",
        "comparator" : "notEquals",
        "pattern" : "${parameters('vpcId')}"
      } ]
    },
    "keywords" : [ "ecs", "vpc" ],
    "parameters" : {
      "vpcId" : {
        "name" : null,
        "description" : "VPC ID that contains the ECS instance.",
        "allowed_values" : null,
        "default_value" : null,
        "type" : "String"
      }
    }
  } ],
  "page_info" : {
    "current_count" : 9,
    "next_marker" : null
  }
}

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.GlobalCredentials;
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.config.v1.region.ConfigRegion;
import com.huaweicloud.sdk.config.v1.*;
import com.huaweicloud.sdk.config.v1.model.*;


public class ListBuiltInPolicyDefinitionsSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ConfigClient client = ConfigClient.newBuilder()
                .withCredential(auth)
                .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                .build();
        ListBuiltInPolicyDefinitionsRequest request = new ListBuiltInPolicyDefinitionsRequest();
        try {
            ListBuiltInPolicyDefinitionsResponse response = client.listBuiltInPolicyDefinitions(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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkconfig.v1 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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = ConfigClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListBuiltInPolicyDefinitionsRequest()
        response = client.list_built_in_policy_definitions(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/global"
    config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := config.NewConfigClient(
        config.ConfigClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListBuiltInPolicyDefinitionsRequest{}
	response, err := client.ListBuiltInPolicyDefinitions(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

Operation succeeded.

400

Invalid parameter.

403

Authentication failed or you do not have the operation permissions.

404

Resources not found.

500

Server error.

Error Codes

See Error Codes.