Get details of a delivery channel by using the GetConfigDeliveryChannel API - Cloud Config - Alibaba Cloud - Cloud Config

Queries the information about 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 delivery channel ID. You can call ListConfigDeliveryChannels to obtain the ID. If no delivery channel exists, prepare the required OSS, SLS, or MNS destination resources and the required RAM service-linked role, and then call CreateConfigDeliveryChannel to create a delivery channel and obtain the DeliveryChannelId.	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 settings. Valid values: 0: disabled. 1: enabled.	1
DeliveryChannelId	string	The delivery channel ID.	cdc-d9106457e0d900b1****
DeliveryChannelName	string	The delivery channel name.	myDeliveryChannel
DeliveryChannelType	string	The delivery channel type. 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 channel destination. If DeliveryChannelType is set to OSS, the value is the ARN of the bucket. If DeliveryChannelType is set to MNS, the value is the ARN of the topic. If DeliveryChannelType is set to SLS, the value is the ARN of the Logstore.	acs:oss:cn-shanghai:120886317861****:new-bucket
DeliveryChannelAssumeRoleArn	string	The ARN of the role assumed by the delivery channel.	acs:ram::120886317861****:role/aliyunserviceroleforconfig
DeliveryChannelCondition	string	The rule attached to the delivery channel. This parameter supports all deliveries for the MNS channel and snapshot deliveries for the SLS channel. If you specify the minimum risk level and resource types for MNS subscription events: The minimum risk level of subscription events is `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`. `value` specifies the risk level that you want to filter. Valid values: 1 indicates high risk, 2 indicates medium risk, and 3 indicates low risk. The resource types of subscription 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}]` If you specify the resource types for SLS snapshot deliveries, 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	The ARN of the OSS bucket to which delivery data is transferred when the data size exceeds the delivery channel limit.	acs:oss:cn-shanghai:100931896542****:new-bucket
Description	string	The description of the delivery channel.	My OSS delivery.
ConfigurationSnapshot	boolean	Indicates whether scheduled resource snapshots are received. Cloud Config delivers scheduled resource snapshots to OSS or SLS at `04:00Z` and `16:00Z` (UTC) every day. Valid values: true: Scheduled resource snapshots are received. false: Scheduled resource snapshots are not received.	false
CompliantSnapshot	boolean	Indicates whether compliance snapshots are received. Cloud Config delivers resource compliance and non-compliance information to SLS. Valid values: true: Compliance snapshots are received. false: Compliance snapshots are not received.	false
ConfigurationItemChangeNotification	boolean	Indicates whether resource configuration history is accepted. When a resource configuration changes, Cloud Config delivers the resource configuration history to OSS, SLS, or Simple Message Queue (formerly MNS). Valid values: true: Resource configuration history is accepted. false: Resource configuration history is not accepted.	true
NonCompliantNotification	boolean	Indicates whether resource non-compliance events are accepted. 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: Resource non-compliance events are accepted. false: Resource non-compliance events are not accepted.	false
AccountId	integer	The current Alibaba Cloud account ID.	120886317861****
DeliverySnapshotTime	string	The time when the scheduled resource snapshot delivery starts each day. Format: `HH:mmZ` (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.