DescribeDeliveryChannels - 查询投递渠道信息

查询设置的投递渠道信息。

说明

目前该API接口已标记为弃用,推荐使用替代API:Config(2020-09-07) - ListConfigDeliveryChannels

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:DescribeDeliveryChannels

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DeliveryChannelIds

string

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

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

cdc-d9106457e0d900b1****

返回参数

名称

类型

描述

示例值

object

投递渠道信息。

DeliveryChannels

array<object>

投递渠道信息。

object

投递渠道信息。

ConfigurationItemChangeNotification

boolean

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

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

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

true

ConfigurationSnapshot

boolean

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

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

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

false

DeliveryChannelAssumeRoleArn

string

投递渠道扮演角色 ARN。

acs:ram::120886317861****:role/aliyunserviceroleforconfig

DeliveryChannelCondition

string

投递渠道附加规则。当前仅 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}]

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

DeliveryChannelId

string

投递渠道 ID。

cdc-d9106457e0d900b1****

DeliveryChannelName

string

投递渠道名称。

myDeliveryChannel

DeliveryChannelTargetArn

string

投递渠道目标地址的 ARN。

  • 当 DeliveryChannelType 为 OSS 时,该参数为 Bucket 的 ARN。

  • 当 DeliveryChannelType 为 MNS 时,该参数为 Topic 的 ARN。

  • 当 DeliveryChannelType 为 SLS 时,该参数为 Logstore 的 ARN。

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

DeliveryChannelType

string

投递渠道类型。取值:

  • OSS:对象存储。

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

  • SLS:日志服务。

OSS

Description

string

投递渠道描述。

My OSS delivery.

NonCompliantNotification

boolean

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

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

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

false

OversizedDataOSSTargetArn

string

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

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

Status

integer

投递设置状态。取值:

  • 0:关闭。

  • 1:开启。

1

RequestId

string

请求 ID。

DC300244-FCE3-5061-8214-C27ECB668487

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

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. 服务不可用。

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

变更历史

更多信息,参考变更详情