Publishes an API in DataService Studio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes PublishDataServiceApi

The operation that you want to perform.

ApiId Long Yes 10000

The ID of the API to query.

ProjectId Long Yes 10001

The ID of the DataWorks workspace.

RegionId String Yes cn-shanghai

The ID of the region where your project resides.

TenantId Long Yes 10002

The ID of the tenant.

Response parameters

Parameter Type Example Description
Data Boolean true

Indicates whether the publishing is successful.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.

ErrorMessage String The connection does not exist.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

The unique ID of the request.

Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=PublishDataServiceApi &ApiId=10000 &ProjectId=10001 &RegionId=cn-shanghai &TenantId=10002 &<common request parameters> 
   

Sample success responses

XML format


     <RequestId>0000-ABCD-EFG****</RequestId> <HttpStatusCode>200</HttpStatusCode> <Data>true</Data> <Success>true</Success> 
   

JSON Hint


     { "RequestId": "0000-ABCD-EFG****", "HttpStatusCode": 200, "Data": true, "Success": true } 
   

Error code

Go to the Error CenterFor more information, see error codes.