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) for storage.
Operation description
Background information
-
Event delivery 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.
-
Event delivery 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.
-
Event delivery 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 in each account group.
Operation description
This topic provides an example of how to create a delivery channel for the account group ca-a4e5626622af0079****. The delivery channel type is OSS and the ARN of the delivery channel 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
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
config:CreateAggregateConfigDeliveryChannel |
create |
*AggregateDelivery
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AggregatorId |
string |
Yes |
The account group ID. For information about how to obtain the account group ID, see ListAggregators. |
ca-a4e5626622af0079**** |
| 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:
Valid values:
|
OSS |
| DeliveryChannelTargetArn |
string |
Yes |
The Alibaba Cloud Resource Name (ARN) of the delivery channel destination. Valid values:
|
acs:oss:cn-shanghai:100931896542****:new-bucket |
| DeliveryChannelCondition |
string |
No |
The additional rule of the delivery channel. This parameter supports all deliveries for the MNS channel and snapshot deliveries for the SLS channel.
|
[{"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 limit. The format is If you do not configure this parameter, Cloud Config delivers only summary information. Note
This parameter is supported only for SLS and MNS delivery channels. The delivery channel limit for SLS is 1 MB, and the delivery channel limit for Simple Message Queue (formerly MNS) 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. Generate a parameter value from your client to ensure that the value is unique among different requests. ClientToken supports 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 accept resource scheduled snapshots. Cloud Config delivers resource scheduled snapshots to OSS and Simple Message Queue (formerly MNS) at
Note
Note
|
true |
| CompliantSnapshot |
boolean |
No |
Specifies whether to receive compliance snapshots. Cloud Config delivers resource compliance and non-compliance information to SLS. Valid values:
|
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:
Note
Note
Note
|
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:
Note
Note
|
false |
| DeliverySnapshotTime |
string |
No |
The time when the daily delivery of resource scheduled snapshots starts. The format is Note
When 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 |
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.