DataService Studio で開発状態の API の情報を更新します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| TenantId |
integer |
任意 |
テナント ID。テナント ID を取得するには、以下の手順を実行します：まず、DataWorks コンソール にログインします。次に、ご利用のワークスペースを見つけ、DataStudio ページに移動します。DataStudio ページの右上隅にあるログインユーザー名をクリックし、メニューから「ユーザー情報」を選択します。 |
10001 |
| ProjectId |
integer |
必須 |
ワークスペースの ID。 |
10001 |
| ApiId |
integer |
必須 |
API の ID。 |
10000 |
| RequestMethod |
integer |
必須 |
API のリクエストメソッド。有効な値は 0、1、2、3 です。値 0 は GET メソッドを示します。値 1 は POST メソッドを示します。値 2 は PUT メソッドを示します。値 3 は DELETE メソッドを示します。ウィザードモードまたはスクリプトモードで生成された API は、GET および POST メソッドをサポートします。登録によって生成された API は、GET、POST、PUT、DELETE の各メソッドをサポートします。 |
0 |
| ResponseContentType |
integer |
必須 |
API リクエストの応答が返されるフォーマット。有効な値は 0 および 1 です。値 0 は JSON フォーマットを示します。値 1 は XML フォーマットを示します。ウィザードモードまたはスクリプトモードで生成された API は、JSON フォーマットをサポートします。登録によって生成された API は、JSON および XML の各フォーマットをサポートします。 |
0 |
| Timeout |
integer |
必須 |
API リクエストのタイムアウト期間。単位：ミリ秒。有効な値は (0, 30000] です。 |
10000 |
| VisibleRange |
integer |
必須 |
API の可視範囲。有効な値は 0 および 1 です。値 0 は、API がワークスペース内でのみ可視であることを示します。値 1 は、API が所有者のみに可視であることを示します。 |
0 |
| Protocols |
string |
必須 |
API で使用されるプロトコル。有効な値は 0 および 1 です。値 0 は HTTP を示します。値 1 は HTTPS を示します。複数のプロトコルを指定できます。複数のプロトコルはカンマ (,) で区切ります。 |
0,1 |
| WizardDetails |
string |
任意 |
ウィザードモードで生成された API の詳細。詳細については、「GetDataServiceApi」操作で返される WizardDetails パラメーターをご参照ください。 |
{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]} |
| ScriptDetails |
string |
任意 |
スクリプトモードで生成された API の詳細。詳細については、「GetDataServiceApi」操作で返される ScriptDetails パラメーターをご参照ください。 |
{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]} |
| RegistrationDetails |
string |
任意 |
登録によって生成された API の詳細。詳細については、「GetDataServiceApi」操作で返される RegistrationDetails パラメーターをご参照ください。 |
{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"} |
| ApiPath |
string |
必須 |
API のパス。 |
/test/2 |
| ApiDescription |
string |
必須 |
API の説明。 |
API description |
| ResourceGroupId |
integer |
任意 |
専用リソースグループの ID。 |
3242432423 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP ステータスコード。 |
200 |
| Data |
boolean |
API の情報が更新されたかどうかを示します。 |
true |
| ErrorMessage |
string |
エラーメッセージ。 |
The connection does not exist. |
| RequestId |
string |
リクエスト ID。 |
0000-ABCD-EFG**** |
| ErrorCode |
string |
エラーコード。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
例
成功レスポンス
JSONJSON
{
"HttpStatusCode": 200,
"Data": true,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-EFG****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true
}エラーコード
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。