UpdateConfigDeliveryChannel - Cloud Config - Alibaba Cloud Documentation Center

This operation modifies a delivery channel for the current account.

Operation description

This topic provides an example of how to change the status of the delivery channel cdc-8e45ff4e06a3a8**** to 0 (disabled). After you disable the delivery channel, Cloud Config retains the most recent delivery configuration and stops delivering resource data.

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

update

*Delivery

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

None

Request parameters

Parameter	Type	Required	Description	Example
DeliveryChannelId	string	Yes	The ID of the delivery channel. For more information about how to obtain the delivery channel ID, see ListConfigDeliveryChannels.	cdc-8e45ff4e06a3a8****
DeliveryChannelName	string	No	The name of the delivery channel.	testoss
DeliveryChannelTargetArn	string	No	The Alibaba Cloud Resource Name (ARN) of the delivery destination. Valid values: If the delivery channel is Object Storage Service (OSS), the value is in the format of `acs:oss:{RegionId}:{accountId}:{bucketName}`. Example: `acs:oss:cn-shanghai:100931896542**:new-bucket`. If the delivery channel is MNS, the value is in the format of `acs:mns:{RegionId}:{accountId}:/topics/{topicName}`. Example: `acs:mns:cn-shanghai:100931896542:/topics/topic1`. If the delivery channel is Simple Log Service (SLS), the value is in the format of `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 rule that is attached to the delivery channel. This parameter is applicable to all deliveries to MNS and snapshot deliveries to SLS. If you specify the minimum risk level of events and the resource types for an MNS subscription, use the following formats: The minimum risk level of the 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). The resource types of the subscribed events: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. `values` specifies the resource types of the subscribed events. The value is a JSON array. 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}]` If you specify the resource types of snapshots delivered to SLS, use the following format: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. `values` specifies the resource types of the snapshots to deliver. The value is a JSON array. 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 where data is delivered when the data size exceeds the limit of the delivery channel. The value is in the format of `acs:oss:{RegionId}:{accountId}:{bucketName}`. If you do not specify this parameter, Cloud Config delivers only the summary of the data. Note This parameter is available only for delivery channels of the SLS and MNS types. The maximum size of data that can be delivered to SLS is 1 MB. The maximum size of data that can be delivered to 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	A client token used to ensure the idempotence of the request. Use a client to generate the token, and make sure that the token is unique among different requests. 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 or SLS at `04:00Z` and `16:00Z` (UTC) every day. Valid values: true: The scheduled resource snapshots are delivered. false (default): The scheduled resource snapshots are not delivered.	false
CompliantSnapshot	boolean	No	Specifies whether to deliver resource compliance snapshots. Cloud Config delivers resource compliance and non-compliance information to SLS. Valid values: true: The resource compliance snapshots are delivered. false: The resource compliance snapshots are not delivered.	false
ConfigurationItemChangeNotification	boolean	No	Specifies whether to deliver the resource configuration history. Cloud Config delivers the resource configuration history to OSS, SLS, or MNS when the configuration of a resource changes. Valid values: true: The resource configuration history is delivered. false (default): The resource configuration history is not delivered. Note This parameter is available for delivery channels of the OSS, SLS, and MNS types.	false
NonCompliantNotification	boolean	No	Specifies whether to deliver resource non-compliance events. Cloud Config delivers resource non-compliance events to SLS or MNS when a resource is evaluated as non-compliant. Valid values: true: The resource non-compliance events are delivered. false (default): The resource non-compliance events are not delivered. Note This parameter is available only for delivery channels of the SLS and MNS types.	false
Status	integer	No	The status of the delivery channel. Valid values: 0: The delivery channel is disabled. Cloud Config retains the most recent delivery configuration and stops delivering resource data. 1 (default): The delivery channel is enabled.	0
DeliverySnapshotTime	string	No	The time of day when the scheduled resource snapshot is delivered. The value is in the `HH:mmZ` format. The time is in UTC. Note If you enable scheduled delivery of resource snapshots, use this parameter to specify a delivery time. If you do not specify this parameter, Cloud Config delivers the scheduled resource snapshots at `04:00Z` and `16:00Z` by default.	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 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.