创建或更新记录器 - CreateTrackerConfig
功能介绍
创建或更新资源记录器,只能存在一个资源记录器。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
PUT /v1/resource-manager/domains/{domain_id}/tracker-config
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 账号ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符。 默认取值: 不涉及 最大长度:36 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 调用者token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| channel | 是 | ChannelConfigBody object | 参数解释: tracker通道配置。 约束限制: 不涉及 |
| selector | 是 | SelectorConfigBody object | 参数解释: tracker选择器。 约束限制: 不涉及 |
| retention_period_in_days | 否 | Integer | 参数解释: 存储历史信息的天数 约束限制: 不涉及 取值范围: 30-2557 默认取值: 180 |
| agency_name | 是 | String | 参数解释: IAM委托名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| smn | 否 | TrackerSMNChannelConfigBody object | 参数解释: SMN通道设置对象。 约束限制: 跨账号授予SMN主题发送通知的权限请参考《用户指南- 资源记录器- 开启/配置/修改资源记录器》中的“跨账号授权”内容。 |
| obs | 否 | TrackerOBSChannelConfigBody object | OBS设置对象。跨账号授予OBS桶转储文件的权限请参考《用户指南- 资源记录器- 开启/配置/修改资源记录器》中的“跨账号授权”内容。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 是 | String | 参数解释: SMN主题的区域id。 约束限制: topic_urn所在的区域id 取值范围: 不涉及 默认取值: 不涉及 |
| project_id | 是 | String | 参数解释: 项目id。 约束限制: topic_urn所在的区域的项目id 取值范围: 不涉及 默认取值: 不涉及 |
| topic_urn | 是 | String | 参数解释: SMN主题urn。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| bucket_name | 是 | String | 参数解释: OBS桶名称。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“.”组成,且长度为[3~63]个字符 默认取值: 不涉及 最大长度:63 |
| bucket_prefix | 否 | String | 参数解释: OBS桶前缀。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“/”组成,且长度为[1~256]个字符 默认取值: 不涉及 最大长度:256 |
| region_id | 是 | String | 参数解释: 区域id。 约束限制: OBS桶所在的区域id 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
操作成功。
状态码: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 | 参数解释: 错误消息内容。 取值范围: 不涉及 |
请求示例
创建资源记录器,并开启消息推送与内容存储。
PUT /v1/resource-manager/domains/{domain_id}/tracker-config
{
"channel" : {
"smn" : {
"region_id" : "regionid1",
"project_id" : "39c2af998c334ed6bcbb75b27318f7b5",
"topic_urn" : "urn:smn:regionid1:39c2af998c334ed6bcbb75b27318f7b5:resource-manager-test"
},
"obs" : {
"bucket_name" : "config-snapshot",
"region_id" : "regionid1",
"bucket_prefix" : "log_dir"
}
},
"selector" : {
"all_supported" : true,
"resource_types" : [ ]
},
"agency_name" : "rms_tracker_agency",
"retention_period_in_days" : 2557
} 响应示例
无
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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | 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.*; import java.util.List; import java.util.ArrayList; public class CreateTrackerConfigSolution { 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(); CreateTrackerConfigRequest request = new CreateTrackerConfigRequest(); TrackerConfigBody body = new TrackerConfigBody(); SelectorConfigBody selectorbody = new SelectorConfigBody(); selectorbody.withAllSupported(true); TrackerOBSChannelConfigBody obsChannel = new TrackerOBSChannelConfigBody(); obsChannel.withBucketName("config-snapshot") .withBucketPrefix("log_dir") .withRegionId("regionid1"); TrackerSMNChannelConfigBody smnChannel = new TrackerSMNChannelConfigBody(); smnChannel.withRegionId("regionid1") .withProjectId("39c2af998c334ed6bcbb75b27318f7b5") .withTopicUrn("urn:smn:regionid1:39c2af998c334ed6bcbb75b27318f7b5:resource-manager-test"); ChannelConfigBody channelbody = new ChannelConfigBody(); channelbody.withSmn(smnChannel) .withObs(obsChannel); body.withAgencyName("rms_tracker_agency"); body.withRetentionPeriodInDays(2557); body.withSelector(selectorbody); body.withChannel(channelbody); request.withBody(body); try { CreateTrackerConfigResponse response = client.createTrackerConfig(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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | # 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 = CreateTrackerConfigRequest() selectorbody = SelectorConfigBody( all_supported=True ) obsChannel = TrackerOBSChannelConfigBody( bucket_name="config-snapshot", bucket_prefix="log_dir", region_id="regionid1" ) smnChannel = TrackerSMNChannelConfigBody( region_id="regionid1", project_id="39c2af998c334ed6bcbb75b27318f7b5", topic_urn="urn:smn:regionid1:39c2af998c334ed6bcbb75b27318f7b5:resource-manager-test" ) channelbody = ChannelConfigBody( smn=smnChannel, obs=obsChannel ) request.body = TrackerConfigBody( agency_name="rms_tracker_agency", retention_period_in_days=2557, selector=selectorbody, channel=channelbody ) response = client.create_tracker_config(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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | 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.CreateTrackerConfigRequest{} selectorbody := &model.SelectorConfigBody{ AllSupported: true, } bucketPrefixObs:= "log_dir" obsChannel := &model.TrackerObsChannelConfigBody{ BucketName: "config-snapshot", BucketPrefix: &bucketPrefixObs, RegionId: "regionid1", } smnChannel := &model.TrackerSmnChannelConfigBody{ RegionId: "regionid1", ProjectId: "39c2af998c334ed6bcbb75b27318f7b5", TopicUrn: "urn:smn:regionid1:39c2af998c334ed6bcbb75b27318f7b5:resource-manager-test", } channelbody := &model.ChannelConfigBody{ Smn: smnChannel, Obs: obsChannel, } retentionPeriodInDaysTrackerConfigBody:= int32(2557) request.Body = &model.TrackerConfigBody{ AgencyName: "rms_tracker_agency", RetentionPeriodInDays: &retentionPeriodInDaysTrackerConfigBody, Selector: selectorbody, Channel: channelbody, } response, err := client.CreateTrackerConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功。 |
| 400 | 输入参数不合法。 |
| 403 | 用户认证失败,或没有操作权限。 |
| 404 | 资源未找到。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。