Updates a created SQL query script.
Try it now
Test
RAM authorization
Request syntax
PATCH /api/v2/namespaces/{namespace}/sql-file/{sqlFileId} HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| namespace |
string |
No |
The namespace name. |
default-namespace |
| sqlFileId |
string |
No |
The unique ID of the SQL script to delete. |
sql-f-abc123xyz |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspace |
string |
No |
The workspace ID. |
a14bd5d90a**** |
| body | SqlFile |
No |
The SQL script information to update. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| requestId |
string |
The request ID. |
CBC799F0-ABCD-1D30-8A4F-882ED4DD**** |
| success |
boolean |
Indicates whether the business request was successful. |
true |
| httpCode |
integer |
The business status code, which is uniformly 200. Use success to determine whether the request was successful. |
200 |
| errorCode |
string |
The business error code. This value is not empty when success is false. This value is empty when success is true. |
"" |
| errorMessage |
string |
The business error message. This value is not empty when success is false. This value is empty when success is true. |
"" |
| data | SqlFile |
The complete SQL script information returned upon success. This value is valid when success is true. |
123 |
Examples
Success response
JSON format
{
"requestId": "CBC799F0-ABCD-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\"",
"data": {
"name": "",
"sqlFileId": "",
"parentId": "",
"description": "",
"sessionClusterName": "",
"sqlScript": "",
"workspace": "",
"namespace": "",
"batchMode": ""
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.