ListConfigDeliveryChannels - Cloud Config - Alibaba Cloud Documentation Center

Returns a list of delivery channels.

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:ListConfigDeliveryChannels

list

*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 a comma (,).	cdc-d9106457e0d900b1****

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	None.
DeliveryChannels	array<object>	A list of delivery channels.
	object	None.
Status	integer	The status of the delivery channel. Valid values: 0: The delivery channel is disabled. 1: The delivery channel is enabled.	1
DeliveryChannelName	string	The name of the delivery channel.	myDeliveryChannel
DeliveryChannelId	string	The ID of the delivery channel.	cdc-d9106457e0d900b1****
DeliveryChannelType	string	The type of the delivery channel. Valid values: OSS: Object Storage Service (OSS). MNS: Simple Message Queue (formerly MNS). SLS: Simple Log Service (SLS).	OSS
DeliveryChannelTargetArn	string	The Alibaba Cloud Resource Name (ARN) of the delivery destination. If `DeliveryChannelType` is `OSS`, this parameter is the ARN of an OSS bucket. If `DeliveryChannelType` is `MNS`, this parameter is the ARN of an MNS topic. If `DeliveryChannelType` is `SLS`, this parameter is the ARN of an SLS Logstore.	acs:oss:cn-shanghai:120886317861****:new-bucket
DeliveryChannelAssumeRoleArn	string	The ARN of the role that is assumed by the delivery channel.	acs:ram::120886317861****:role/aliyunserviceroleforconfig
DeliveryChannelCondition	string	The rule attached to the delivery channel. This parameter is supported for MNS channels and for snapshot delivery to SLS channels. To subscribe to MNS events, specify the minimum risk level and resource types: Minimum risk level of subscribed events: `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`. `value` specifies the risk level. Valid values: 1 (high risk), 2 (medium risk), and 3 (low risk). Resource types of subscribed events: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. `values` is a JSON array of the resource types. 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}]` To deliver snapshots to SLS, specify the resource types: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. `values` is a JSON array of the resource types. 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}]
OversizedDataOSSTargetArn	string	The destination OSS bucket to which the data is transferred when the size of the data exceeds the limit of the delivery channel.	acs:oss:cn-shanghai:100931896542****:new-bucket
Description	string	The description of the delivery channel.	My OSS delivery.
CompliantSnapshot	boolean	Specifies whether to receive compliance snapshots. Cloud Config delivers resource compliance and non-compliance information to SLS. Valid values: true: Receive compliance snapshots. false: Do not receive compliance snapshots.	false
ConfigurationSnapshot	boolean	Specifies whether to receive scheduled resource snapshots. Cloud Config delivers scheduled resource snapshots to OSS or SLS at `04:00Z` and `16:00Z` (UTC) every day. Valid values: true: Receive scheduled resource snapshots. false: Do not receive scheduled resource snapshots.	false
ConfigurationItemChangeNotification	boolean	Specifies whether to receive the resource configuration history. When a resource configuration changes, Cloud Config delivers the resource configuration history to OSS, SLS, or MNS. Valid values: true: Receive the resource configuration history. false: Do not receive the resource configuration history.	true
NonCompliantNotification	boolean	Specifies whether to receive resource non-compliance events. When a resource becomes non-compliant, Cloud Config delivers a resource non-compliance event to SLS or MNS. Valid values: true: Receive resource non-compliance events. false: Do not receive resource non-compliance events.	false
AccountId	integer	The ID of the current Alibaba Cloud account.	120886317861****
DeliverySnapshotTime	string	The time when scheduled resource snapshots start to be delivered every day. The format is `HH:mmZ` (UTC).	09:10Z
RequestId	string	The request ID.	DC300244-FCE3-5061-8214-C27ECB668487

Examples

Success response

JSON format

{
  "DeliveryChannels": [
    {
      "Status": 1,
      "DeliveryChannelName": "myDeliveryChannel",
      "DeliveryChannelId": "cdc-d9106457e0d900b1****",
      "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.",
      "CompliantSnapshot": false,
      "ConfigurationSnapshot": false,
      "ConfigurationItemChangeNotification": true,
      "NonCompliantNotification": false,
      "AccountId": 0,
      "DeliverySnapshotTime": "09:10Z"
    }
  ],
  "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.