DescribeApsDatasources API 概要 - AnalyticDB for MySQL

AnalyticDB Pipeline Service (APS) のデータソースのリストを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeApsDatasources

none

*DBClusterLakeVersion

acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	必須	ページ番号。	1
PageSize	integer	必須	1 ページあたりのエントリ数。	30
RegionId	string	任意	リージョン ID。	cn-hangzhou
DBClusterId	string	任意	AnalyticDB for MySQL クラスターの ID。	amv-******
DatasourceType	string	任意	データソースのタイプ。	SLS
DatasourceName	string	任意	データソースの名前。	test
StartTime	string	任意	照会する時間範囲の開始時刻。	2024-01-01
EndTime	string	任意	照会する時間範囲の終了時刻。	2024-01-30

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	****-5213-**-B608-****
PageNumber	string	ページ番号。	1
PageSize	string	1 ページあたりのエントリ数。	30
TotalCount	string	返されたエントリの総数。	1
ApsDatasources	array<object>	照会された APS データソース。	-
	object	照会された APS データソース。	-
DatasourceName	string	データソースの名前。	test
CreateTime	string	データソースが作成された時刻。	2024-01-10 14:44:33
DatasourceType	string	データソースのタイプ。	SLS
DatasourceDescription	string	データソースの説明。	test
DatasourceId	integer	データソース ID。	1
HasJob	boolean	ジョブがデータソースを使用しているかどうかを示します。	false

例

成功レスポンス

JSONJSON

{
  "RequestId": "******-5213-******-B608-******",
  "PageNumber": "1",
  "PageSize": "30",
  "TotalCount": "1",
  "ApsDatasources": [
    {
      "DatasourceName": "test",
      "CreateTime": "2024-01-10 14:44:33",
      "DatasourceType": "SLS",
      "DatasourceDescription": "test",
      "DatasourceId": 1,
      "HasJob": false
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidInput	The specified parameter is invalid.

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

変更履歴

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