DescribeDeliveryChannels - Cloud Config - Alibaba Cloud ドキュメントセンター

構成済みの配信チャンネルに関する情報を照会します。

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Config(2020-09-07) - ListConfigDeliveryChannels への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

config:DescribeDeliveryChannels

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
DeliveryChannelIds	string	任意	配信チャンネルの ID です。複数の配信チャンネル ID はカンマ (,) で区切ります。配信チャンネルの ID の取得方法については、「PutDeliveryChannel」をご参照ください。	cdc-d9106457e0d900b1****

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	配信チャンネルに関する情報です。
DeliveryChannels	array<object>	配信チャンネルの詳細です。
	object	配信チャンネルに関する情報です。
ConfigurationItemChangeNotification	boolean	リソースの構成履歴を配信するかどうかを示します。リソースの構成が変更された場合、Cloud Config は構成履歴を Object Storage Service (OSS)、Simple Log Service (SLS)、または Simple Message Queue (旧称 MNS) に配信します。有効な値： true: リソースの構成履歴が配信されます。 false: リソースの構成履歴は配信されません。	true
ConfigurationSnapshot	boolean	スケジュールされたリソーススナップショットを配信するかどうかを示します。毎日 00:00:00 と 12:00:00 に、Cloud Config はスケジュールされたリソーススナップショットを OSS に配信します。有効な値： true: スケジュールされたリソーススナップショットが配信されます。 false: スケジュールされたリソーススナップショットは配信されません。	false
DeliveryChannelAssumeRoleArn	string	配信チャンネルによって偽装されるロールの ARN です。	acs:ram::120886317861****:role/aliyunserviceroleforconfig
DeliveryChannelCondition	string	配信チャンネルにアタッチされているルールです。このパラメーターは、MNS タイプの配信チャンネルでのみサポートされています。サブスクライブする MNS イベントの最低リスクレベルとリソースタイプを指定できます。次のセクションでは、パラメーターについて説明します。サブスクライブするイベントの最低リスクレベル: `{"filterType":"RuleRiskLevel","value":"1","multiple":false}`。 `value` パラメーターは、フィルタリングするリスクレベルを示します。有効な値：1 は高リスク、2 は中リスク、3 は低リスクを示します。サブスクライブするイベントのリソースタイプ: `{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`。 `values` パラメーターは、サブスクライブするイベントのリソースタイプを示します。値は、リソースタイプの JSON 配列です。例: `[{"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}]
DeliveryChannelId	string	配信チャンネルの ID です。	cdc-d9106457e0d900b1****
DeliveryChannelName	string	配信チャンネルの名前です。	myDeliveryChannel
DeliveryChannelTargetArn	string	配信チャンネルの配信先の ARN です。 DeliveryChannelType が OSS に設定されている場合、このパラメーターは配信先バケットの ARN です。 DeliveryChannelType が MNS に設定されている場合、このパラメーターは配信先トピックの ARN です。 DeliveryChannelType が SLS に設定されている場合、このパラメーターは配信先 Logstore の ARN です。	acs:oss:cn-shanghai:120886317861****:new-bucket
DeliveryChannelType	string	配信チャンネルのタイプです。有効な値： OSS: Object Storage Service。 MNS: Simple Message Queue (旧称 MNS)。 SLS: Simple Log Service。	OSS
Description	string	配信チャンネルの説明です。	My OSS delivery.
NonCompliantNotification	boolean	リソースの非準拠イベントを配信するかどうかを示します。リソースが非準拠と見なされた場合、Cloud Config は非準拠イベントを SLS または MNS に配信します。有効な値： true: リソースの非準拠イベントが配信されます。 false: リソースの非準拠イベントは配信されません。	false
OversizedDataOSSTargetArn	string	データサイズが配信チャンネルの制限を超えた場合に、サイズ超過データを配信する OSS バケットの ARN です。	acs:oss:cn-shanghai:100931896542****:new-bucket
Status	integer	配信チャンネルのステータスです。有効な値： 0: 無効。 1: 有効。	1
RequestId	string	リクエストの ID です。	DC300244-FCE3-5061-8214-C27ECB668487

例

成功レスポンス

JSONJSON

{
  "DeliveryChannels": [
    {
      "ConfigurationItemChangeNotification": true,
      "ConfigurationSnapshot": false,
      "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}]",
      "DeliveryChannelId": "cdc-d9106457e0d900b1****",
      "DeliveryChannelName": "myDeliveryChannel",
      "DeliveryChannelTargetArn": "acs:oss:cn-shanghai:120886317861****:new-bucket",
      "DeliveryChannelType": "OSS",
      "Description": "My OSS delivery.",
      "NonCompliantNotification": false,
      "OversizedDataOSSTargetArn": "acs:oss:cn-shanghai:100931896542****:new-bucket",
      "Status": 1
    }
  ],
  "RequestId": "DC300244-FCE3-5061-8214-C27ECB668487"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。