すべてのプロダクト
Search

このプロダクト

    DataWorks:ListDataServiceApis

    ドキュメントセンター

    DataWorks:ListDataServiceApis

    最終更新日:Mar 21, 2026

    開発ステータスの API のリストを照会します。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効な値：1～100。デフォルト値：10。

    10
    ProjectId

    integer

    必須

    ワークスペース ID。

    10000
    TenantId

    integer

    任意

    テナント ID。テナント ID を取得するには、次の手順を実行します：DataWorks コンソールにログインします。ご利用のワークスペースを見つけて、DataStudio ページに移動します。DataStudio ページで、右上のログインユーザー名をクリックし、メニューセクションの [ユーザー情報] をクリックします。

    10001
    ApiNameKeyword

    string

    任意

    API 名のキーワード。このキーワードは、名前にキーワードが含まれる API を検索するために使用されます。

    My API name
    ApiPathKeyword

    string

    任意

    API パスのキーワード。このキーワードは、パスにキーワードが含まれる API を検索するために使用されます。

    /test/
    CreatorId

    string

    任意

    API の作成者が使用する Alibaba Cloud アカウントの ID。この ID は、作成者によって作成された API を検索するために使用されます。

    123456

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    RequestId

    string

    リクエスト ID。

    0000-ABCD-EFG****
    ErrorMessage

    string

    エラーメッセージ。

    The connection does not exist.
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrorCode

    string

    エラーコード。

    Invalid.Tenant.ConnectionNotExists
    Data

    object

    返されたデータ。

    PageNumber

    integer

    ページ番号。このパラメーターの値は、リクエストの PageNumber パラメーターの値と同じです。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効な値：1～50。デフォルト値：10。

    10
    TotalCount

    integer

    返されたエントリの総数。

    100
    Apis

    array<object>

    開発ステータスの API のリスト。

    array<object>

    返された結果。

    Timeout

    integer

    API リクエストのタイムアウト期間。単位：ミリ秒。

    10000
    Status

    integer

    API のステータス。有効な値：0 と 1。値 0 は API が公開されていないことを示します。値 1 は API が公開済みであることを示します。

    0
    ApiId

    integer

    API ID。

    10002
    ApiMode

    integer

    API のタイプ。有効な値：0、1、2。値 0 は API がウィザードモードで生成されたことを示します。値 1 は API がスクリプトモードで生成されたことを示します。値 2 は API が登録によって生成されたことを示します。

    0
    ProjectId

    integer

    ワークスペース ID。

    10000
    ResponseContentType

    integer

    API リクエストのレスポンスが返されるフォーマット。有効な値：0 と 1。値 0 は JSON フォーマットを示します。値 1 は XML フォーマットを示します。ウィザードモードまたはスクリプトモードで生成された API は JSON フォーマットをサポートします。登録によって生成された API は JSON および XML フォーマットをサポートします。

    0
    CreatorId

    string

    API の作成者が使用する Alibaba Cloud アカウントの ID。

    1234567
    VisibleRange

    integer

    API が表示される範囲。有効な値：0 と 1。値 0 は API がワークスペース内で表示されることを示します。値 1 は API がその所有者にのみ表示されることを示します。

    0
    ModifiedTime

    string

    API が最後に変更された時刻。

    2020-06-23T00:21:01+0800
    OperatorId

    string

    API を最後に変更したユーザーが使用する Alibaba Cloud アカウントの ID。

    2345678
    GroupId

    string

    グループ ID。

    abcde123456789
    Description

    string

    API の説明。

    Test API description
    FolderId

    integer

    フォルダー ID。

    0
    RequestMethod

    integer

    API のリクエストメソッド。有効な値：0、1、2、3。値 0 は GET メソッドを示します。値 1 は POST メソッドを示します。値 2 は PUT メソッドを示します。値 3 は DELETE メソッドを示します。ウィザードモードまたはスクリプトモードで生成された API は GET および POST メソッドをサポートします。登録によって生成された API は GET、POST、PUT、DELETE メソッドをサポートします。

    0
    CreatedTime

    string

    API が作成された時刻。

    2020-06-23T00:21:01+0800
    ApiName

    string

    API の名前。

    My API name
    TenantId

    integer

    テナント ID。

    10000
    ApiPath

    string

    API のパス。

    /test/1
    Protocols

    array

    フィールドのリスト。

    integer

    API で使用されるプロトコル。有効な値：0 と 1。値 0 は HTTP を示します。値 1 は HTTPS を示します。複数のプロトコルはリストで表示されます。

    0
    RegistrationDetails

    object

    登録によって生成された API の詳細。このパラメーターは、API が登録によって生成された場合にのみ返されます。

    ServiceHost

    string

    バックエンドサービスの URL。

    http://example.aliyundoc.com
    ServiceContentType

    integer

    API リクエストのレスポンスが返されるフォーマット。有効な値：0 と 1。値 0 は JSON フォーマットを示します。値 1 は XML フォーマットを示します。ウィザードモードまたはスクリプトモードで生成された API は JSON フォーマットをサポートします。登録によって生成された API は JSON および XML フォーマットをサポートします。

    0
    ServicePath

    string

    バックエンドサービスのパス。

    /index
    SuccessfulResultSample

    string

    API の成功レスポンスのサンプル。

    {"success": true}
    FailedResultSample

    string

    API のエラーレスポンスのサンプル。

    {"success": false}
    ServiceRequestBodyDescription

    string

    バックエンドサービスを呼び出すために開始されたリクエストボディの説明。

    {"abc":1}
    RegistrationErrorCodes

    array<object>

    登録によって生成された API に対して返されるエラーコード。

    object

    ErrorMessage

    string

    エラーメッセージ。

    fail to call
    ErrorCode

    string

    エラーコード。

    1001
    ErrorSolution

    string

    エラーを修正するためのソリューション。

    retry
    RegistrationRequestParameters

    array<object>

    登録によって生成された API のリクエストパラメーター。

    object

    ColumnName

    string

    関連付けられたフィールドの名前。このパラメーターは、API がウィザードモードで生成された場合にのみサポートされます。

    column1
    ParameterName

    string

    パラメーター名。

    name1
    ParameterPosition

    integer

    パラメーターの位置。有効な値：0、1、2、3。値 0 は、パラメーターがリクエストの URL パスにあることを示します。値 1 は、パラメーターがリクエスト URL のクエリパラメーターにあることを示します。値 2 は、パラメーターがリクエストヘッダーにあることを示します。値 3 は、パラメーターがリクエストボディにあることを示します。ウィザードモードまたはスクリプトモードで生成された API は、クエリの位置のみをサポートします。リクエストメソッドが GET または DELETE である登録によって生成された API は、クエリと Head の位置をサポートします。リクエストメソッドが PUT または POST である登録によって生成された API は、クエリ、Head、Body の位置をサポートします。

    0
    ParameterDescription

    string

    説明。

    description1
    DefaultValue

    string

    デフォルト値。

    default1
    ParameterOperator

    integer

    パラメーターの値に使用される演算子。有効な値：0、1、2、3。値 0 は等しい (Equal) 演算子を示します。値 1 は Like 演算子を示します。値 2 は Const 演算子を示します。値 3 は In 演算子を示します。ウィザードモードで生成された API は、等しい (Equal)、Like、In 演算子をサポートします。スクリプトモードで生成された API は、等しい (Equal) 演算子をサポートします。登録によって生成された API は、等しい (Equal) および Const 演算子をサポートします。

    0
    ParameterDataType

    integer

    パラメーターのデータ型。有効な値：

    • 0：String

    • 1：Int

    • 2：Long

    • 3：Float

    • 4：Double

    • 5：Boolean

    • 6：StringList

    • 7：IntList

    • 8：LongList

    • 9：FloatList

    • 10：DoubleList

    • 11：BooleanList

    0
    ExampleValue

    string

    サンプル値。

    example1
    IsRequiredParameter

    boolean

    パラメーターが必須かどうかを示します。

    true
    ScriptDetails

    object

    スクリプトモードで生成された API の詳細。このパラメーターは、API がスクリプトモードで生成された場合にのみ返されます。

    Script

    string

    SQL スクリプト。

    select a from t
    IsPagedResponse

    boolean

    エントリがページごとに返されるかどうかを示します。

    true
    ScriptRequestParameters

    array<object>

    スクリプトモードで生成された API のリクエストパラメーター。

    object

    ColumnName

    string

    関連付けられたフィールドの名前。このパラメーターは、API がウィザードモードで生成された場合にのみサポートされます。

    column1
    ParameterName

    string

    パラメーター名。

    param1
    ParameterPosition

    integer

    パラメーターの位置。有効な値：

    • 0：パラメーターがリクエストの URL パスにあることを示します。

    • 1：パラメーターがリクエスト URL のクエリパラメーターにあることを示します。

    • 2：パラメーターがリクエストヘッダーにあることを示します。

    • 3：パラメーターがリクエストボディにあることを示します。

    ウィザードモードまたはスクリプトモードで生成された API は、クエリの位置のみをサポートします。リクエストメソッドが GET または DELETE である登録によって生成された API は、クエリと Head の位置をサポートします。リクエストメソッドが PUT または POST である登録によって生成された API は、クエリ、Head、Body の位置をサポートします。

    0
    ParameterDescription

    string

    説明。

    description1
    DefaultValue

    string

    デフォルト値。

    default1
    ParameterOperator

    integer

    パラメーターの値に使用される演算子。有効な値：

    • 0：等しい (Equal)

    • 1：Like

    • 2：Const

    • 3：In

    ウィザードモードで生成された API は、等しい (Equal)、Like、In 演算子をサポートします。スクリプトモードで生成された API は、等しい (Equal) 演算子をサポートします。登録によって生成された API は、等しい (Equal) および Const 演算子をサポートします。

    0
    ParameterDataType

    integer

    パラメーターのデータ型。有効な値：

    • 0：String

    • 1：Int

    • 2：Long

    • 3：Float

    • 4：Double

    • 5：Boolean

    • 6：StringList

    • 7：IntList

    • 8：LongList

    • 9：FloatList

    • 10：DoubleList

    • 11：BooleanList

    0
    ExampleValue

    string

    サンプル値。

    example1
    IsRequiredParameter

    boolean

    パラメーターが必須かどうかを示します。

    true
    ScriptResponseParameters

    array<object>

    スクリプトモードで生成された API のレスポンスパラメーター。

    object

    ParameterDescription

    string

    説明。

    description2
    ColumnName

    string

    関連付けられたフィールドの名前。このパラメーターは、API がウィザードモードで生成された場合にのみサポートされます。

    column2
    ParameterName

    string

    パラメーター名。

    param2
    ParameterDataType

    integer

    パラメーターのデータ型。有効な値：

    • 0：String

    • 1：Int

    • 2：Long

    • 3：Float

    • 4：Double

    • 5：Boolean

    • 6：StringList

    • 7：IntList

    • 8：LongList

    • 9：FloatList

    • 10：DoubleList

    • 11：BooleanList

    0
    ExampleValue

    string

    サンプル値。

    example2
    ScriptConnection

    object

    スクリプトモードで生成された API のデータソース情報。

    TableName

    string

    データソース内のテーブル名。

    t
    ConnectionId

    integer

    データソース ID。

    123
    WizardDetails

    object

    ウィザードモードで生成された API の詳細。このパラメーターは、API がウィザードモードで生成された場合にのみ返されます。

    IsPagedResponse

    boolean

    エントリがページごとに返されるかどうかを示します。

    true
    WizardRequestParameters

    array<object>

    ウィザードモードで生成された API のリクエストパラメーター。

    object

    ColumnName

    string

    関連付けられたフィールドの名前。このパラメーターは、API がウィザードモードで生成された場合にのみサポートされます。

    column1
    ParameterName

    string

    パラメーター名。

    param1
    ParameterPosition

    integer

    パラメーターの位置。有効な値：0、1、2、3。値 0 は、パラメーターがリクエストの URL パスにあることを示します。値 1 は、パラメーターがリクエスト URL のクエリパラメーターにあることを示します。値 2 は、パラメーターがリクエストヘッダーにあることを示します。値 3 は、パラメーターがリクエストボディにあることを示します。ウィザードモードまたはスクリプトモードで生成された API は、クエリの位置のみをサポートします。リクエストメソッドが GET または DELETE である登録によって生成された API は、クエリと Head の位置をサポートします。リクエストメソッドが PUT または POST である登録によって生成された API は、クエリ、Head、Body の位置をサポートします。

    0
    ParameterDescription

    string

    説明。

    description1
    DefaultValue

    string

    デフォルト値。

    default1
    ParameterOperator

    integer

    パラメーターの値に使用される演算子。有効な値：0、1、2、3。値 0 は等しい (Equal) 演算子を示します。値 1 は Like 演算子を示します。値 2 は Const 演算子を示します。値 3 は In 演算子を示します。ウィザードモードで生成された API は、等しい (Equal)、Like、In 演算子をサポートします。スクリプトモードで生成された API は、等しい (Equal) 演算子をサポートします。登録によって生成された API は、等しい (Equal) および Const 演算子をサポートします。

    0
    ParameterDataType

    integer

    パラメーターのデータ型。有効な値：

    • 0：String

    • 1：Int

    • 2：Long

    • 3：Float

    • 4：Double

    • 5：Boolean

    • 6：StringList

    • 7：IntList

    • 8：LongList

    • 9：FloatList

    • 10：DoubleList

    • 11：BooleanList

    0
    ExampleValue

    string

    サンプル値。

    example1
    IsRequiredParameter

    boolean

    パラメーターが必須かどうかを示します。

    true
    WizardResponseParameters

    array<object>

    ウィザードモードで生成された API のレスポンスパラメーター。

    object

    ParameterDescription

    string

    説明。

    description2
    ColumnName

    string

    関連付けられたフィールドの名前。このパラメーターは、API がウィザードモードで生成された場合にのみサポートされます。

    column2
    ParameterName

    string

    パラメーター名。

    param2
    ParameterDataType

    integer

    パラメーターのデータ型。有効な値：

    • 0：String

    • 1：Int

    • 2：Long

    • 3：Float

    • 4：Double

    • 5：Boolean

    • 6：StringList

    • 7：IntList

    • 8：LongList

    • 9：FloatList

    • 10：DoubleList

    • 11：BooleanList

    0
    ExampleValue

    string

    サンプル値。

    example2
    WizardConnection

    object

    ウィザードモードで生成された API のデータソース情報。

    TableName

    string

    データソース内のテーブル名。

    t
    ConnectionId

    integer

    データソース ID。

    123

    API のタイプごとに詳細が異なるパラメーターで返されます。ウィザードモードで生成された API の詳細は WizardDetails パラメーターで返されます。スクリプトモードで生成された API の詳細は ScriptDetails パラメーターで返されます。登録によって生成された API の詳細は RegistrationDetails パラメーターで返されます。

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Apis": [
      {
        "Timeout": 10000,
        "Status": 0,
        "ApiId": 10002,
        "ApiMode": 0,
        "ProjectId": 10000,
        "ResponseContentType": 0,
        "CreatorId": "1234567",
        "VisibleRange": 0,
        "ModifiedTime": "2020-06-23T00:21:01+0800",
        "OperatorId": "2345678",
        "GroupId": "abcde123456789",
        "Description": "Test API description",
        "FolderId": 0,
        "RequestMethod": 0,
        "CreatedTime": "2020-06-23T00:21:01+0800",
        "ApiName": "My API name",
        "TenantId": 10000,
        "ApiPath": "/test/1",
        "Protocols": [
          0
        ],
        "RegistrationDetails": {
          "ServiceHost": "http://example.aliyundoc.com",
          "ServiceContentType": 0,
          "ServicePath": "/index",
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "ServiceRequestBodyDescription": "{\"abc\":1}",
          "RegistrationErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "RegistrationRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "name1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ]
        },
        "ScriptDetails": {
          "Script": "select a from t",
          "IsPagedResponse": true,
          "ScriptRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ],
          "ScriptResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ColumnName": "column2",
              "ParameterName": "param2",
              "ParameterDataType": 0,
              "ExampleValue": "example2"
            }
          ],
          "ScriptConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        },
        "WizardDetails": {
          "IsPagedResponse": true,
          "WizardRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ],
          "WizardResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ColumnName": "column2",
              "ParameterName": "param2",
              "ParameterDataType": 0,
              "ExampleValue": "example2"
            }
          ],
          "WizardConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.UserId.Missing An internal system error occurred. Try again later.
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    変更履歴

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