CreateAggregateConfigDeliveryChannel - Cloud Config - Alibaba Cloud Documentation Center

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

Operation description

Background information

Deliver to Simple Log Service (SLS)

To deliver configuration history, non-compliance events, and scheduled resource snapshots to a Logstore in Simple Log Service (SLS), you must first create a log project and a Logstore. This lets you query and analyze logs. For examples of the content in JSON format, see Example of resource configuration change history, Example of resource non-compliance event, and Example of scheduled resource snapshot.
Deliver to Object Storage Service (OSS)

To deliver scheduled resource snapshots or configuration history to a specified location in Object Storage Service (OSS), you must first create a bucket. This lets you view or download files in JSON format. For examples of the content in JSON format, see Example of scheduled resource snapshot and Example of resource configuration change history.
Deliver to Simple Message Queue (MNS)

To deliver resource configuration change history and resource non-compliance events to a specified topic in Simple Message Queue (formerly MNS), you must first create a topic. This lets you configure the push method and content for the topic. For examples of the content in JSON format, see Example of resource configuration change history and Example of resource non-compliance event.

Limits

You can create a maximum of five delivery channels for each account group.

Usage notes

This example shows how to create a delivery channel of the OSS type for the account group ca-a4e5626622af0079****. The Amazon 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 its 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:CreateAggregateConfigDeliveryChannel

create

*AggregateDelivery

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

None

Request parameters

Parameter	Type	Required	Description	Example
AggregatorId	string	Yes	The ID of the account group. For more information about how to obtain the ID of an account group, see ListAggregators.	ca-a4e5626622af0079****
DeliveryChannelName	string	No	The name of the delivery channel. Note If you do not set this parameter, this parameter is empty.	testoss
DeliveryChannelType	string	Yes	The type of the delivery channel. Valid values: OSS: Object Storage Service MNS: Simple Message Queue SLS: Simple Log Service	OSS
DeliveryChannelTargetArn	string	Yes	The ARN of the delivery destination. Valid values: If the delivery channel type is OSS, the value of this parameter is in the `acs:oss:{RegionId}:{accountId}:{bucketName}` format. Example: `acs:oss:cn-shanghai:100931896542**:new-bucket`. If the delivery channel type is MNS, the value of this parameter is in the `acs:mns:{RegionId}:{accountId}:/topics/{topicName}` format. Example: `acs:mns:cn-shanghai:100931896542:/topics/topic1`. If the delivery channel type is SLS, the value of this parameter is in the `acs:log:{RegionId}:{accountId}:project/{projectName}/logstore/{logstoreName}` format. Example: `acs:log:cn-shanghai:100931896542**:project/project1/logstore/logstore1`.	acs:oss:cn-shanghai:100931896542****:new-bucket
DeliveryChannelCondition	string	No	The rule that is used to filter events or resources for the delivery channel. This parameter is supported for all deliveries to MNS channels and for snapshot deliveries to SLS channels. For an MNS channel, you can specify the following rules to filter events: The minimum risk level of the events to which you want to subscribe is `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`. The `value` parameter specifies the risk level. Valid values: 1, 2, and 3. The value 1 indicates high risk. The value 2 indicates medium risk. The value 3 indicates low risk. The resource types of the events to which you want to subscribe are `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. The `values` parameter specifies the resource types of the events to which you want to subscribe. The value of this parameter is a JSON array of strings. 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}]` For an SLS channel, you can specify the following rule to filter snapshots: The resource types of the snapshots to be delivered are `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"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}]`	[{"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 that is used to store oversized data to be delivered when the size of the data exceeds the specified limit of the delivery channel. The value is in the `acs:oss:{RegionId}:{accountId}:{bucketName}` format. If you do not set this parameter, Cloud Config delivers only summary information. Note This parameter is applicable only to delivery channels of the SLS or MNS type. The maximum size of data that can be delivered to an SLS Logstore is 1 MB. The maximum size of data that can be delivered to an MNS topic 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	A client-generated token that you can use to ensure the idempotence of the request. You must make sure that the token is unique for each request. The `ClientToken` parameter 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 deliver scheduled resource snapshots. Cloud Config delivers scheduled resource snapshots to OSS, SLS, or MNS at `04:00Z` and `16:00Z` (UTC) every day. Valid values: true: Deliver scheduled resource snapshots. false (default): Do not deliver scheduled resource snapshots. Note If the delivery channel type is OSS, you must set at least one of the `ConfigurationSnapshot` and `ConfigurationItemChangeNotification` parameters to true. Note If the delivery channel type is SLS, you must set at least one of the `ConfigurationSnapshot`, `ConfigurationItemChangeNotification`, and `NonCompliantNotification` parameters to true.	true
CompliantSnapshot	boolean	No	Specifies whether to deliver compliance snapshots. Cloud Config delivers information about the compliance and non-compliance of resources to SLS. Valid values: true: Deliver compliance snapshots. false: Do not deliver compliance snapshots.	false
ConfigurationItemChangeNotification	boolean	No	Specifies whether to deliver the resource configuration change history. If the configurations of a resource change, Cloud Config delivers the configuration change history to OSS, SLS, or MNS. Valid values: true: Deliver the resource configuration change history. false (default): Do not deliver the resource configuration change history. Note If the delivery channel type is OSS, you must set at least one of the `ConfigurationSnapshot` and `ConfigurationItemChangeNotification` parameters to true. Note If the delivery channel type is SLS, you must set at least one of the `ConfigurationSnapshot`, `ConfigurationItemChangeNotification`, and `NonCompliantNotification` parameters to true. Note If the delivery channel type is MNS, you must set at least one of the `ConfigurationItemChangeNotification` and `NonCompliantNotification` parameters to true.	false
NonCompliantNotification	boolean	No	Specifies whether to deliver resource non-compliance events. If a resource is evaluated as non-compliant, Cloud Config delivers the non-compliance event to SLS or MNS. Valid values: true: Deliver resource non-compliance events. false (default): Do not deliver resource non-compliance events. Note If the delivery channel type is SLS, you must set at least one of the `ConfigurationSnapshot`, `ConfigurationItemChangeNotification`, and `NonCompliantNotification` parameters to true. Note If the delivery channel type is MNS, you must set at least one of the `ConfigurationItemChangeNotification` and `NonCompliantNotification` parameters to true.	false
DeliverySnapshotTime	string	No	The time of day from which scheduled resource snapshots are delivered. The time is displayed in UTC. The value is in the `HH:mmZ` format. Note If you enable the scheduled delivery of resource snapshots, you can use this parameter to customize the delivery time. If you do not set this parameter, the snapshots are delivered at `04:00Z` and `16:00Z` every day by default.	09:10Z

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	A7A0FFF8-0B44-40C6-8BBF-3A185EFDERTHG
DeliveryChannelId	string	The ID of the delivery channel.	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.