GetConfigDeliveryChannel - Cloud Config - Alibaba Cloud Documentation Center

Queries the details of a specified delivery channel.

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

get

*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 ID of a delivery channel, see ListConfigDeliveryChannels.	cdc-d9106457e0d900b1****

Response elements

Element	Type	Description	Example
	object	None.
DeliveryChannel	object	The information about the delivery channel.
Status	integer	The status of the delivery channel. Valid values: 0: The delivery channel is disabled. 1: The delivery channel is enabled.	1
DeliveryChannelId	string	The ID of the delivery channel.	cdc-d9106457e0d900b1****
DeliveryChannelName	string	The name of the delivery channel.	myDeliveryChannel
DeliveryChannelType	string	The type of the delivery channel. Valid values: OSS: Object Storage Service. MNS: Simple Message Queue (formerly MNS). SLS: Simple Log Service.	OSS
DeliveryChannelTargetArn	string	The Alibaba Cloud Resource Name (ARN) of the delivery destination. If the DeliveryChannelType parameter is set to OSS, this parameter is the ARN of the destination OSS bucket. If the DeliveryChannelType parameter is set to MNS, this parameter is the ARN of the destination MNS topic. If the DeliveryChannelType parameter is set to SLS, this parameter is the ARN of the destination Simple Log Service 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 that is attached to the delivery channel. This parameter is available only for delivery channels of the MNS type and for snapshot deliveries to delivery channels of the SLS type. If you deliver data to an MNS topic, you can specify the lowest risk level of the events to subscribe to and the resource types to subscribe to. The lowest risk level of the events to subscribe to: `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`. The `value` parameter indicates the risk level. Valid values: 1 (high), 2 (medium), and 3 (low). The resource types to subscribe to: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. The `values` parameter indicates the resource types. 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 deliver snapshots to an SLS Logstore, you can specify the resource types to deliver: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. The `values` parameter indicates the resource types. 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	The ARN of the OSS bucket to which the delivered 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.
ConfigurationSnapshot	boolean	Indicates 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: Deliver scheduled resource snapshots. false: Do not deliver scheduled resource snapshots.	false
CompliantSnapshot	boolean	Indicates whether to deliver compliance snapshots. Cloud Config delivers compliance and non-compliance information of resources to SLS. Valid values: true: Deliver compliance snapshots. false: Do not deliver compliance snapshots.	false
ConfigurationItemChangeNotification	boolean	Indicates whether to deliver resource configuration changes. When the configuration of a resource changes, Cloud Config delivers the resource configuration changes to OSS, SLS, or MNS. Valid values: true: Deliver resource configuration changes. false: Do not deliver resource configuration changes.	true
NonCompliantNotification	boolean	Indicates whether to deliver resource non-compliance events. When a resource is evaluated as non-compliant, Cloud Config delivers the non-compliance events to SLS or MNS. Valid values: true: Deliver resource non-compliance events. false: Do not deliver resource non-compliance events.	false
AccountId	integer	The ID of the current Alibaba Cloud account.	120886317861****
DeliverySnapshotTime	string	The time when Cloud Config starts to deliver scheduled resource snapshots every day. The time is in the `HH:mmZ` format (UTC).	09:10Z
RequestId	string	The request ID.	DC300244-FCE3-5061-8214-C27ECB668487

Examples

Success response

JSON format

{
  "DeliveryChannel": {
    "Status": 1,
    "DeliveryChannelId": "cdc-d9106457e0d900b1****",
    "DeliveryChannelName": "myDeliveryChannel",
    "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.",
    "ConfigurationSnapshot": false,
    "CompliantSnapshot": 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.