CreateConfigDeliveryChannel - 创建投递渠道

创建投递渠道,将资源数据投递到日志服务SLS、对象存储 OSS 或轻量消息队列(原 MNS)进行储存。

接口说明

背景信息

使用限制

最多可以创建 5 个投递渠道。

使用说明

本文将提供一个示例,创建一个投递渠道类型为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:CreateConfigDeliveryChannel

create

*Delivery

acs:config:*:{#accountId}:delivery/*

请求参数

名称

类型

必填

描述

示例值

DeliveryChannelName

string

投递渠道名称。

说明

如果未设置该参数,默认为空。

testoss

DeliveryChannelType

string

投递渠道类型。取值:

  • OSS:对象存储。

  • MNS:轻量消息队列(原 MNS)

  • SLS:日志服务。

OSS

DeliveryChannelTargetArn

string

投递渠道目标地址的 ARN。取值:

  • 当投递渠道为 OSS 时,格式为acs:oss:{RegionId}:{accountId}:{bucketName},例如:acs:oss:cn-shanghai:100931896542****:new-bucket

  • 当投递渠道为 MNS 时,格式为acs:mns:{RegionId}:{accountId}:/topics/{topicName},例如:acs:mns:cn-shanghai:100931896542****:/topics/topic1

  • 当投递渠道为 SLS 时,格式为acs:log:{RegionId}:{accountId}:project/{projectName}/logstore/{logstoreName},例如:acs:log:cn-shanghai:100931896542****:project/project1/logstore/logstore1

acs:oss:cn-shanghai:100931896542****:new-bucket

DeliveryChannelCondition

string

投递渠道附加规则,用于指定订阅内容过滤条件。

  • 如果您指定订阅合规事件的最低风险等级和资源类型,具体如下:

    • 订阅事件的最低风险等级为{"filterType":"RuleRiskLevel","value":"1","multiple":false}

      value表示您需要过滤的风险等级。取值:1 表示高风险,2 表示中风险,3 表示低风险。

      multiple表示该组过滤字段是否支持多指,风险等级只支持单值过滤,即投递合规事件类型内容的multiple字段只可填写false

    • 订阅事件的资源类型为{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}

      values表示您需要订阅事件的资源类型,是一个资源类型的 JSON 数组。 例如: [{"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}]

      multiple表示该组过滤字段是否支持多指,资源类型支持多值过滤,选中多种资源类型时,multiple字段可填写true

    • 也可以同时指定风险等级和资源类型,例如: [{"filterType":"RuleRiskLevel","value":"2","multiple":false},{"filterType":"ResourceType","values":["ACS::CDN::Domain","ACS::ActionTrail::Trail"],"multiple":true}]

  • 如果您指定订阅资源配置投递的资源类型,资源类型为{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}

    values表示您需要投递的资源类型,是一个资源类型的 JSON 数组。 例如: [{"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}]

[{"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 的目标存储空间。格式为acs:oss:{RegionId}:{accountId}:{bucketName}

如果您未设置该参数,配置审计仅投递概要信息。

说明

仅支持投递渠道 SLS 和 MNS。日志服务 SLS 的投递渠道限制是 1 MB,轻量消息队列(原 MNS)的投递渠道限制是 64 KB。

acs:oss:cn-shanghai:100931896542****:new-bucket

Description

string

投递渠道描述。

My OSS delivery.

ClientToken

string

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。

ClientToken只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

1594295238-f9361358-5843-4294-8d30-b5183fac****

ConfigurationSnapshot

boolean

是否接收资源定时快照。每天04:00Z16:00Z(UTC 时间),配置审计定时向对象存储 OSS 和轻量消息队列(原 MNS)投递资源定时快照。取值:

  • true:接收资源定时快照。

  • false(默认值):不接收资源定时快照。

说明
  • 当投递渠道为 OSS 时,ConfigurationSnapshot(资源定时快照)和ConfigurationItemChangeNotification(配置变更历史)至少二选一。

说明
  • 当投递渠道为 SLS 时,ConfigurationSnapshot(资源定时快照)、ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少三选一。

true

CompliantSnapshot

boolean

是否接收合规快照。配置审计向日志服务 SLS 投递资源合规和不合规信息。取值:

  • true:接收合规快照。

  • false:不接收合规快照。

false

ConfigurationItemChangeNotification

boolean

是否接收资源配置变更历史。当资源配置变更时,配置审计向对象存储 OSS、日志服务 SLS 或轻量消息队列(原 MNS)投递资源配置变更历史。取值:

  • true:接收资源配置变更历史。

  • false(默认值):不接收资源配置变更历史。

说明
  • 当投递渠道为 OSS 时,ConfigurationSnapshot(资源定时快照)和ConfigurationItemChangeNotification(配置变更历史)至少二选一。

说明
  • 当投递渠道为 SLS 时,ConfigurationSnapshot(资源定时快照)、ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少三选一。

说明
  • 当投递渠道为 MNS 时,ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少二选一。

false

NonCompliantNotification

boolean

是否接收资源不合规事件。当资源不合规时,配置审计向日志服务 SLS 或轻量消息队列(原 MNS)投递资源不合规事件。取值:

  • true:接收资源不合规事件。

  • false(默认值):不接收资源不合规事件。

说明
  • 当投递渠道为 SLS 时,ConfigurationSnapshot(资源定时快照)、ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少三选一。

说明
  • 当投递渠道为 MNS 时,ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少二选一。

false

DeliverySnapshotTime

string

资源定时快照每日开始投递的时间。

格式为HH:mmZ(UTC 时间)。

说明

当您开启资源定时快照投递时,可通过该参数自定义投递时间。如果您未设置该参数,则每天默认04:00Z16:00Z开始投递。

09:10Z

关于公共请求参数的详情,请参见公共参数

返回参数

名称

类型

描述

示例值

object

无。

RequestId

string

请求 ID。

A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG

DeliveryChannelId

string

投递渠道 ID。

cdc-8e45ff4e06a3a8****

示例

正常返回示例

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.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情