首页 配置审计 API参考 API参考(2020-09-07) API目录 普通账号 投递渠道 GetConfigDeliveryChannel - 查询指定投递渠道信息

GetConfigDeliveryChannel - 查询指定投递渠道信息

查询指定投递渠道信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:GetConfigDeliveryChannelRead
  • Config
    acs:config:*:{#accountId}:delivery/{#DeliveryChannelId}

请求参数

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

投递渠道ID。

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

cdc-d9106457e0d900b1****

返回参数

名称类型描述示例值
object

无。

DeliveryChannelobject

单个投递渠道信息。

Statusinteger

投递设置状态。取值:

  • 0:关闭。
  • 1:开启。
1
DeliveryChannelIdstring

投递渠道ID。

cdc-d9106457e0d900b1****
DeliveryChannelNamestring

投递渠道名称。

myDeliveryChannel
DeliveryChannelTypestring

投递渠道类型。取值:

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

投递渠道目标地址的ARN。

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

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

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

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

投递渠道扮演角色ARN。

acs:ram::120886317861****:role/aliyunserviceroleforconfig
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:cn-shanghai:100931896542****:new-bucket
Descriptionstring

投递渠道描述。

My OSS delivery.
ConfigurationSnapshotboolean

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

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

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

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

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

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

当前阿里云账号ID。

120886317861****
DeliverySnapshotTimestring

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

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

09:10Z
RequestIdstring

请求ID。

DC300244-FCE3-5061-8214-C27ECB668487

示例

正常返回示例

JSON格式

{
  "DeliveryChannel": {
    "Status": 1,
    "DeliveryChannelId": "cdc-d9106457e0d900b1****",
    "DeliveryChannelName": "myDeliveryChannel",
    "DeliveryChannelType": "OSS",
    "DeliveryChannelTargetArn": "acs:oss:cn-shanghai:120886317861****:new-bucket",
    "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}]",
    "OversizedDataOSSTargetArn": "acs:oss:cn-shanghai:100931896542****:new-bucket",
    "Description": "My OSS delivery.",
    "ConfigurationSnapshot": false,
    "ConfigurationItemChangeNotification": true,
    "NonCompliantNotification": false,
    "AccountId": 0,
    "DeliverySnapshotTime": "09:10Z"
  },
  "RequestId": "DC300244-FCE3-5061-8214-C27ECB668487"
}

错误码

HTTP status code错误码错误信息描述
400DeliveryChannelNotExistsThe delivery channel does not exist.投递渠道不存在。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

阿里云首页 配置审计 相关技术圈