Querying the Script List
Function
This API is used to query the script list.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v2/{project_id}/factory/scripts
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Project ID and Account ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Integer |
The maximum number of records on each page. The value ranges from 1 to 100. The default value is 10. |
|
offset |
No |
Integer |
Start page of the paging list. The default value is 0. The value must be greater than or equal to 0. |
|
script_name |
No |
String |
Script name |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
|
X-Auth-Token |
No |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory when token authentication is used. The value contains 0 to 4096 characters. |
|
X-Project-Id |
No |
String |
project_id: project ID. For details about how to obtain the project ID and account ID, see Project ID and Account ID. This field is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
The total number of scripts. |
|
scripts |
Array of ScriptInfo objects |
Script List |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Script name. The name contains a maximum of 128 characters, including only letters, numbers, hyphens (-), and periods (.). The script name must be unique. |
|
type |
String |
Script Type
|
|
directory |
String |
Path of the script Log in to the DataArts Studio management console and choose Data Development > Develop Script from the navigation pane. In the directory tree of the script, you can view the created directories. The default directory is the root directory. |
|
id |
String |
Script ID. |
|
create_user |
String |
Script creator |
|
connection_name |
String |
Name of the connection associated with the script. This parameter is mandatory when type is set to DLISQL, (tag:nohcs)SparkSQL, HiveSQL, DWSSQL, Shell, PRESTO, ClickHouseSQL, ImpalaSQL, HetuEngineSQL, or RDSSQL. You can obtain existing connections in the system by calling the API for querying the connection list (to be brought offline). It is left blank by default. |
|
database |
String |
Database associated with an SQL statement. This parameter is available only when type is set to DLISQL, (tag:nohcs)SparkSQL, HiveSQL, DWSSQL, PRESTO, ClickHouseSQL, ImpalaSQL, HetuEngineSQL, or RDSSQL.
|
|
queue_name |
String |
DLI resource queue name. This parameter is available only when type is set to DLISQL. You can obtain the queue information by calling the API for querying the queue list. It is left blank by default. |
|
configuration |
Object |
User-defined configuration parameters applicable to the job. This parameter is available when type is set to DLISQL. For details about the supported configuration items, see the conf parameter description of DLI. It is left blank by default. |
|
description |
String |
Description of the connection. The description contains a maximum of 255 characters. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
Query a script list.
GET /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/scripts
Example Responses
Status code: 200
The query is successful, and the script list is returned.
{
"total" : 2,
"scripts" : [ {
"connection_name" : "hive_test",
"id" : "ff8080819627db89019627ee57cb0007;",
"create_user" : "test_user",
"database" : "default",
"description" : "",
"directory" : "/",
"name" : "hive_test_sql",
"type" : "HiveSQL"
}, {
"connection_name" : "hots_test_xie",
"id" : "ff8080819627db89019647ee57cb0007;",
"create_user" : "test_user",
"description" : "",
"directory" : "/",
"name" : "test_shell",
"type" : "Shell"
} ]
}
Status code: 400
If the query fails, an error message is returned.
{
"error_code" : "DLF.3051",
"error_msg" : "The request parameter is invalid."
}
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListFactoryScriptsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListFactoryScriptsRequest request = new ListFactoryScriptsRequest(); try { ListFactoryScriptsResponse response = client.listFactoryScripts(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFactoryScriptsRequest() response = client.list_factory_scripts(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFactoryScriptsRequest{} response, err := client.ListFactoryScripts(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The query is successful, and the script list is returned. |
|
400 |
If the query fails, an error message is returned. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot