DescribeDeliveryChannels - Cloud Config - Alibaba Cloud Documentation Center

Queries information about configured delivery channels.

Note

This API has been deprecated. We recommend migrating to Config(2020-09-07) - ListConfigDeliveryChannels for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:DescribeDeliveryChannels

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DeliveryChannelIds	string	No	The ID of the delivery channel. Separate multiple delivery channel IDs with commas (,). For more information about how to obtain the ID of a delivery channel, see PutDeliveryChannel.	cdc-d9106457e0d900b1****

Response elements

Parameter	Type	Description	Example
	object	The information about the delivery channel.
DeliveryChannels	array<object>	The details of the delivery channels.
	object	The information about the delivery channel.
ConfigurationItemChangeNotification	boolean	Indicates whether to deliver the configuration history of a resource. If the configuration of a resource changes, Cloud Config delivers the configuration history to Object Storage Service (OSS), Simple Log Service (SLS), or Simple Message Queue (formerly MNS). Valid values: true: The configuration history of a resource is delivered. false: The configuration history of a resource is not delivered.	true
ConfigurationSnapshot	boolean	Indicates whether to deliver scheduled resource snapshots. At 00:00:00 and 12:00:00 every day, Cloud Config delivers scheduled resource snapshots to OSS. Valid values: true: Scheduled resource snapshots are delivered. false: Scheduled resource snapshots are not delivered.	false
DeliveryChannelAssumeRoleArn	string	The ARN of the role that is assumed by the delivery channel.	acs:ram::120886317861****:role/aliyunserviceroleforconfig
DeliveryChannelCondition	string	The rule that is attached to the delivery channel. This parameter is supported only by delivery channels of the MNS type. You can specify the lowest risk level and the resource types for the MNS events to which you subscribe. The following section describes the parameters: The lowest risk level of the events to which you subscribe: `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`. The `value` parameter indicates the risk level that you want to filter. Valid values: 1 indicates high risk, 2 indicates medium risk, and 3 indicates low risk. The resource types of the events to which you subscribe: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. The `values` parameter indicates the resource types of the events to which you want to subscribe. The value is a JSON array of resource types. For 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}]`	[{"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	The ID of the delivery channel.	cdc-d9106457e0d900b1****
DeliveryChannelName	string	The name of the delivery channel.	myDeliveryChannel
DeliveryChannelTargetArn	string	The ARN of the destination of the delivery channel. If DeliveryChannelType is set to OSS, this parameter is the ARN of the destination bucket. If DeliveryChannelType is set to MNS, this parameter is the ARN of the destination topic. If DeliveryChannelType is set to SLS, this parameter is the ARN of the destination Logstore.	acs:oss:cn-shanghai:120886317861****:new-bucket
DeliveryChannelType	string	The type of the delivery channel. Valid values: OSS: Object Storage Service. MNS: Simple Message Queue (formerly MNS). SLS: Simple Log Service.	OSS
Description	string	The description of the delivery channel.	My OSS delivery.
NonCompliantNotification	boolean	Indicates whether to deliver resource non-compliance events. If a resource is considered non-compliant, Cloud Config delivers the non-compliance events to SLS or MNS. Valid values: true: Resource non-compliance events are delivered. false: Resource non-compliance events are not delivered.	false
OversizedDataOSSTargetArn	string	The ARN of the OSS bucket to which the oversized data is delivered if the size of the data exceeds the limit of the delivery channel.	acs:oss:cn-shanghai:100931896542****:new-bucket
Status	integer	The status of the delivery channel. Valid values: 0: disabled. 1: enabled.	1
RequestId	string	The ID of the request.	DC300244-FCE3-5061-8214-C27ECB668487

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	DeliveryChannelNotExists	The delivery channel does not exist.	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.	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.