調用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。

  • 當DeliveryChannelType為OSS時,該參數為Bucket的ARN。
  • 當DeliveryChannelType為MNS時,該參數為Topic的ARN。
  • 當DeliveryChannelType為SLS時,該參數為Logstore的ARN。
ConfigurationSnapshot Boolean false

是否接收資源定時快照。每天00:00:00和12: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 錯誤碼 錯誤信息 描述
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. 服務不可用。

訪問錯誤中心查看更多錯誤碼。