GetDeliveryChannel API Reference & Configuration Details - Resource Management - Alibaba Cloud - Resource Management

Retrieves the resource delivery channel for the current account.

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

resourcecenter:GetDeliveryChannel

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DeliveryChannelId	string	No	The delivery channel ID.	dc-6q79dm4o9***

Response elements

Element	Type	Description	Example
	object	The response parameters.
DeliveryChannelDescription	string	The description of the delivery channel.	This is a description.
DeliveryChannelFilter	object	The effective scope of the delivery channel.
ResourceTypes	array	The resource types for delivery.
	string	A single resource type for delivery.	ACS::VPC::VPC
DeliveryChannelId	string	The delivery ID.	dc-6q79dm4o9***
DeliveryChannelName	string	The delivery name.	test-delivery-channel
RequestId	string	The request ID.	17502A1B-7026-5551-8E1C-CCABD0CBC***
ResourceChangeDelivery	object	The resource configuration change delivery.
SlsProperties	object	The SLS configuration.
OversizedDataOssTargetArn	string	The Alibaba Cloud Resource Name (ARN) of the Object Storage Service (OSS) bucket to which oversized data is delivered.	acs:oss:cn-hangzhou:1911422487776***:resourcecenter-oss
TargetArn	string	The delivery target ARN.	acs:log:cn-hangzhou: 1911422487776***:project/delivery/logstore/resourcecenter-sls
TargetType	string	The delivery target type.	SLS
Enabled	string	Indicates whether resource configuration change delivery is enabled. Valid values: true: Enabled. false: Disabled.	true
ResourceSnapshotDelivery	object	The scheduled resource snapshot delivery.
DeliveryTime	string	The delivery time. The value is in UTC and uses the `HH:mmZ` format, for example, `09:00Z`.	09:00Z
TargetArn	string	The delivery target ARN.	acs:oss:cn-hangzhou:1911422487776***:resourcecenter-oss
TargetType	string	The delivery target type.	OSS
CustomExpression	string	The custom expression.	select * from resources limit 100;
SlsProperties	object	The SLS configuration.
OversizedDataOssTargetArn	string	The ARN of the OSS bucket to which oversized data is delivered.	acs:oss:cn-hangzhou:1911422487776***:resourcecenter-oss
Enabled	string	Indicates whether scheduled resource snapshot delivery is enabled. Valid values: true: Enabled. false: Disabled.	true

Examples

Success response

JSON format

{
  "DeliveryChannelDescription": "This is a description.",
  "DeliveryChannelFilter": {
    "ResourceTypes": [
      "ACS::VPC::VPC"
    ]
  },
  "DeliveryChannelId": "dc-6q79dm4o9***",
  "DeliveryChannelName": "test-delivery-channel",
  "RequestId": "17502A1B-7026-5551-8E1C-CCABD0CBC***",
  "ResourceChangeDelivery": {
    "SlsProperties": {
      "OversizedDataOssTargetArn": "acs:oss:cn-hangzhou:1911422487776***:resourcecenter-oss"
    },
    "TargetArn": "acs:log:cn-hangzhou: 1911422487776***:project/delivery/logstore/resourcecenter-sls",
    "TargetType": "SLS",
    "Enabled": "true"
  },
  "ResourceSnapshotDelivery": {
    "DeliveryTime": "09:00Z",
    "TargetArn": "acs:oss:cn-hangzhou:1911422487776***:resourcecenter-oss\n",
    "TargetType": "OSS",
    "CustomExpression": "select * from resources limit 100;",
    "SlsProperties": {
      "OversizedDataOssTargetArn": "acs:oss:cn-hangzhou:1911422487776***:resourcecenter-oss"
    },
    "Enabled": "true"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	NotExists.DeliveryChannelId	The DeliveryChannelId does not exist.	The DeliveryChannelId does not exist.
409	InvalidParameter.DeliveryChannelId	The specified parameter DeliveryChannelId is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.