# 全局搜索 - ShowFactoryFullText #### 功能介绍 全局搜索 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/factory/search 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 否 | String | 搜索空间范围: 默认不传参，在全部空间内搜索。 - 当前工作空间ID: 当前工作空间的ID | | search_text | 是 | String | 全局搜索关键字，请输入至少两位字符。 | | job_type | 否 | String | 作业类型: （多选）样例: job_type=BATCH 默认为全部。 - BATCH: 批作业 - REAL_TIME: 流作业 | | script_type | 否 | String | 脚本类型: （多选）样例: script_type=HIVE,DLI。 默认为全部，不过滤任何类型脚本。 - HIVE: Hive SQL - DLI: DLI SQL - DWS: DWS SQL - SparkSQL: Spark SQL - SparkPython: Spark Python - FlinkSQL: Flink SQL - RDS: RDS SQL - PRESTO: Presto SQL - HETUENGINE: HeruEngine - ClickHouse: ClickHouse - IMPALA: Impala SQL - SHELL: Shell - PYTHON: Python | | node_type | 否 | String | 节点类型: （多选）节点类型列表。样例: node_type=com.cloud.datacraft.processactivity.ExecuteHiveJob 默认为全部。 - com.cloud.datacraft.processactivity.ExecuteHiveJob: MRS Hive SQL - com.cloud.datacraft.activity.ExecuteSparkSQL: MRS Spark SQL - com.cloud.datacraft.activity.MRSSparkPython: MRS Spark Python - com.cloud.datacraft.processactivity.ExecuteImpalaJob: MRS Impala SQL - com.cloud.datacraft.activity.DLISQL: DLI SQL - com.cloud.datacraft.activity.DliFlinkJob: DLI Flink Job - com.cloud.datacraft.processactivity.ExecuteDWSJob: DWS SQL - com.cloud.datacraft.activity.ExecuteQuery: RDS SQL - com.cloud.datacraft.activity.MRSPrestoSQL: MRS Presto SQL - com.cloud.datacraft.processactivity.ExecuteScript: Shell - com.cloud.datacraft.processactivity.ExecutePythonScript: Python - com.cloud.datacraft.processactivity.ExecuteClickHouseJob: ClickHouse - com.cloud.datacraft.processactivity.ExecuteHetuEngineJob: HetuEngine - com.cloud.datacraft.activity.DataMigration: DataMigration | | new_save_or_commit | 否 | String | 最新修改: 样例: new_save_or_commit=save 默认为save: 最新保存 - save: 最新保存 - commit: 最新提交 | | owners | 否 | String | 责任人名称: （多选）人员列表或我的节点。样例: owners=dayu_wm 默认不过滤责任人。 | | doc_types | 否 | String | 搜索范围: （多选）样例: doc_types=script 默认为全部。 - node: 开发作业 - script: 脚本 | | begin_time | 否 | Long | 开始时间，配合结束时间参数使用，默认没有时间范围。样例: begin_time=1746633600000 | | end_time | 否 | Long | 结束时间，配合开始时间参数使用，默认没有时间范围。样例: endTime=1746806399999 | | limit | 否 | Integer | 分页返回结果，指定每页最大记录数，范围\[1,100\]。样例: limit=10 默认值: 10。 | | offset | 否 | Integer | 分页的起始页，取值范围大于等于0。样例: offset=0 默认值: 0。 | | if_query_parameters | 否 | String | 是否搜索配置参数部分的内容: 样例: if_query_parameters=false 默认为false: 不搜索配置参数部分的内容 - true: 是 - false: 否 | | match_type | 否 | Integer | 匹配方式: 样例: match_type=0 默认为0: 通用。 - 0: 通用 - 1: 模糊 | | schedule_state | 否 | String | 调度状态: 仅支持作业查找场景，需配置new_save_or_commit参数为commit 默认为全部。 - running: 已调度 - stop: 未调度 | | is_exact | 否 | String | 是否精确搜索: 开启后配合exact_field参数使用。 默认为false: 非精确搜索 - true: 精确搜索 - false: 非精确搜索 | | exact_field | 否 | String | 精确查询的字段, 开启精确搜索时生效: - jobName: 作业名 - scriptName: 脚本名 - jobId: 作业ID - scriptId: 脚本ID | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Auth-Token | 否 | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值），使用Token认证时必选，最小长度：0，最大长度：4096。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | limit | Integer | 分页大小限制。 取值范围\[1,100\]。 | | offset | Integer | 当前所在分页。 | | search_details | Array of [SearchDetailV2] objects | 查询成功，返回搜索结果。 | | total_hits | Long | 成功命中数量。 | 表5SearchDetailV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 唯一标识符 | | tenant_id | String | 租户ID | | project_id | String | 项目ID | | dgc_instance_id | String | DGC实例ID | | workspace | String | 工作空间ID | | doc_type | String | 搜索范围: （多选） 默认为全部。 - node: 开发作业 - script: 脚本 | | owner | String | 负责人 | | new_save_or_commit | String | 最新修改: 默认为save: 最新保存 - save: 最新保存 - commit: 最新提交 | | version | Integer | 数字版本号或草稿标识 | | last_modified_time | Long | 最后修改时间 | | job_name | String | 作业名称 | | job_type | String | 作业类型: （多选）样例: job_type=BATCH 默认为全部。 - BATCH: 批作业 - REAL_TIME: 流作业 | | job_params | String | 作业参数 | | node_name | String | 节点名称 | | node_type | String | 节点类型: （多选）节点类型列表。 默认为全部。 - com.cloud.datacraft.processactivity.ExecuteHiveJob: MRS Hive SQL - com.cloud.datacraft.activity.ExecuteSparkSQL: MRS Spark SQL - com.cloud.datacraft.activity.MRSSparkPython: MRS Spark Python - com.cloud.datacraft.processactivity.ExecuteImpalaJob: MRS Impala SQL - com.cloud.datacraft.activity.DLISQL: DLI SQL - com.cloud.datacraft.activity.DliFlinkJob: DLI Flink Job - com.cloud.datacraft.processactivity.ExecuteDWSJob: DWS SQL - com.cloud.datacraft.activity.ExecuteQuery: RDS SQL - com.cloud.datacraft.activity.MRSPrestoSQL: MRS Presto SQL - com.cloud.datacraft.processactivity.ExecuteScript: Shell - com.cloud.datacraft.processactivity.ExecutePythonScript: Python - com.cloud.datacraft.processactivity.ExecuteClickHouseJob: ClickHouse - com.cloud.datacraft.processactivity.ExecuteHetuEngineJob: HetuEngine - com.cloud.datacraft.activity.DataMigration: DataMigration | | script_name | String | 脚本名称 | | script_type | String | 脚本类型: （多选）样例: script_type=HIVE,DLI。 默认为全部，不过滤任何类型脚本。 - HIVE: Hive SQL - DLI: DLI SQL - DWS: DWS SQL - SparkSQL: Spark SQL - Spark Python: Spark Python - FlinkSQL: Flink SQL - RDS: RDS SQL - PRESTO: Presto SQL - HETUENGINE: HeruEngine - ClickHouse: ClickHouse - IMPALA: Impala SQL - SHELL: Shell - PYTHON: Python | | script_params | String | 脚本参数 | | cdm_cluster_name | String | CDM集群名称 | | cdm_job_name | String | CDM作业名称 | | cdm_params | String | CDM参数 | | workspace_name | String | 工作空间名称 | | job_id | String | 作业ID | | script_id | String | 脚本ID | | single_node_job_type | String | 单节点作业类型： - DliSQL - DwsSQL - HiveSQL - SparkSQL - RdsSQL - DorisSQL - DataMigration - MrsFlink.FlinkSQL - FlinkJar - DLISpark - FabricSql | | schedule_state | String | 调度状态: 默认为全部。 - running: 已调度 - stop: 未调度 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 全局搜索关键字"select"，当前分页为第1页，单页最大数量限制为10。 ``` GET /v2/62099355b894428e8916573ae635f1f9/search?search_text=select&offset=0&limit=10 ``` #### 响应示例 **状态码：200** 查询成功，返回搜索结果 ``` { "limit" : 10, "offset" : 0, "search_details" : [ { "dgc_instance_id" : "9e763f354c6e46e1a87e2f63fc471d85", "doc_type" : "node", "id" : "ClvD7ZQBjnPSvBMriixA", "job_id" : "549", "job_name" : "job_9944", "job_type" : "BATCH", "last_modified_time" : 1739155370115, "new_save_or_commit" : "save", "node_name" : "DLI_SQL_4403", "node_type" : "com.cloud.datacraft.activity.DLISQL", "owner" : "ei_dlf_l00341563", "project_id" : "62099355b894428e8916573ae635f1f9", "tenant_id" : "61c2cde19d9c47cfb2123d4c8ec0d1e8", "version" : 0, "workspace" : "1390a9d8c7154126ad662be0f2ebe2e0", "workspace_name" : "testRDS" } ], "total_hits" : 1 } ``` **状态码：400** 查询失败，返回错误信息。 ``` { "error_code" : "DLF.3051", "error_msg" : "The request parameter is invalid." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowFactoryFullTextSolution { 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("")) .build(); ShowFactoryFullTextRequest request = new ShowFactoryFullTextRequest(); try { ShowFactoryFullTextResponse response = client.showFactoryFullText(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowFactoryFullTextRequest() response = client.show_factory_full_text(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ShowFactoryFullTextRequest{} response, err := client.ShowFactoryFullText(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ShowFactoryFullText)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功，返回搜索结果 | | 400 | 查询失败，返回错误信息。 |