为指定账号组创建投递渠道,将资源数据投递到日志服务SLS、对象存储OSS或轻量消息队列(原 MNS)进行储存。
接口说明
背景信息
-
投递到日志服务 SLS
当您将资源的配置变更历史、不合规事件和定时快照投递到日志服务 SLS 的日志库时,需要先创建日志项目(Project)和日志库(Logstore),才能查询和分析日志。关于 JSON 格式文件的内容示例,请参见资源配置变更历史内容示例、资源不合规事件内容示例和资源定时快照内容示例。
-
投递到对象存储 OSS
当您将资源的定时快照或配置变更历史投递到对象存储 OSS 的指定地址时,需要先创建存储空间(Bucket),才能查看或下载 JSON 格式文件。关于 JSON 格式文件的内容示例,请参见资源定时快照内容示例和资源配置变更历史内容示例。
-
投递到轻量消息队列(原 MNS)
当您将资源配置变更历史和资源不合规事件投递到轻量消息队列(原 MNS)的指定主题时,需要先创建主题,才能设置主题的推送方式和内容。关于 JSON 格式文件的内容示例,请参见资源配置变更历史内容示例和资源不合规事件内容示例。
使用限制
每个账号组中最多可以创建 5 个投递渠道。
使用说明
本文将提供一个示例,为账号组ca-a4e5626622af0079****
创建一个投递渠道类型为OSS
和投递渠道目标地址 ARN 为acs:oss:cn-shanghai:100931896542****:new-bucket
的投递渠道。返回结果显示创建投递渠道成功,投递渠道 ID 为cdc-8e45ff4e06a3a8****
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
config:CreateAggregateConfigDeliveryChannel | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AggregatorId | string | 是 | 账号组 ID。 关于如何获取账号组 ID,请参见 ListAggregators 。 | ca-a4e5626622af0079**** |
DeliveryChannelName | string | 否 | 投递渠道名称。 说明
如果未设置该参数,默认为空。
| testoss |
DeliveryChannelType | string | 是 | 投递渠道类型。取值:
| OSS |
DeliveryChannelTargetArn | string | 是 | 投递渠道目标地址的 ARN。取值:
| acs:oss:cn-shanghai:100931896542****:new-bucket |
DeliveryChannelCondition | string | 否 | 投递渠道附加规则。当前支持 MNS 渠道的所有投递和 SLS 渠道的快照投递。
| [{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}] |
OversizedDataOSSTargetArn | string | 否 | 当投递数据超过投递渠道限制时,投递数据转存到对象存储 OSS 的目标存储空间。格式为 如果您未设置该参数,配置审计仅投递概要信息。 说明
仅支持投递渠道 SLS 和 MNS。日志服务 SLS 的投递渠道限制是 1 MB,轻量消息队列(原 MNS)的投递渠道限制是 64 KB。
| acs:oss:cn-shanghai:100931896542****:new-bucket |
Description | string | 否 | 投递渠道描述。 | My OSS delivery. |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。
| 1594295238-f9361358-5843-4294-8d30-b5183fac**** |
ConfigurationSnapshot | boolean | 否 | 是否接收资源定时快照。每天
说明
ConfigurationSnapshot (资源定时快照)和ConfigurationItemChangeNotification (配置变更历史)至少二选一。说明
ConfigurationSnapshot (资源定时快照)、ConfigurationItemChangeNotification (配置变更历史)和NonCompliantNotification (资源不合规事件)至少三选一。 | true |
CompliantSnapshot | boolean | 否 | 是否接收合规快照。配置审计向日志服务 SLS 投递资源合规和不合规信息。取值:
| false |
ConfigurationItemChangeNotification | boolean | 否 | 是否接收资源配置变更历史。当资源配置变更时,配置审计向对象存储 OSS、日志服务 SLS 或轻量消息队列(原 MNS)投递资源配置变更历史。取值:
说明
ConfigurationSnapshot (资源定时快照)和ConfigurationItemChangeNotification (配置变更历史)至少二选一。说明
ConfigurationSnapshot (资源定时快照)、ConfigurationItemChangeNotification (配置变更历史)和NonCompliantNotification (资源不合规事件)至少三选一。说明
ConfigurationItemChangeNotification (配置变更历史)和NonCompliantNotification (资源不合规事件)至少二选一。 | false |
NonCompliantNotification | boolean | 否 | 是否接收资源不合规事件。当资源不合规时,配置审计向日志服务 SLS 或轻量消息队列(原 MNS)投递资源不合规事件。取值:
说明
ConfigurationSnapshot (资源定时快照)、ConfigurationItemChangeNotification (配置变更历史)和NonCompliantNotification (资源不合规事件)至少三选一。说明
ConfigurationItemChangeNotification (配置变更历史)和NonCompliantNotification (资源不合规事件)至少二选一。 | false |
DeliverySnapshotTime | string | 否 | 资源定时快照每日开始投递的时间。 格式为 说明
当您开启资源定时快照投递时,可通过该参数自定义投递时间。如果您未设置该参数,则每天默认 04:00Z 和16:00Z 开始投递。
| 09:10Z |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG",
"DeliveryChannelId": "cdc-8e45ff4e06a3a8****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | DeliveryChannelNotExists | The delivery channel does not exist. | 投递渠道不存在。 |
400 | Invalid.DeliveryChannelAssumeRoleArn.Format | The specified format of DeliveryChannelAssumeRoleArn is invalid. | 参数DeliveryChannelAssumeRoleArn格式错误。 |
400 | Invalid.DeliveryChannelTargetArn.Format | The specified format of DeliveryChannelTargetArn is invalid. | 参数DeliveryChannelTargetArn格式错误。 |
400 | Invalid.DeliveryChannelCondition.Format | The specified format of DeliveryChannelCondition is invalid. | 参数DeliveryChannelCondition格式错误。 |
400 | MemberNotBelongToMaster | The specified member does not belong to your organization. | - |
400 | DeliveryChannelAccountNotSupport | Cross-account delivery that is not in the RD is not supported. | 暂不支持非资源目录内的跨账号投递。 |
400 | DeliveryChannelMnsUnreachable | The MNS topic is unreachable. | MNS Topic尝试投递失败。 |
400 | DeliveryChannelOssUnreachable | The OSS bucket is unreachable. | OSS Bucket尝试投递失败。 |
400 | DeliveryChannelSlsUnreachable | SLS logstore is unreachable. | - |
404 | AccountNotExisted | Your account does not exist. | - |
访问错误中心查看更多错误码。