批量启用规则 - CreateAssociatedResourceRules
功能介绍
按照规则和region来批量启用规则
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
tms:associatedResource:createRules
Write
-
-
-
- functiongraph:function:listFunctions
- functiongraph:function:createFunction
- functiongraph:trigger:createTrigger
- functiongraph:dependency:listDependencies
- functiongraph:dependency:createDependencyVersion
- functiongraph:function:updateFunctionConfig
- functiongraph:function:invokeAsync
URI
POST /v2/tms/associated-resources/rules/batch-create
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| rules | 否 | Array of ReqAssociatedResourceRule objects | 参数解释: 批量启用的规则信息,每一个元素是ReqAssociatedResourceRule对象,包含规则配置名称、规则区域等。 约束限制: 不超过10条。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| setting_name | 是 | String | 参数解释: 规则的配置名称。 约束限制: 需要是TMS支持的规则配置的名称。请使用“查询当前规则的配置列表”接口获取支持配置信息。 取值范围: 只能由英文字母、数字及“_”、“-”、“.”、“:”组成,且长度为1~128个字符。 默认取值: 不涉及 |
| tag_keys | 否 | Array of strings | 参数解释: 规则作用标签的范围,每一个元素表示规则生效的标签键。如果为空则表示对全部标签生效。 约束限制: 标签键的数量不超过30个。 |
| existing_resource_status | 否 | String | 参数解释: 特性开关,规则是否在存量资源生效。 约束限制: 每次开启会执行一次存量资源的同步操作。 取值范围: 默认取值: disable |
| auto_delete_status | 否 | String | 参数解释: 特性开关,主资源与子资源关系解除后是否自动删除子资源中与主资源标签键一致的标签。 约束限制: 需要规则配置支持时生效。 取值范围: 默认取值: disable |
| region_id | 是 | String | 参数解释: 规则生效的区域ID。请使用“查询当前规则的配置列表”接口获取支持配置信息。 约束限制: 输入规则配置支持的区域ID。 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rules | Array of AssociatedResourceRule objects | 参数解释: 本次操作成功的规则信息。 |
| errors | Array of ErrorInfo objects | 参数解释: 本次操作失败的规则信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| setting_name | String | 参数解释: 规则的配置名称。 取值范围: 只能由英文字母、数字及“_”、“-”、“.”、“:”组成,且长度为1~128个字符。 |
| tag_keys | Array of strings | 参数解释: 规则作用标签的范围。如果为空则表示对全部标签生效。 |
| existing_resource_status | String | 参数解释: 特性开关,规则是否在存量资源生效。 取值范围: |
| auto_delete_status | String | 参数解释: 特性开关,主资源与子资源关系解除后是否自动删除子资源中与主资源标签键一致的标签。 取值范围: |
| status | String | 参数解释: 规则状态。 取值范围: |
| region_id | String | 参数解释: 规则生效的区域ID。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。请到“错误码”页面查询对应云服务的错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及 |
| setting_name | String | 参数解释: 规则的配置名称。 取值范围: 只能由英文字母、数字及“_”、“-”、“.”、“:”组成,且长度为1~128个字符。 |
| region_id | String | 参数解释: 规则操作失败的区域ID。 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 参数解释: 响应的错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。请到“错误码”页面查询对应云服务的错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 参数解释: 响应的错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。请到“错误码”页面查询对应云服务的错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 参数解释: 响应的错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。请到“错误码”页面查询对应云服务的错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 参数解释: 响应的错误信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。请到“错误码”页面查询对应云服务的错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
在指定的区域启用某个规则
POST https://{Endpoint}/v2/tms/associated-resources/rules/batch-create
{
"rules" : [ {
"setting_name" : "rule:AttachVolume-DetachVolume-TagServer:Ecs-Cloudservers:Evs-Volumes",
"tag_keys" : [ "key1", "key2" ],
"existing_resource_status" : "enable",
"auto_delete_status" : "enable",
"region_id" : "cn-north-4"
} ]
} 响应示例
状态码:200
批量启用规则请求被成功处理
{
"rules" : [ {
"setting_name" : "rule:AttachVolume-DetachVolume-TagServer:Ecs-Cloudservers:Evs-Volumes",
"tag_keys" : [ "key1", "key2" ],
"status" : "enabled",
"existing_resource_status" : "enabled",
"auto_delete_status" : "enabled",
"region_id" : "cn-north-7"
} ],
"errors" : [ {
"error_code" : "TMS.0002",
"error_msg" : "Maximum 100 keys allowed.",
"setting_name" : "rule:AssociatePublicip-DisassociatePublicip-TagServer:Ecs-Cloudservers:Vpc-Publicips",
"region_id" : "cn-north-7"
} ]
} SDK代码示例
SDK代码示例如下。
Java
在指定的区域启用某个规则
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 | 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.tms.v1.region.TmsRegion; import com.huaweicloud.sdk.tms.v1.*; import com.huaweicloud.sdk.tms.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateAssociatedResourceRulesSolution { 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); TmsClient client = TmsClient.newBuilder() .withCredential(auth) .withRegion(TmsRegion.valueOf("<YOUR REGION>")) .build(); CreateAssociatedResourceRulesRequest request = new CreateAssociatedResourceRulesRequest(); ReqCreateAssociatedResourceRules body = new ReqCreateAssociatedResourceRules(); List<String> listRulesTagKeys = new ArrayList<>(); listRulesTagKeys.add("key1"); listRulesTagKeys.add("key2"); List<ReqAssociatedResourceRule> listbodyRules = new ArrayList<>(); listbodyRules.add( new ReqAssociatedResourceRule() .withSettingName("rule:AttachVolume-DetachVolume-TagServer:Ecs-Cloudservers:Evs-Volumes") .withTagKeys(listRulesTagKeys) .withExistingResourceStatus("enable") .withAutoDeleteStatus("enable") .withRegionId("cn-north-4") ); body.withRules(listbodyRules); request.withBody(body); try { CreateAssociatedResourceRulesResponse response = client.createAssociatedResourceRules(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
在指定的区域启用某个规则
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdktms.v1.region.tms_region import TmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdktms.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 = TmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(TmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateAssociatedResourceRulesRequest() listTagKeysRules = [ "key1", "key2" ] listRulesbody = [ ReqAssociatedResourceRule( setting_name="rule:AttachVolume-DetachVolume-TagServer:Ecs-Cloudservers:Evs-Volumes", tag_keys=listTagKeysRules, existing_resource_status="enable", auto_delete_status="enable", region_id="cn-north-4" ) ] request.body = ReqCreateAssociatedResourceRules( rules=listRulesbody ) response = client.create_associated_resource_rules(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
在指定的区域启用某个规则
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" tms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/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 := tms.TmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := tms.NewTmsClient(hcClient) request := &model.CreateAssociatedResourceRulesRequest{} var listTagKeysRules = []string{ "key1", "key2", } existingResourceStatusRules:= "enable" autoDeleteStatusRules:= "enable" var listRulesbody = []model.ReqAssociatedResourceRule{ { SettingName: "rule:AttachVolume-DetachVolume-TagServer:Ecs-Cloudservers:Evs-Volumes", TagKeys: &listTagKeysRules, ExistingResourceStatus: &existingResourceStatusRules, AutoDeleteStatus: &autoDeleteStatusRules, RegionId: "cn-north-4", }, } request.Body = &model.ReqCreateAssociatedResourceRules{ Rules: &listRulesbody, } response, err := client.CreateAssociatedResourceRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 批量启用规则请求被成功处理 |
| 400 | 入参错误时返回 |
| 401 | token鉴权失败时返回 |
| 403 | 权限不足或网关流控拦截时 |
| 500 | 出现系统错误时返回 |
错误码
请参见错误码。