GetDataServicePublishedApi を使用した公開 API 詳細のクエリ - DataWorks

DataService Studio の公開状態にある API の情報を照会します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	ワークスペースの ID です。	10002
TenantId	integer	任意	テナント ID です。テナント ID を取得するには、以下の手順を実行します： DataWorks コンソールにログインします。ご利用のワークスペースを見つけ、DataStudio ページに移動します。DataStudio ページの右上隅にあるログインユーザー名をクリックし、メニューから [ユーザー情報] を選択します。	10003
ApiId	integer	必須	API の ID です。	10001

レスポンスフィールド

フィールド	型	説明	例
	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	公開済み API の情報です。
Timeout	integer	API リクエストのタイムアウト期間です。単位：ミリ秒。	10000
Status	integer	API のステータスです。有効な値は 0 および 1 です。値 0 は API が未公開であることを示し、値 1 は API が公開済みであることを示します。	1
ApiId	integer	DataService Studio の API の ID です。	10000
ApiMode	integer	API の種類です。有効な値は 0、1、2 です。値 0 はウィザードモードで生成された API を示し、値 1 はスクリプトモードで生成された API を示し、値 2 は登録によって生成された API を示します。	0
ProjectId	integer	ワークスペースの ID です。	10001
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 が API 作成者のみに表示されることを示します。	0
ModifiedTime	string	API が最後に変更された時刻です。	2020-06-23T00:21:01+0800
OperatorId	string	API を最後に変更したユーザーとして使用された Alibaba Cloud アカウントの ID です。	2345678
GroupId	string	グループの ID です。	ab12**
Description	string	説明文です。	测试API描述
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	作成時刻です。	2020-06-23T00:21:01+0800
ApiName	string	API の名称です。	测试API名称
TenantId	integer	テナントの ID です。	10001
ApiPath	string	API のパスです。	/test/1
Protocols	array	API で使用されるプロトコルです。有効な値は 0 および 1 です。値 0 は HTTP を示し、値 1 は HTTPS を示します。複数のプロトコルはリスト形式で提示されます。
	integer	API で使用されるプロトコルです。有効な値は 0 および 1 です。値 0 は API が HTTP を使用することを示し、値 1 は API が HTTPS を使用することを示します。2 つのプロトコルはリスト形式で提示されます。	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	エラーメッセージです。	The connection does not exist.
ErrorCode	string	エラーコードです。	Invalid.Tenant.ConnectionNotExists
ErrorSolution	string	解決方法です。	retry
RegistrationRequestParameters	array<object>	登録済み API のリクエストパラメーター一覧です。
	object	返された結果です。
ParameterName	string	パラメーターの名称です。	name1
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 は Equal 演算子を示し、値 1 は Like 演算子を示し、値 2 は Const 演算子を示し、値 3 は In 演算子を示します。ウィザードモードで生成された API は Equal、Like、In 演算子をサポートします。スクリプトモードで生成された API は Equal 演算子をサポートします。登録によって生成された API は Equal および Const 演算子をサポートします。	0
ExampleValue	string	サンプル値です。	example1
ParameterDataType	integer	パラメーターのデータの型です。有効な値は以下のとおりです： 0：文字列 1：整数（Int） 2：長整数（Long） 3：浮動小数点数（Float） 4：倍精度浮動小数点数（Double） 5：ブール値（Boolean） 6：文字列リスト（StringList） 7：整数リスト（IntList） 8：長整数リスト（LongList） 9：浮動小数点数リスト（FloatList） 10：倍精度浮動小数点数リスト（DoubleList） 11：ブール値リスト（BooleanList）	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：Equal 1：Like 2：Const 3：In ウィザードモードで生成された API は Equal、Like、In 演算子をサポートします。スクリプトモードで生成された API は Equal 演算子をサポートします。登録によって生成された API は Equal および Const 演算子をサポートします。	0
ExampleValue	string	サンプル値です。	example1
ParameterDataType	integer	パラメーターのデータの型です。有効な値は以下のとおりです： 0：文字列 1：整数（Int） 2：長整数（Long） 3：浮動小数点数（Float） 4：倍精度浮動小数点数（Double） 5：ブール値（Boolean） 6：文字列リスト（StringList） 7：整数リスト（IntList） 8：長整数リスト（LongList） 9：浮動小数点数リスト（FloatList） 10：倍精度浮動小数点数リスト（DoubleList） 11：ブール値リスト（BooleanList）	0
IsRequiredParameter	boolean	パラメーターが必須かどうかを示します。	true
ScriptResponseParameters	array<object>	スクリプトモードで生成された API のレスポンスパラメーターです。
	object	返された結果です。
ParameterDescription	string	説明文です。	description2
ParameterName	string	パラメーターの名称です。	param2
ExampleValue	string	サンプル値です。	example2
ParameterDataType	integer	パラメーターのデータの型です。有効な値は以下のとおりです： 0：文字列 1：整数（Int） 2：長整数（Long） 3：浮動小数点数（Float） 4：倍精度浮動小数点数（Double） 5：ブール値（Boolean） 6：文字列リスト（StringList） 7：整数リスト（IntList） 8：長整数リスト（LongList） 9：浮動小数点数リスト（FloatList） 10：倍精度浮動小数点数リスト（DoubleList） 11：ブール値リスト（BooleanList）	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 は Equal 演算子を示し、値 1 は Like 演算子を示し、値 2 は Const 演算子を示し、値 3 は In 演算子を示します。ウィザードモードで生成された API は Equal、Like、In 演算子をサポートします。スクリプトモードで生成された API は Equal 演算子をサポートします。登録によって生成された API は Equal および Const 演算子をサポートします。	0
ExampleValue	string	サンプル値です。	example1
ParameterDataType	integer	パラメーターのデータの型です。有効な値は以下のとおりです： 0：文字列 1：整数（Int） 2：長整数（Long） 3：浮動小数点数（Float） 4：倍精度浮動小数点数（Double） 5：ブール値（Boolean） 6：文字列リスト（StringList） 7：整数リスト（IntList） 8：長整数リスト（LongList） 9：浮動小数点数リスト（FloatList） 10：倍精度浮動小数点数リスト（DoubleList） 11：ブール値リスト（BooleanList）	0
IsRequiredParameter	boolean	パラメーターが必須かどうかを示します。	true
WizardResponseParameters	array<object>	ウィザードモードで生成された API のレスポンスパラメーターです。
	object	返された結果です。
ParameterDescription	string	説明文です。	description2
ParameterName	string	パラメーターの名称です。	param2
ExampleValue	string	サンプル値です。	example2
ParameterDataType	integer	パラメーターのデータの型です。有効な値は以下のとおりです： 0：文字列 1：整数（Int） 2：長整数（Long） 3：浮動小数点数（Float） 4：倍精度浮動小数点数（Double） 5：ブール値（Boolean） 6：文字列リスト（StringList） 7：整数リスト（IntList） 8：長整数リスト（LongList） 9：浮動小数点数リスト（FloatList） 10：倍精度浮動小数点数リスト（DoubleList） 11：ブール値リスト（BooleanList）	0
WizardConnection	object	ウィザードモードで生成された API のデータソース情報です。
TableName	string	データソース内のテーブル名です。	t
ConnectionId	integer	データソースの ID です。	123
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": {
    "Timeout": 10000,
    "Status": 1,
    "ApiId": 10000,
    "ApiMode": 0,
    "ProjectId": 10001,
    "ResponseContentType": 0,
    "CreatorId": "1234567",
    "VisibleRange": 0,
    "ModifiedTime": "2020-06-23T00:21:01+0800",
    "OperatorId": "2345678",
    "GroupId": "ab12**",
    "Description": "测试API描述",
    "RequestMethod": 0,
    "CreatedTime": "2020-06-23T00:21:01+0800",
    "ApiName": "测试API名称",
    "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": "The connection does not exist.",
          "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
          "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": 123
      }
    },
    "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.

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

変更履歴

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