Queries the details of delivery channels.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDeliveryChannels

The operation that you want to perform. Set the value to DescribeDeliveryChannels.

DeliveryChannelIds String No cdc-d9106457e0d900b1****

The ID of the delivery channel. Separate multiple IDs with commas (,).

For more information about how to obtain the ID of a delivery channel, see PutDeliveryChannel.

Response parameters

Parameter Type Example Description
DeliveryChannels Array of DeliveryChannel

The information about the delivery channel.

Status Integer 1

The status of the delivery channel. Valid values:

  • 0: The delivery channel is disabled.
  • 1: The delivery channel is enabled.
DeliveryChannelName String myDeliveryChannel

The name of the delivery channel.

DeliveryChannelId String cdc-d9106457e0d900b1****

The ID of the delivery channel.

DeliveryChannelType String OSS

The type of the delivery channel. Valid values:

  • OSS: Object Storage Service (OSS)
  • MNS: Message Service (MNS)
  • SLS: Log Service
DeliveryChannelAssumeRoleArn String acs:ram::120886317861****:role/aliyunserviceroleforconfig

The Alibaba Cloud Resource Name (ARN) of the role assumed by the delivery channel.

Description String My OSS delivery.

The description of the delivery channel.

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

The rule attached to the delivery channel. This parameter is applicable only to delivery channels of the MNS type.

This parameter indicates the lowest risk level for the events to subscribe to and the resource types for which you subscribe to events.

  • The setting of the lowest risk level for the events to subscribe to is in the following format: {"filterType":"RuleRiskLevel","value":"1","multiple":false}.

    The value field indicates the lowest risk level. Valid values: 1, 2, and 3. A value of 1 indicates the high risk level. A value of 2 indicates the medium risk level. A value of 3 indicates the low risk level.

  • The setting of the resource types for which you subscribe to events is in the following format: {"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}.

    The values field indicates the resource types for which you subscribe to events. Its value is a JSON array.

    Example: [{"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

The ARN of the delivery destination.

  • If the DeliveryChannelType parameter is set to OSS, the value of this parameter is the ARN of the destination OSS bucket.
  • If the DeliveryChannelType parameter is set to MNS, the value of this parameter is the ARN of the destination MNS topic.
  • If the DeliveryChannelType parameter is set to SLS, the value is the ARN of the destination Log Service Logstore.
ConfigurationSnapshot Boolean false

Indicates whether the scheduled resource snapshots are received by the OSS bucket. If you set this parameter to true, Cloud Config delivers the scheduled resource snapshots to the specified OSS bucket at 00:00:00 and 12:00:00 every day. Valid values:

  • true: The scheduled resource snapshots are received by the specified OSS bucket.
  • false: The scheduled resource snapshots are not received by the specified OSS bucket.
ConfigurationItemChangeNotification Boolean true

Indicates whether the resource change logs are received by the specified destination. If you set this parameter to true, Cloud Config delivers the resource change logs to OSS, Log Service, or MNS when the configurations of the resources change. Valid values:

  • true: The resource change logs are received by the specified destination.
  • false: The resource change logs are not received by the specified destination.
NonCompliantNotification Boolean false

Indicates whether the resource non-compliance events are received by the specified destination. If you set this parameter to true, Cloud Config delivers resource non-compliance events to Log Service or MNS when resources are evaluated as non-compliant. Valid values:

  • true: The resource non-compliance events are received by the specified destination.
  • false: The resource non-compliance events are not received by the specified destination.
OversizedDataOSSTargetArn String acs:oss:cn-shanghai:100931896542****:new-bucket

The ARN of the OSS bucket to which the delivered data is transferred when the size of the data exceeds the specified upper limit of the delivery channel.

RequestId String DC300244-FCE3-5061-8214-C27ECB668487

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDeliveryChannels
&<Common request parameters>

Sample success responses

XML format 

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 format 

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

Error codes

HTTP status code Error code Error message Description
400 DeliveryChannelNotExists The delivery channel does not exist. The error message returned because the specified delivery channel does not exist.
404 AccountNotExisted Your account does not exist. The error message returned because your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the service is unavailable.

For a list of error codes, visit the API Error Center.