All Products
Search
Document Center

DataWorks:SubmitDataServiceApi

Last Updated:Nov 21, 2024

Submits an API in DataService Studio.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TenantIdlongNo

The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataService Studio page. On the DataService Studio page, click the logon username in the upper-right corner and click User Info in the Menu section.

10001
ProjectIdlongYes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.

10000
ApiIdlongYes

The API ID. You can call the ListDataServiceApis operation to obtain the ID.

12345

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

0000-ABCD-EFG****
HttpStatusCodeinteger

The HTTP status code.

200
Databoolean

Indicates whether the API was submitted.

true
ErrorCodestring

The error code.

Invalid.Tenant.ConnectionNotExists
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "0000-ABCD-EFG****",
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-23The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-10-09The internal configuration of the API is changed, but the call is not affectedView Change Details