All Products
Search
Document Center

Cloud Config:ListAggregateConfigDeliveryChannels

Last Updated:Apr 12, 2024

Queries the information about all delivery channels in an account group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:ListAggregateConfigDeliveryChannelsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DeliveryChannelIdsstringNo

The IDs of the delivery channels. Separate multiple IDs with commas (,).

cdc-d9106457e0d900b1****
AggregatorIdstringYes

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 parameters

ParameterTypeDescriptionExample
object

N/A.

DeliveryChannelsobject []

The information about the delivery channels.

Statusinteger

The status of the delivery channel. Valid values:

  • 0: The delivery channel is disabled.
  • 1: The delivery channel is enabled.
1
DeliveryChannelNamestring

The name of the delivery channel.

myDeliveryChannel
DeliveryChannelIdstring

The ID of the delivery channel.

cdc-d9106457e0d900b1****
DeliveryChannelTypestring

The type of the delivery channel. Valid values:

  • OSS: Object Storage Service (OSS)
  • MNS: Message Service (MNS)
  • SLS: Log Service
OSS
DeliveryChannelTargetArnstring

The ARN of the delivery destination.

  • If the value of the DeliveryChannelType parameter is OSS, the value of this parameter is the ARN of the destination OSS bucket.
  • If the value of the DeliveryChannelType parameter is MNS, the value of this parameter is the ARN of the destination MNS topic.
  • If the value of the DeliveryChannelType parameter is SLS, the value of this parameter is the ARN of the destination Log Service Logstore.
acs:oss:cn-shanghai:120886317861****:new-bucket
DeliveryChannelAssumeRoleArnstring

The ARN of the role that is assigned to the delivery channel.

acs:ram::120886317861****:role/aliyunserviceroleforconfig
DeliveryChannelConditionstring

The rule that is attached to the delivery channel. This parameter is available 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 subscribed:

    • 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 indicates 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 setting of the resource types of the events to which you want to subscribe is in the following format: {"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}.

      The values field indicates the resource types of the events to which you want to subscribe. The value of the field is a JSON array. Examples:

[{"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 set the DeliveryChannelType parameter to SLS, the setting of the resource types of the snapshots to which you want to deliver is 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 to which you want to deliver. The value of the field is a JSON array. Examples:

[{"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}]
OversizedDataOSSTargetArnstring

The ARN of the OSS bucket to which the delivered data is transferred when the size of the data exceeds the specified upper limit of the delivery channel.

acs:oss:cn-shanghai:100931896542****:new-bucket
Descriptionstring

The description of the delivery channel.

My OSS delivery.
ConfigurationSnapshotboolean

Indicates whether the specified destination receives scheduled resource snapshots. Cloud Config delivers scheduled resource snapshots at 04:00Z and 16:00Z to OSS, MNS, or Log Service every day. The time is displayed in UTC. Valid values:

  • true: The specified destination receives scheduled resource snapshots.
  • false: The specified destination does not receive scheduled resource snapshots.
false
ConfigurationItemChangeNotificationboolean

Indicates whether the specified destination receives resource change logs. If the value of this parameter is true, Cloud Config delivers the resource change logs to OSS, Log Service, or MNS when the configurations of the resources change. Valid values:

  • true: The specified destination receives resource change logs.
  • false: The specified destination does not receive resource change logs.
true
NonCompliantNotificationboolean

Indicates whether the specified destination receives resource non-compliance events. If the value of this parameter is true, Cloud Config delivers resource 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
AggregatorIdstring

The ID of the account group.

ca-a4e5626622af0079****
AccountIdlong

The ID of the member in the account group.

120886317861****
DeliverySnapshotTimestring

The time when Cloud Config delivers scheduled resources snapshots every day.

Format: HH:mmZ. This time is displayed in UTC.

09:10Z
RequestIdstring

The request ID.

DC300244-FCE3-5061-8214-C27ECB668487

Examples

Sample success responses

JSONformat

{
  "DeliveryChannels": [
    {
      "Status": 1,
      "DeliveryChannelName": "myDeliveryChannel",
      "DeliveryChannelId": "cdc-d9106457e0d900b1****",
      "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,
      "ConfigurationItemChangeNotification": true,
      "NonCompliantNotification": false,
      "AggregatorId": "ca-a4e5626622af0079****",
      "AccountId": 0,
      "DeliverySnapshotTime": "09:10Z"
    }
  ],
  "RequestId": "DC300244-FCE3-5061-8214-C27ECB668487"
}

Error codes

HTTP status codeError codeError messageDescription
400DeliveryChannelNotExistsThe delivery channel does not exist.The delivery channel does not exist.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.