すべてのプロダクト
Search

このプロダクト

    :ListApiDatasource

    ドキュメントセンター

    :ListApiDatasource

    最終更新日:Sep 09, 2026

    API データソースのリストを照会します。

    操作説明

    パラメーターの説明の詳細については、「API データソースの作成」を参照してください。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    quickbi-public:ListApiDatasource

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ワークスペースの ID。

    89713491-cb4f-4579-b889-e82c35f1****
    PageNum

    integer

    任意

    API データソースリストのページ番号。

    • 最小値: 1。

    • デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページングクエリにおける 1 ページあたりの行数。

    • デフォルト値: 10。

    • 最大値: 100。

    10
    KeyWord

    string

    任意

    API データソース名のキーワード。

    Test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエストの ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    クエリ結果。

    Data

    array<object>

    API データソースのリスト。

    object

    ApiId

    string

    API データソースの ID。

    0f2c3c6409be4dc0810f2a5785e816a8
    Body

    string

    JSON フォーマットの検索文のパラメーター設定。ユーザー定義が可能です。

    {"key1":"値1"}
    DataSize

    number

    API データソースのデータ量。

    • 単位: KB。

    0.39746094
    DateUpdateTime

    string

    API データソースの最終同期時間。形式の例: YYYY-MM-DD HH:mm:ss。

    2022-05-25 16:19:43
    GmtCreate

    string

    作成時間。

    2022-05-25 16:19:43
    GmtModified

    string

    変更時間。

    2022-05-25 16:19:43
    JobId

    string

    タスクの ID。

    REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8
    Parameters

    string

    JSONArray フォーマットのパラメーター設定。

    • name: パラメーター名。

    • value: パラメーターの値。

    [{"name":"token","値":"xxxxxxxxxxxx"},{"name":"pageSize","値":100}]
    ShowName

    string

    API データソースの名前。

    TestDataSource
    StatusType

    integer

    API データソースの同期タスクのステータス。

    列挙値:

    • 0 :

      保留中。

    • 1 :

      実行中。

    • 2 :

      成功。

    • 3 :

      失敗。

    2
    PageNum

    integer

    返されるデータのページ番号。ページングに使用されます。

    1
    PageSize

    integer

    リクエストで指定された 1 ページあたりの行数。

    10
    TotalNum

    integer

    合計行数。

    1
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値:

    • true: リクエストが成功しました。

    • false: リクエストが失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "ApiId": "0f2c3c6409be4dc0810f2a5785e816a8",
        "Body": "{\"key1\":\"value1\"}",
        "DataSize": 0.39746094,
        "DateUpdateTime": "2022-05-25 16:19:43",
        "GmtCreate": "2022-05-25 16:19:43",
        "GmtModified": "2022-05-25 16:19:43",
        "JobId": "REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8",
        "Parameters": "[{\"name\":\"token\",\"value\":\"xxxxxxxxxxxx\"},{\"name\":\"pageSize\",\"value\":100}]",
        "ShowName": "测试数据源",
        "StatusType": 2
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1
  },
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Workspace.NotIn.Organization The workspace is not owned by the organization. ワークスペースが組織に属していません。

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

    変更履歴

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