ListDataServicePublishedApis を使用した公開 API リストのクエリ - DataWorks

公開状態の API のリストを照会します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。デフォルトは 10、最大は 100 です。	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 を検索するために使用されます。	12345

レスポンスフィールド

フィールド	型	説明	例
	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～100。デフォルト値：10。	10
TotalCount	integer	返されたエントリの総数。	100
Apis	array<object>	公開された API に関する情報。
	array<object>
Timeout	integer	API リクエストのタイムアウト期間。単位：ミリ秒。	10000
Status	integer	API のステータス。有効値：0 および 1。値 0 は API が公開されていないことを示します。値 1 は API が公開されていることを示します。	1
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。	ab123
Description	string	説明。	Test API description
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。	10001
ApiPath	string	API のパス。	/test/1
Protocols	array	API で使用されるプロトコル。有効値：0 および 1。値 0 は HTTP を示します。値 1 は HTTPS を示します。
	integer	API で使用されるプロトコル。有効値：0 および 1。値 0 は HTTP を示します。値 1 は HTTPS を示します。	0
RegistrationDetails	object	登録によって生成された API の詳細。このパラメーターは、API が登録によって生成された場合にのみ返されます。
ServiceHost	string	バックエンドサービスの URL。	http://www.abc.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
ParameterName	string	パラメーターの名前。	name1
ParameterPosition	integer	パラメーターの位置。有効値： 0：パラメーターがリクエストの URL パスにあることを示します。 1：パラメーターがリクエスト URL のクエリパラメーターにあることを示します。 2：パラメーターがリクエストヘッダーにあることを示します。 3：パラメーターがリクエストボディにあることを示します。ウィザードモードまたはスクリプトモードで生成された API はクエリ位置のみをサポートします。リクエストメソッドが GET または DELETE である登録によって生成された API は、クエリおよびヘッド位置をサポートします。リクエストメソッドが PUT または POST である登録によって生成された API は、クエリ、ヘッド、およびボディ位置をサポートします。	0
ParameterDescription	string	説明。	description1
DefaultValue	string	デフォルト値。	default1
ParameterOperator	integer	パラメーターの値に使用される演算子。有効値： 0：等しい 1：あいまい 2：定数 3：In ウィザードモードで生成された API は、等しい、あいまい、In 演算子をサポートします。スクリプトモードで生成された API は、等しい演算子をサポートします。登録によって生成された API は、等しいおよび定数演算子をサポートします。	0
ExampleValue	string	サンプル値。	example1
ParameterDataType	integer	パラメーターのデータの型。有効値： 0：文字列 1：整数 2：長整数 3：浮動小数点数 4：倍精度浮動小数点数 5：ブール値 6：文字列リスト 7：整数リスト 8：長整数リスト 9：浮動小数点数リスト 10：倍精度浮動小数点数リスト 11：ブール値リスト	0
IsRequiredParameter	boolean	リクエストパラメーターが必須かどうかを示します。	true
ScriptDetails	object	スクリプトモードで生成された API の詳細。このパラメーターは、API がスクリプトモードで生成された場合にのみ返されます。
IsPagedResponse	boolean	エントリがページごとに返されるかどうかを示します。	true
SuccessfulResultSample	string	API の成功レスポンスのサンプル。	{"success": true}
FailedResultSample	string	API のエラーレスポンスのサンプル。	{"success": false}
Script	string	SQL スクリプト。	select a from t
ScriptErrorCodes	array<object>	スクリプトモードで生成された API に対して返されるエラーコード。
	object
ErrorMessage	string	エラーメッセージ。	fail to call
ErrorCode	string	エラーコード。	1001
ErrorSolution	string	エラーを修正するために使用されるソリューション。	retry
ScriptRequestParameters	array<object>	スクリプトモードで生成された API のリクエストパラメーター。
	object
ParameterName	string	パラメーターの名前。	param1
ParameterPosition	integer	パラメーターの位置。有効値： 0：パラメーターがリクエストの URL パスにあることを示します。 1：パラメーターがリクエスト URL のクエリパラメーターにあることを示します。 2：パラメーターがリクエストヘッダーにあることを示します。 3：パラメーターがリクエストボディにあることを示します。ウィザードモードまたはスクリプトモードで生成された API はクエリ位置のみをサポートします。リクエストメソッドが GET または DELETE である登録によって生成された API は、クエリおよびヘッド位置をサポートします。リクエストメソッドが PUT または POST である登録によって生成された API は、クエリ、ヘッド、およびボディ位置をサポートします。	0
ParameterDescription	string	説明。	description1
DefaultValue	string	デフォルト値。	default1
ParameterOperator	integer	パラメーターの値に使用される演算子。有効値： 0：等しい 1：あいまい 2：定数 3：In ウィザードモードで生成された API は、等しい、あいまい、In 演算子をサポートします。スクリプトモードで生成された API は、等しい演算子をサポートします。登録によって生成された API は、等しいおよび定数演算子をサポートします。	0
ExampleValue	string	サンプル値。	example1
ParameterDataType	integer	パラメーターのデータの型。有効値： 0：文字列 1：整数 2：長整数 3：浮動小数点数 4：倍精度浮動小数点数 5：ブール値高度なスクリプトは、次のデータの型もサポートします： 6：文字列リスト 7：整数リスト 8：長整数リスト 9：浮動小数点数リスト 10：倍精度浮動小数点数リスト 11：ブール値リスト	0
IsRequiredParameter	boolean	リクエストパラメーターが必須かどうかを示します。	true
ScriptResponseParameters	array<object>	スクリプトモードで生成された API のレスポンスパラメーター。
	object
ParameterDescription	string	説明。	description2
ParameterName	string	パラメーターの名前。	param2
ExampleValue	string	サンプル値。	example2
ParameterDataType	integer	パラメーターのデータの型。有効値： 0：文字列 1：整数 2：長整数 3：浮動小数点数 4：倍精度浮動小数点数 5：ブール値 6：文字列リスト 7：整数リスト 8：長整数リスト 9：浮動小数点数リスト 10：倍精度浮動小数点数リスト 11：ブール値リスト	0
ScriptConnection	object	スクリプトモードで生成された API のデータソース情報。
TableName	string	データソース内のテーブルの名前。	t
ConnectionId	integer	データソース ID。	123
WizardDetails	object	ウィザードモードで生成された API の詳細。このパラメーターは、API がウィザードモードで生成された場合にのみ返されます。
IsPagedResponse	boolean	エントリがページごとに返されるかどうかを示します。	true
SuccessfulResultSample	string	API の成功レスポンスのサンプル。	{"success": true}
FailedResultSample	string	API のエラーレスポンスのサンプル。	{"success": false}
WizardErrorCodes	array<object>	ウィザードモードで生成された API に対して返されるエラーコード。
	object
ErrorMessage	string	エラーメッセージ。	fail to call
ErrorCode	string	エラーコード。	1001
ErrorSolution	string	エラーを修正するために使用されるソリューション。	retry
WizardRequestParameters	array<object>	ウィザードモードで生成された API のリクエストパラメーター。
	object
ParameterName	string	パラメーターの名前。	param1
ParameterPosition	integer	パラメーターの位置。有効値：0、1、2、3。値 0 はパラメーターがリクエストの URL パスにあることを示します。値 1 はパラメーターがリクエスト URL のクエリパラメーターにあることを示します。値 2 はパラメーターがリクエストヘッダーにあることを示します。値 3 はパラメーターがリクエストボディにあることを示します。ウィザードモードまたはスクリプトモードで生成された API はクエリ位置のみをサポートします。リクエストメソッドが GET または DELETE である登録によって生成された API は、クエリおよびヘッド位置をサポートします。リクエストメソッドが PUT または POST である登録によって生成された API は、クエリ、ヘッド、およびボディ位置をサポートします。	0
ParameterDescription	string	説明。	description1
DefaultValue	string	デフォルト値。	default1
ParameterOperator	integer	パラメーターの値に使用される演算子。有効値：0、1、2、3。値 0 は等しい演算子を示します。値 1 はあいまい演算子を示します。値 2 は定数演算子を示します。値 3 は In 演算子を示します。ウィザードモードで生成された API は、等しい、あいまい、In 演算子をサポートします。スクリプトモードで生成された API は、等しい演算子をサポートします。登録によって生成された API は、等しいおよび定数演算子をサポートします。	0
ExampleValue	string	サンプル値。	example1
ParameterDataType	integer	パラメーターのデータの型。有効値： 0：文字列 1：整数 2：長整数 3：浮動小数点数 4：倍精度浮動小数点数 5：ブール値 6：文字列リスト 7：整数リスト 8：長整数リスト 9：浮動小数点数リスト 10：倍精度浮動小数点数リスト 11：ブール値リスト	0
IsRequiredParameter	boolean	リクエストパラメーターが必須かどうかを示します。	true
WizardResponseParameters	array<object>	ウィザードモードで生成された API のレスポンスパラメーター。
	object
ParameterDescription	string	説明。	description2
ParameterName	string	パラメーターの名前。	param2
ExampleValue	string	サンプル値。	example2
ParameterDataType	integer	パラメーターのデータの型。有効値： 0：文字列 1：整数 2：長整数 3：浮動小数点数 4：倍精度浮動小数点数 5：ブール値 6：文字列リスト 7：整数リスト 8：長整数リスト 9：浮動小数点数リスト 10：倍精度浮動小数点数リスト 11：ブール値リスト	0
WizardConnection	object	ウィザードモードで生成された API のデータソース情報。
TableName	string	データソース内のテーブルの名前。	t
ConnectionId	integer	データソースの ID。	12354
SqlMode	integer	SQL モード。0：基本 SQL、1：高度な SQL。	0

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": 1,
        "ApiId": 10002,
        "ApiMode": 0,
        "ProjectId": 10000,
        "ResponseContentType": 0,
        "CreatorId": "1234567",
        "VisibleRange": 0,
        "ModifiedTime": "2020-06-23T00:21:01+0800",
        "OperatorId": "2345678",
        "GroupId": "ab123",
        "Description": "Test API description",
        "RequestMethod": 0,
        "CreatedTime": "2020-06-23T00:21:01+0800",
        "ApiName": "My API name",
        "TenantId": 10001,
        "ApiPath": "/test/1",
        "Protocols": [
          0
        ],
        "RegistrationDetails": {
          "ServiceHost": "http://www.abc.com",
          "ServiceContentType": 0,
          "ServicePath": "/index",
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "ServiceRequestBodyDescription": "{\"abc\":1}",
          "RegistrationErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "RegistrationRequestParameters": [
            {
              "ParameterName": "name1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ExampleValue": "example1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ]
        },
        "ScriptDetails": {
          "IsPagedResponse": true,
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "Script": "select a from t",
          "ScriptErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "ScriptRequestParameters": [
            {
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ExampleValue": "example1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ],
          "ScriptResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ParameterName": "param2",
              "ExampleValue": "example2",
              "ParameterDataType": 0
            }
          ],
          "ScriptConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        },
        "WizardDetails": {
          "IsPagedResponse": true,
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "WizardErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "WizardRequestParameters": [
            {
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ExampleValue": "example1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ],
          "WizardResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ParameterName": "param2",
              "ExampleValue": "example2",
              "ParameterDataType": 0
            }
          ],
          "WizardConnection": {
            "TableName": "t",
            "ConnectionId": 12354
          }
        },
        "SqlMode": 0
      }
    ]
  }
}

エラーコード

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.

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

変更履歴

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