Use GetAggregateConfigDeliveryChannel to query a delivery channel in an account group - Cloud Config - Alibaba Cloud - Cloud Config

Queries information about a delivery channel in an account group.

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

get

*AggregateDelivery

acs:config:*:{#accountId}:aggregatedelivery/{#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 ListAggregateConfigDeliveryChannels.	cdc-d9106457e0d900b1****
AggregatorId	string	Yes	The ID of the account group. For more information about how to obtain the ID of the account group, see ListAggregators.	ca-a4e5626622af0079****

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

Response elements

Element	Type	Description	Example
	object	N/A.
DeliveryChannel	object	The delivery channel information.
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 (OSS) MNS: Message Service (MNS) SLS: Log Service	OSS
DeliveryChannelTargetArn	string	The ARN of the delivery destination. If DeliveryChannelType is set to OSS, the value is the ARN of the destination OSS bucket. If DeliveryChannelType is set to MNS, the value is the ARN of the destination MNS topic. If DeliveryChannelType is set to SLS, the value is the ARN of the destination Log Service Logstore.	acs:oss:cn-shanghai:120886317861****:new-bucket
DeliveryChannelAssumeRoleArn	string	The ARN of the role assigned to the delivery channel.	acs:ram::120886317861****:role/aliyunserviceroleforconfig
DeliveryChannelCondition	string	The rule attached to the delivery channel. This parameter is applicable when you deliver data of all types to MNS or deliver snapshots to Log Service. If the value of the DeliveryChannelType parameter is MNS, take note of the following settings of the lowest risk level and resource types of the events to which you subscribe: The lowest risk level of the events to which you want to subscribe is in the following format: `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`. The `value` field specifies the risk level of the events to which you want to subscribe. Valid values: 1, 2, and 3. The value 1 indicates the high risk level, the value 2 indicates the medium risk level, and the value 3 indicates the low risk level. The resource types of the events to which you want to subscribe are specified in the following format: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. The `values` field specifies the resource types of the events to which you want to subscribe. 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 DeliveryChannelType is set to SLS, the resource types of the snapshots for delivery are specified in the following format: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`. The `values` field specifies the resource types of the snapshots for delivery. 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 data is transferred when the data size exceeds the upper limit of the delivery channel.	acs:oss:cn-shanghai:100931896542****:new-bucket
Description	string	The description of the delivery channel.	My OSS delivery.
CompliantSnapshot	boolean	Indicates whether the destination receives scheduled compliant snapshots. Cloud Config delivers compliant snapshots to Log Service at `04:00Z` and `16:00Z` every day (UTC). Valid values: true: The specified destination receives scheduled compliant snapshots. false: The specified destination does not receive scheduled compliant snapshots.	false
ConfigurationItemChangeNotification	boolean	Indicates whether the destination receives resource change logs. If set to true, Cloud Config delivers resource change logs to OSS, Log Service, or MNS when resource configurations change. Valid values: true: The specified destination receives resource change logs. false: The specified destination does not receive resource change logs.	true
NonCompliantNotification	boolean	Indicates whether the destination receives resource non-compliance events. If set to true, Cloud Config delivers non-compliance events to Log Service or MNS when resources are evaluated as non-compliant. Valid values: true: The specified destination receives resource non-compliance events. false: The specified destination does not receive resource non-compliance events.	false
AggregatorId	string	The ID of the account group.	ca-a4e5626622af0079****
AccountId	string	The ID of the member in the account group.	120886317861****
DeliverySnapshotTime	string	The time when Cloud Config delivers scheduled resource snapshots every day. Format: `HH:mmZ`. This time is displayed in UTC.	09:10Z
ConfigurationSnapshot	boolean	Indicates whether the destination receives scheduled resource snapshots. Cloud Config delivers resource snapshots to OSS, MNS, or Log Service at `04:00Z` and `16:00Z` every day (UTC). Valid values: true: The specified destination receives scheduled resource snapshots. false: The specified destination does not receive scheduled resource snapshots.	false
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.",
    "CompliantSnapshot": false,
    "ConfigurationItemChangeNotification": true,
    "NonCompliantNotification": false,
    "AggregatorId": "ca-a4e5626622af0079****",
    "AccountId": "120886317861****",
    "DeliverySnapshotTime": "09:10Z",
    "ConfigurationSnapshot": false
  },
  "RequestId": "DC300244-FCE3-5061-8214-C27ECB668487"
}

Error codes

HTTP status code	Error code	Error message
400	DeliveryChannelNotExists	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.