查询单个内置策略 - ShowBuiltInPolicyDefinition
功能介绍
根据策略ID查询单个内置策略。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
rms:policyDefinitions:get
List
-
-
-
-
URI
GET /v1/resource-manager/policy-definitions/{policy_definition_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| policy_definition_id | 是 | String | 参数解释: 策略ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符 默认取值: 不涉及 最大长度:36 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 调用者token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Language | 否 | String | 参数描述: 选择接口返回的信息的语言。 约束限制: 不涉及 取值范围: 默认取值: zh-cn 缺省值:zh-cn |
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 策略id。 取值范围: 与路径参数policy_definition_id一致 |
| name | String | 参数解释: 策略名称。 取值范围: 不涉及 |
| display_name | String | 参数解释: 策略展示名。 取值范围: 不涉及 |
| policy_type | String | 参数解释: 策略类型。 取值范围: |
| description | String | 参数解释: 策略描述。 取值范围: 不涉及 |
| policy_rule_type | String | 参数解释: 策略语法类型。 取值范围: |
| policy_rule | Object | 参数解释: 策略规则。 |
| trigger_type | String | 参数解释: 触发器类型。 取值范围: |
| keywords | Array of strings | 参数解释: 关键词列表。 |
| default_resource_types | Array of default_resource_types objects | 参数解释: 默认资源类型列表。 |
| parameters | Map<String,PolicyParameterDefinition> | 参数解释: 策略需要的参数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| provider | String | 参数解释: 云服务名称 取值范围: 不涉及 |
| type | String | 参数解释: 资源类型。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 策略参数名称。 取值范围: 不涉及 |
| description | String | 参数解释: 策略参数描述。 取值范围: 不涉及 |
| allowed_values | Array of objects | 参数解释: 策略参数允许值列表。 |
| default_value | String | 参数解释: 策略参数默认值。 取值范围: 不涉及 |
| minimum | Float | 参数解释: 策略参数的最小值,当参数类型为Integer或Float时生效。 取值范围: 不涉及 |
| maximum | Float | 参数解释: 策略参数的最大值,当参数类型为Integer或Float时生效。 取值范围: 不涉及 |
| min_items | Integer | 参数解释: 策略参数的最小项数,当参数类型为Array时生效。 取值范围: 不涉及 |
| max_items | Integer | 参数解释: 策略参数的最大项数,当参数类型为Array时生效。 取值范围: 不涉及 |
| min_length | Integer | 参数解释: 策略参数的最小字符串长度或每项的最小字符串长度,当参数类型为String或Array时生效。 取值范围: 不涉及 |
| max_length | Integer | 参数解释: 策略参数的最大字符串长度或每项的最大字符串长度,当参数类型为String或Array时生效。 取值范围: 不涉及 |
| pattern | String | 参数解释: 策略参数的字符串正则要求或每项的字符串正则要求,当参数类型为String或Array时生效。 取值范围: 不涉及 |
| type | String | 参数解释: 策略参数类型。 取值范围: |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
请求示例
GET https://{endpoint}/v1/resource-manager/policy-definitions/5f8d5428ffeecc14f1fb5205 响应示例
状态码:200
操作成功。
{
"id" : "5f8d5428ffeecc14f1fb5205",
"name" : "ecs-instance-no-public-ip",
"display_name" : "已挂载的云硬盘开启加密",
"policy_type" : "builtin",
"description" : "ECS资源具有公网IP,视为“不合规”。",
"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" : { }
} 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 | 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 ShowBuiltInPolicyDefinitionSolution { 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(); ShowBuiltInPolicyDefinitionRequest request = new ShowBuiltInPolicyDefinitionRequest(); request.withPolicyDefinitionId("{policy_definition_id}"); try { ShowBuiltInPolicyDefinitionResponse response = client.showBuiltInPolicyDefinition(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 | # coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowBuiltInPolicyDefinitionRequest() request.policy_definition_id = "{policy_definition_id}" response = client.show_built_in_policy_definition(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 38 39 40 41 42 43 44 45 46 47 48 | 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := config.NewConfigClient(hcClient) request := &model.ShowBuiltInPolicyDefinitionRequest{} request.PolicyDefinitionId = "{policy_definition_id}" response, err := client.ShowBuiltInPolicyDefinition(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功。 |
| 400 | 输入参数不合法。 |
| 403 | 用户认证失败或没有操作权限。 |
| 404 | 策略未找到。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。