调用DescribeDeliveryChannels接口查询投递渠道信息。

调试

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

调试

请求参数

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

要执行的操作,取值:DescribeDeliveryChannels

DeliveryChannelIds String cdc-d9106457e0d900b1****

投递渠道ID。多个投递渠道ID之间用半角逗号(,)分隔。

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

返回数据

名称类型示例值描述
名称 类型 示例值 描述
DeliveryChannels Array of DeliveryChannel

投递渠道信息。

Status Integer 1

投递设置状态。取值:

  • 0:关闭。
  • 1:开启。
DeliveryChannelName String myDeliveryChannel

投递渠道名称。

DeliveryChannelId String cdc-d9106457e0d900b1****

投递渠道ID。

DeliveryChannelType String OSS

投递渠道类型。取值:

  • OSS:对象存储。
  • MNS:消息服务。
  • SLS:日志服务。
DeliveryChannelAssumeRoleArn String acs:ram::120886317861****:role/aliyunserviceroleforconfig

投递渠道扮演角色ARN。

Description String My OSS delivery.

投递渠道描述。

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}]

DeliveryChannelTargetArn String acs:oss:cn-shanghai:120886317861****:new-bucket

投递渠道目标地址的ARN。

  • DeliveryChannelTypeOSS时,该参数为BucketARN。
  • DeliveryChannelTypeMNS时,该参数为TopicARN。
  • DeliveryChannelTypeSLS时,该参数为LogstoreARN。
ConfigurationSnapshot Boolean false

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

  • true:接收资源定时快照。
  • false:不接收资源定时快照。
ConfigurationItemChangeNotification Boolean true

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

  • true:接收资源配置变更历史。
  • false:不接收资源配置变更历史。
NonCompliantNotification Boolean false

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

  • true:接收资源不合规事件。
  • false:不接收资源不合规事件。
OversizedDataOSSTargetArn String acs:oss:cn-shanghai:100931896542****:new-bucket

当投递数据超过投递渠道限制时,投递数据转存到对象存储OSS的目标存储空间。

RequestId String DC300244-FCE3-5061-8214-C27ECB668487

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDeliveryChannels
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeDeliveryChannelsResponse>
	<DeliveryChannels>
		<Status>1</Status>
		<ConfigurationSnapshot>false</ConfigurationSnapshot>
		<OversizedDataOSSTargetArn></OversizedDataOSSTargetArn>
		<Description>My OSS delivery.</Description>
		<DeliveryChannelName>myDeliveryChannel</DeliveryChannelName>
		<DeliveryChannelId>cdc-d9106457e0d900b1****</DeliveryChannelId>
		<DeliveryChannelTargetArn>acs:oss:cn-shanghai:120886317861****:new-bucket</DeliveryChannelTargetArn>
		<DeliveryChannelAssumeRoleArn>acs:ram::120886317861****:role/aliyunserviceroleforconfig</DeliveryChannelAssumeRoleArn>
		<ConfigurationItemChangeNotification>true</ConfigurationItemChangeNotification>
		<DeliveryChannelType>OSS</DeliveryChannelType>
		<DeliveryChannelCondition></DeliveryChannelCondition>
		<NonCompliantNotification>false</NonCompliantNotification>
	</DeliveryChannels>
	<RequestId>DC300244-FCE3-5061-8214-C27ECB668487</RequestId>
</DescribeDeliveryChannelsResponse>

JSON格式

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

{
  "DeliveryChannels" : [ {
    "Status" : 1,
    "ConfigurationSnapshot" : false,
    "OversizedDataOSSTargetArn" : "",
    "Description" : "My OSS delivery.",
    "DeliveryChannelName" : "myDeliveryChannel",
    "DeliveryChannelId" : "cdc-d9106457e0d900b1****",
    "DeliveryChannelTargetArn" : "acs:oss:cn-shanghai:120886317861****:new-bucket",
    "DeliveryChannelAssumeRoleArn" : "acs:ram::120886317861****:role/aliyunserviceroleforconfig",
    "ConfigurationItemChangeNotification" : true,
    "DeliveryChannelType" : "OSS",
    "DeliveryChannelCondition" : "",
    "NonCompliantNotification" : false
  } ],
  "RequestId" : "DC300244-FCE3-5061-8214-C27ECB668487"
}

错误码

HttpCode错误码错误信息描述
HttpCode 错误码 错误信息 描述
400 DeliveryChannelNotExists The delivery channel does not exist. 投递渠道不存在。
404 AccountNotExisted Your account does not exist. 您的账号不存在。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服务不可用。

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