Cloud Config:CreateConfigDeliveryChannel - Cloud Config - Alibaba Cloud - Cloud Config

Creates a delivery channel to deliver resource data to Simple Log Service (SLS), Object Storage Service (OSS), or Simple Message Queue (formerly MNS) for storage.

Operation description

Background information

Deliver data to SLS

To deliver configuration history, non-compliance events, and scheduled snapshots of resources to a Logstore in SLS, create a project and a Logstore before you can query and analyze logs. For examples of JSON file content, see Examples of resource configuration history, Examples of resource non-compliance events, and Examples of resource scheduled snapshots.
Deliver data to OSS

To deliver scheduled snapshots or configuration history of resources to a specified address in OSS, create a bucket before you can view or download JSON files. For examples of JSON file content, see Examples of resource scheduled snapshots and Examples of resource configuration history.
Deliver data to Simple Message Queue (formerly MNS)

To deliver resource configuration history and resource non-compliance events to a specified topic in Simple Message Queue (formerly MNS), create a topic before you can configure the push method and content for the topic. For examples of JSON file content, see Examples of resource configuration history and Examples of resource non-compliance events.

Limits

You can create up to 5 delivery channels.

Operation description

This topic provides an example of how to create a delivery channel. The delivery channel type is OSS and the Alibaba Cloud Resource Name (ARN) of the delivery destination is acs:oss:cn-shanghai:100931896542****:new-bucket. The response shows that the delivery channel is created, and the delivery channel ID is cdc-8e45ff4e06a3a8****.

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

create

*Delivery

acs:config:*:{#accountId}:delivery/*

None

Request parameters

Parameter	Type	Required	Description	Example
DeliveryChannelName	string	No	The name of the delivery channel. Note If you do not set this parameter, the value is empty by default.	testoss
DeliveryChannelType	string	Yes	The type of the delivery channel. Valid values: OSS: Object Storage Service. MNS: Simple Message Queue (formerly MNS). SLS: Simple Log Service. Valid values: MNS : Simple Message Queue (formerly MNS) SLS : Simple Log Service (SLS) OSS : Object Storage Service (OSS)	OSS
DeliveryChannelTargetArn	string	Yes	The ARN of the delivery destination. Valid values: If the delivery channel type is OSS, the format is `acs:oss:{RegionId}:{accountId}:{bucketName}`. Example: `acs:oss:cn-shanghai:100931896542**:new-bucket`. If the delivery channel type is MNS, the format is `acs:mns:{RegionId}:{accountId}:/topics/{topicName}`. Example: `acs:mns:cn-shanghai:100931896542:/topics/topic1`. If the delivery channel type is SLS, the format is `acs:log:{RegionId}:{accountId}:project/{projectName}/logstore/{logstoreName}`. Example: `acs:log:cn-shanghai:100931896542**:project/project1/logstore/logstore1`.	acs:oss:cn-shanghai:100931896542****:new-bucket
DeliveryChannelCondition	string	No	The additional rule attached to the delivery channel, which is used to specify the filter conditions for subscribed content. If you specify the minimum risk level and resource types for subscribing to compliance events, the details are as follows: The minimum risk level for subscribed events is `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`. `value` specifies the risk level that you want to filter. Valid values: 1: high risk. 2: medium risk. 3: low risk. `multiple` specifies whether this group of filter fields supports multiple values. The risk level supports only single-value filtering, which means the `multiple` field for compliance event content delivery can only be set to `false`. The resource types for subscribed events are `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. `values` specifies the resource types for which you want to subscribe to events. The value is a JSON array of 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}]` `multiple` specifies whether this group of filter fields supports multiple values. Resource types support multi-value filtering. When multiple resource types are selected, the `multiple` field can be set to `true`. You can also specify both the risk level and resource types. Example: `[{"filterType":"RuleRiskLevel","value":"2","multiple":false},{"filterType":"ResourceType","values":["ACS::CDN::Domain","ACS::ActionTrail::Trail"],"multiple":true}]` If you specify the resource types for resource configuration delivery, the resource types are `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. `values` specifies the resource types that you want to deliver. The value is a JSON array of 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	No	The ARN of the OSS bucket to which delivery data is transferred when the data exceeds the delivery channel size limit. The format is `acs:oss:{RegionId}:{accountId}:{bucketName}`. If you do not set this parameter, Cloud Config delivers only summary information. Note This parameter applies only to the SLS and MNS delivery channels. The size limit for the SLS delivery channel is 1 MB, and the size limit for the Simple Message Queue (formerly MNS) delivery channel is 64 KB.	acs:oss:cn-shanghai:100931896542****:new-bucket
Description	string	No	The description of the delivery channel.	My OSS delivery.
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	1594295238-f9361358-5843-4294-8d30-b5183fac****
ConfigurationSnapshot	boolean	No	Specifies whether to receive resource scheduled snapshots. Cloud Config delivers resource scheduled snapshots to OSS or SLS at `04:00Z` and `16:00Z` (UTC) every day. Valid values: true: Receives resource scheduled snapshots. false (default): Does not receive resource scheduled snapshots. Note If the delivery channel type is OSS, at least one of `ConfigurationSnapshot` (resource scheduled snapshots) and `ConfigurationItemChangeNotification` (configuration configuration history) must be set. Note If the delivery channel type is SLS, at least one of `ConfigurationSnapshot` (resource scheduled snapshots), `ConfigurationItemChangeNotification` (configuration configuration history), `CompliantSnapshot` (compliance snapshots), and `NonCompliantNotification` (resource non-compliance events) must be set.	true
CompliantSnapshot	boolean	No	Specifies whether to receive compliance snapshots. Cloud Config delivers resource compliance and non-compliance information to SLS. Valid values: true: Receives compliance snapshots. false: Does not receive compliance snapshots.	false
ConfigurationItemChangeNotification	boolean	No	Specifies whether to accept resource configuration history. When a resource configuration changes, Cloud Config delivers the resource configuration history to OSS, SLS, or Simple Message Queue (formerly MNS). Valid values: true: Accepts resource configuration history. false (default): Does not accept resource configuration history. Note If the delivery channel type is OSS, at least one of `ConfigurationSnapshot` (resource scheduled snapshots) and `ConfigurationItemChangeNotification` (configuration history) must be set. Note If the delivery channel type is SLS, at least one of `ConfigurationSnapshot` (resource scheduled snapshots), `CompliantSnapshot` (compliance snapshots), `ConfigurationItemChangeNotification` (configuration history), and `NonCompliantNotification` (resource non-compliance events) must be set. Note If the delivery channel type is MNS, at least one of `ConfigurationItemChangeNotification` (configuration history) and `NonCompliantNotification` (resource non-compliance events) must be set.	false
NonCompliantNotification	boolean	No	Specifies whether to accept resource non-compliance events. When a resource is non-compliant, Cloud Config delivers the resource non-compliance event to SLS or Simple Message Queue (formerly MNS). Valid values: true: Accepts resource non-compliance events. false (default): Does not accept resource non-compliance events. Note If the delivery channel type is SLS, at least one of `ConfigurationSnapshot` (resource scheduled snapshots), `CompliantSnapshot` (compliance snapshots), `ConfigurationItemChangeNotification` (configuration history), and `NonCompliantNotification` (resource non-compliance events) must be set. Note If the delivery channel type is MNS, at least one of `ConfigurationItemChangeNotification` (configuration history) and `NonCompliantNotification` (resource non-compliance events) must be set.	false
DeliverySnapshotTime	string	No	The time when the daily delivery of resource scheduled snapshots starts. The format is `HH:mmZ` (UTC). Note If you enable resource scheduled snapshot delivery, you can use this parameter to customize the delivery time. If you do not set this parameter, the delivery starts at `04:00Z` and `16:00Z` by default every day.	09:10Z

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

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG
DeliveryChannelId	string	The delivery channel ID.	cdc-8e45ff4e06a3a8****

Examples

Success response

JSON format

{
  "RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG",
  "DeliveryChannelId": "cdc-8e45ff4e06a3a8****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DeliveryChannelNotExists	The delivery channel does not exist.	The delivery channel does not exist.
400	Invalid.DeliveryChannelAssumeRoleArn.Format	The specified format of DeliveryChannelAssumeRoleArn is invalid.	The specified format of DeliveryChannelAssumeRoleArn is invalid.
400	Invalid.DeliveryChannelTargetArn.Format	The specified format of DeliveryChannelTargetArn is invalid.	The specified format of DeliveryChannelTargetArn is invalid.
400	Invalid.DeliveryChannelCondition.Format	The specified format of DeliveryChannelCondition is invalid.	The specified format of DeliveryChannelCondition is invalid.
400	MemberNotBelongToMaster	The specified member does not belong to your organization.
400	DeliveryChannelAccountNotSupport	Cross-account delivery that is not in the RD is not supported.	Cross-account delivery that is not in the RD is not supported.
400	DeliveryChannelMnsUnreachable	The MNS topic is unreachable.	The MNS topic is unreachable.
400	DeliveryChannelOssUnreachable	The OSS bucket is unreachable.	The OSS bucket is unreachable.
400	DeliveryChannelSlsUnreachable	SLS logstore is unreachable.
404	AccountNotExisted	Your account does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.