String
JSON character string for information about related columns.
+JSON string for information about related columns.
statement
@@ -308,7 +308,7 @@ -Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Boolean
Whether to export column names when exporting CSV and JSON data.
-- If this parameter is set to true, the column names are exported.
- If this parameter is set to false, the column names are not exported.
- If this parameter is left blank, the default value false is used.
- If this parameter is set to true, the column names are exported.
- If this parameter is set to false, the column names are not exported.
- If this parameter is left blank, the default value false is used.
limit_num
@@ -181,7 +181,8 @@ -Example Request
{
+Example Request
Export query results of SQL statements to OBS and stores the results in JSON format.
+{
"data_path": "obs://obs-bucket1/path",
"data_type": "json",
"compress": "gzip",
@@ -224,7 +225,7 @@
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
String
JSON character string of related columns queried by using SQL statements.
+JSON string of related columns queried using SQL statements.
statement
@@ -495,7 +495,7 @@ -Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Example Request
{
+Example Request
Create a test database named db1.
+{
"database_name": "db1",
"description": "this is for test"
}
@@ -187,7 +188,7 @@
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Parameter +
Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code. +Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
diff --git a/docs/dli/api-ref/dli_02_0030.html b/docs/dli/api-ref/dli_02_0030.html
index 3a45942b..45c31979 100644
--- a/docs/dli/api-ref/dli_02_0030.html
+++ b/docs/dli/api-ref/dli_02_0030.html
@@ -37,7 +37,7 @@
|
|---|
Parameter +
Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code. +Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
diff --git a/docs/dli/api-ref/dli_02_0033.html b/docs/dli/api-ref/dli_02_0033.html
index 37921312..23f68716 100644
--- a/docs/dli/api-ref/dli_02_0033.html
+++ b/docs/dli/api-ref/dli_02_0033.html
@@ -341,7 +341,7 @@
|
|---|
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Example Request
- Sample request when data_location is OBS.
{ +Example Request
- Create a table whose data_location is OBS and data format of CSV.
{ "table_name": "tb1", "data_location": "OBS", "description": "", @@ -334,7 +334,7 @@ }-
The values of date_format and timestamp_format must be the same as the time format in the imported CSV file.
- Sample request when data_location is VIEW.
{ + - Create a table whose data_location is VIEW.
{ "table_name": "view1", "data_location": "VIEW", "columns": [ @@ -387,7 +387,7 @@
- Create a table whose data_location is OBS and data format of CSV.
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Parameter +
Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code. +Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
diff --git a/docs/dli/api-ref/dli_02_0037.html b/docs/dli/api-ref/dli_02_0037.html
index 9e3396f7..30c50e5f 100644
--- a/docs/dli/api-ref/dli_02_0037.html
+++ b/docs/dli/api-ref/dli_02_0037.html
@@ -46,7 +46,7 @@
|
-String Name of a queue. +Name of a queue. Example value: queue1. | ||||
|---|---|---|---|---|---|
user_name @@ -55,7 +55,7 @@ |
String |
-Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated. + | Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated. Example value: tenant2. |
||
action @@ -64,7 +64,7 @@ |
String |
-Grants or revokes the permission. The parameter value can be grant, revoke, or update. Users can perform the update operation only when they have been granted with the grant and revoke permissions. + | Grants or revokes the permission. The parameter value can be grant, revoke, or update. Users can perform the update operation only when they have been granted with the grant and revoke permissions. Example value: grant.
|
Array of Strings |
-List of permissions to be granted, revoked, or updated. The following permissions are supported: -
|
Boolean |
-Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed. + | Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true. |
message @@ -110,14 +110,15 @@ |
String |
-System prompt. If execution succeeds, the parameter setting may be left blank. + | System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank. |
Example Request
{
+Example Request
Grant a user the permission to submit jobs on queue1 and delete queue1.
+{
"queue_name": "queue1",
"user_name": "tenant2",
"action": "grant",
@@ -156,7 +157,7 @@
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Parameter +
Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code. +Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
diff --git a/docs/dli/api-ref/dli_02_0039.html b/docs/dli/api-ref/dli_02_0039.html
index 5f6f0710..e8ace9fa 100644
--- a/docs/dli/api-ref/dli_02_0039.html
+++ b/docs/dli/api-ref/dli_02_0039.html
@@ -46,7 +46,7 @@
|
-String Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated. +Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated. Example value: user2. | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
action @@ -55,7 +55,7 @@ |
String |
-Grants or revokes the permission. The parameter value can be grant, revoke, or update. + | Grants or revokes the permission. The parameter value can be grant, revoke, or update. Example value: grant.
NOTE:
@@ -67,7 +67,8 @@
Users can perform the update operation only when they have been granted with the grant and revoke permissions. |
Array of Objects |
-Permission granting information. For details, see Table 3. + | Permission granting information. For details, see Table 3. Example value: +[ {"object": "databases.db1.tables.tb2.columns.column1","privileges": ["SELECT"]},"object": "databases.db1.tables.tbl","privileges": [ "DROP_TABLE"] |
String |
Data objects to be assigned. If they are named: -
|
||||||||||||||||||||
privileges @@ -100,7 +102,7 @@ |
Array of Strings |
-List of permissions to be granted, revoked, or updated. + | List of permissions to be granted, revoked, or updated. Example value: [SELECT]. NOTE:
If Action is Update and the update list is empty, all permissions of the user in the database or table are revoked. |
@@ -126,7 +128,7 @@
Boolean |
-Whether the request is successfully executed. Value true indicates that the request is successfully executed. + | Whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true. |
||||||||||||||||||||||
message @@ -135,14 +137,15 @@ |
String |
-System prompt. If execution succeeds, the parameter setting may be left blank. + | System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank. |
Example Request
{
+Example Request
Grant user2 the permission to query data in the database db1, delete the data table db1.tbl, and query data in a specified column db1.tbl.column1 of a data table.
+{
"user_name": "user2",
"action": "grant",
"privileges": [
@@ -199,7 +202,7 @@
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Boolean
Whether the request is successfully executed. Value true indicates that the request is successfully executed.
+Whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true.
message
@@ -60,7 +60,7 @@String
System prompt. If execution succeeds, the parameter setting may be left blank.
+System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.
database_name
@@ -69,7 +69,7 @@String
Name of the database to be queried.
+Name of the database to be queried. Example value: dsstest.
privileges
@@ -101,7 +101,7 @@Boolean
Whether the database user is an administrator.
+Whether the database user is an administrator. Example value: true.
user_name
@@ -110,7 +110,7 @@String
Name of the user who has permission on the current database.
+Name of the user who has permission on the current database. Example value: test.
privileges
@@ -119,7 +119,7 @@Array of Strings
Permission of the user on the database.
+Permission of the user on the database. Example value: [ALTER_TABLE_ADD_PARTITION].
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+ If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Boolean
Whether the table user is an administrator.
+Determines whether a user is an administrator. The value false indicates that the user is not an administrator, and the value true indicates that the user is an administrator.
object
@@ -158,7 +158,7 @@ } ] } - If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
+ If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
Boolean
Whether the request is successfully executed. Value true indicates that the request is successfully executed.
+Whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true.
message
@@ -84,7 +84,7 @@String
System prompt. If execution succeeds, the parameter setting may be left blank.
+System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.
user_name
@@ -126,7 +126,8 @@String
Objects on which a user has permission.
-- If the object is in the format of databases.Database name.tables.Table name, the user has permission on the database.
- If the object is in the format of databases.Database name.tables.Table namecolumns.Column name, the user has permission on the table.
- If the object is in the format of databases.Database name.tables.Table name, the user has permission on the database.
- If the object is in the format of databases.Database name.tables.Table namecolumns.Column name, the user has permission on the table.
Example value: databases.dsstest.tables.obs_231.
+
privileges
@@ -135,7 +136,7 @@Array of Strings
Permission of the user on a specified object.
+Permission of the user on a specified object. Example value: [DESCRIBE_TABLE].