调用UpdateDeliveryChannel接口修改投递渠道。

本文将提供一个示例,将投递渠道cdc-8e45ff4e06a3a8****的状态修改为0(关闭)。关闭投递渠道后,配置审计保留最近一次投递配置,停止资源数据投递。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateDeliveryChannel

要执行的操作,取值:UpdateDeliveryChannel

DeliveryChannelName String testoss

投递渠道名称。

说明 如果未设置该参数,默认为空。
DeliveryChannelTargetArn String acs:oss:cn-shanghai:100931896542****:new-bucket

投递渠道目标地址的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
DeliveryChannelAssumeRoleArn String acs:ram::100931896542****:role/aliyunserviceroleforconfig

投递角色ARN。格式为acs:ram::{accountId}:role/aliyunserviceroleforconfig

DeliveryChannelCondition String [{"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}]

投递渠道附加规则。当前仅支持MNS类型的投递渠道。

您可以指定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}]

Description String My OSS delivery.

投递渠道描述。

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

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

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

ConfigurationSnapshot Boolean false

是否接收资源定时快照。每天00:00:00和12:00:00,配置审计定时向对象存储OSS投递资源定时快照。取值:

  • true
  • false(默认值)
说明 仅支持投递渠道OSS。
ConfigurationItemChangeNotification Boolean false

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

  • true
  • false(默认值)
说明 支持投递渠道OSS、SLS和MNS。
NonCompliantNotification Boolean false

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

  • true
  • false(默认值)
说明 仅支持投递渠道SLS和MNS。
OversizedDataOSSTargetArn String acs:oss:cn-shanghai:100931896542****:new-bucket

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

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

说明 仅支持投递渠道SLS和MNS。日志服务SLS的投递渠道限制是1 MB,消息服务MNS的投递渠道限制是64 KB。
DeliveryChannelId String cdc-8e45ff4e06a3a8****

投递渠道ID。

关于如何获取投递渠道ID,请参见DescribeDeliveryChannels

Status Long 0

投递渠道状态。取值:

  • 0:关闭。配置审计保留最近一次投递配置,停止资源数据投递。
  • 1(默认值):开启。

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

返回数据

名称 类型 示例值 描述
RequestId String A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG

请求ID。

DeliveryChannelId String cdc-8e45ff4e06a3a8****

投递渠道ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateDeliveryChannel
&DeliveryChannelId=cdc-8e45ff4e06a3a8****
&Status=0
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateDeliveryChannelResponse>
    <RequestId>A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG</RequestId>
    <DeliveryChannelId>cdc-8e45ff4e06a3a8****</DeliveryChannelId>
</UpdateDeliveryChannelResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. SLS Logstore尝试投递失败。
404 AccountNotExisted Your account does not exist. 您的账号不存在。

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