GetDataServiceApi を使用した DataService Studio API 詳細のクエリ - DataWorks

DataService Studio API の開発状態における詳細情報を照会します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TenantId	integer	任意	テナント ID です。	10002
ProjectId	integer	必須	ワークスペースの ID です。	10001
ApiId	integer	必須	DataService Studio API の ID です。	10000

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
HttpStatusCode	integer	返された HTTP ステータスコードです。	200
RequestId	string	リクエストの ID です。	0000-ABCD-EFG****
ErrorMessage	string	返されたエラーメッセージです。	The specified parameters are invalid.
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrorCode	string	返されたエラーコードです。	1031203110005
Data	object	返されたデータです。
Timeout	integer	API リクエストのタイムアウト期間です。単位はミリ秒です。	10000
Status	integer	API のステータスです。有効な値は 0 および 1 です。0 は API が未公開であることを示し、1 は API が公開済みであることを示します。	0
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 の作成者のみに表示されることを示します。	0
ModifiedTime	string	API が最後に変更された時刻です。	2020-06-23T00:21:01+0800
OperatorId	string	API を最後に変更したユーザーとして使用された Alibaba Cloud アカウントの ID です。	2345678
GroupId	string	グループの ID です。	ab123****
Description	string	説明文です。	Description of the test API
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	作成時刻です。	2020-06-23T00:21:01+0800
ApiName	string	API の名前です。	Name of the test API
TenantId	integer	テナントの ID です。	10002
ApiPath	string	API のパスです。	/test/1
Protocols	array	フィールドの一覧です。
	integer	API で使用されるプロトコルです。有効な値は 0 および 1 です。0 は HTTP を示し、1 は HTTPS を示します。プロトコルはリスト形式で表示されます。	0
RegistrationDetails	object	登録によって生成された API の詳細情報です。このパラメーターは、登録によって生成された API の場合のみ返されます。
ServiceHost	string	バックエンドサービスのアドレスです。	http://example.aliyundoc.com
ServiceContentType	integer	API リクエストの応答が返されるフォーマットです。有効な値は以下のとおりです。 0：JSON 形式を示します。 1：XML 形式を示します。ウィザードモードまたはスクリプトモードで生成された API は JSON 形式のみをサポートします。登録によって生成された API は JSON 形式および XML 形式をサポートします。	0
ServicePath	string	バックエンドサービスのパスです。	/index
SuccessfulResultSample	string	成功時の応答のサンプルです。	{"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：パラメーターがリクエスト 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
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、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
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 はクエリおよびヘッダー位置をサポートします。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
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 specified parameters are invalid.",
  "Success": true,
  "ErrorCode": "1031203110005",
  "Data": {
    "Timeout": 10000,
    "Status": 0,
    "ApiId": 10000,
    "ApiMode": 0,
    "ProjectId": 10001,
    "ResponseContentType": 0,
    "CreatorId": "1234567",
    "VisibleRange": 0,
    "ModifiedTime": "2020-06-23T00:21:01+0800",
    "OperatorId": "2345678",
    "GroupId": "ab123****",
    "Description": "测试API描述",
    "FolderId": 0,
    "RequestMethod": 0,
    "CreatedTime": "2020-06-23T00:21:01+0800",
    "ApiName": "测试API名称",
    "TenantId": 10002,
    "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.

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

変更履歴

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