文档

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:CreateConfigDeliveryChannelWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DeliveryChannelNamestring

投递渠道名称。

说明 如果未设置该参数,默认为空。
testoss
DeliveryChannelTypestring

投递渠道类型。取值:

  • OSS:对象存储。
  • MNS:消息服务。
  • SLS:日志服务。
OSS
DeliveryChannelTargetArnstring

投递渠道目标地址的 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
DeliveryChannelConditionstring

投递渠道附加规则。当前支持 MNS 渠道的所有投递和 SLS 渠道的快照投递。

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

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

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

    • 订阅事件的资源类型为{"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}]

  • 如果您指定 SLS 快照投递的资源类型,资源类型为{"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}]
OversizedDataOSSTargetArnstring

当投递数据超过投递渠道限制时,投递数据转存到对象存储 OSS 的目标存储空间。格式为acs:oss:{RegionId}:{accountId}:{bucketName}

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

说明 仅支持投递渠道 SLS 和 MNS。日志服务 SLS 的投递渠道限制是 1 MB,消息服务 MNS 的投递渠道限制是 64 KB。
acs:oss:cn-shanghai:100931896542****:new-bucket
Descriptionstring

投递渠道描述。

My OSS delivery.
ClientTokenstring

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

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

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

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

  • true:接收资源定时快照。
  • false(默认值):不接收资源定时快照。
说明
  • 当投递渠道为 OSS 时,ConfigurationSnapshot(资源定时快照)和ConfigurationItemChangeNotification(配置变更历史)至少二选一。
  • 说明
  • 当投递渠道为 SLS 时,ConfigurationSnapshot(资源定时快照)、ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少三选一。
  • true
    ConfigurationItemChangeNotificationboolean

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

    • true:接收资源配置变更历史。
    • false(默认值):不接收资源配置变更历史。
    说明
  • 当投递渠道为 OSS 时,ConfigurationSnapshot(资源定时快照)和ConfigurationItemChangeNotification(配置变更历史)至少二选一。
  • 说明
  • 当投递渠道为 SLS 时,ConfigurationSnapshot(资源定时快照)、ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少三选一。
  • 说明
  • 当投递渠道为 MNS 时,ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少二选一。
  • false
    NonCompliantNotificationboolean

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

    • true:接收资源不合规事件。
    • false(默认值):不接收资源不合规事件。
    说明
  • 当投递渠道为 SLS 时,ConfigurationSnapshot(资源定时快照)、ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少三选一。
  • 说明
  • 当投递渠道为 MNS 时,ConfigurationItemChangeNotification(配置变更历史)和NonCompliantNotification(资源不合规事件)至少二选一。
  • false
    DeliverySnapshotTimestring

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

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

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

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

    返回参数

    名称类型描述示例值
    object

    无。

    RequestIdstring

    请求 ID。

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

    投递渠道 ID。

    cdc-8e45ff4e06a3a8****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG",
      "DeliveryChannelId": "cdc-8e45ff4e06a3a8****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400DeliveryChannelNotExistsThe delivery channel does not exist.投递渠道不存在。
    400Invalid.DeliveryChannelAssumeRoleArn.FormatThe specified format of DeliveryChannelAssumeRoleArn is invalid.参数DeliveryChannelAssumeRoleArn格式错误。
    400Invalid.DeliveryChannelTargetArn.FormatThe specified format of DeliveryChannelTargetArn is invalid.参数DeliveryChannelTargetArn格式错误。
    400Invalid.DeliveryChannelCondition.FormatThe specified format of DeliveryChannelCondition is invalid.参数DeliveryChannelCondition格式错误。
    400MemberNotBelongToMasterThe specified member does not belong to your organization.该成员账号不属于您所在的资源目录。
    400DeliveryChannelAccountNotSupportCross-account delivery that is not in the RD is not supported.暂不支持非资源目录内的跨账号投递。
    400DeliveryChannelMnsUnreachableThe MNS topic is unreachable.MNS Topic尝试投递失败。
    400DeliveryChannelOssUnreachableThe OSS bucket is unreachable.OSS Bucket尝试投递失败。
    400DeliveryChannelSlsUnreachableSLS logstore is unreachable.SLS Logstore尝试投递失败。
    404AccountNotExistedYour account does not exist.您的账号不存在。

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

    • 本页导读 (1)