# 查询自定义词库状态 - ShowIkThesaurus #### 功能介绍 云搜索服务Elasticsearch/OpenSearch集群的词库用于对文本进行分词，使得一些特殊词语在分词的时候能够被识别出来，便于根据关键词搜索文本数据。例如，根据网络流行词来查询，如"喜大普奔"。也支持基于同义词词库，根据同义词搜索文本数据。CSS服务使用的分词器包括IK分词器和同义词分词器。IK分词器配备主库和停词词库；同义词分词器配备同义词词库。其中，IK分词器包含ik_max_word和ik_smart分词策略。同义词分词器使用的是ik_synonym分词策略。该接口用于查询自定义词库的加载状态。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-css/css_03_0077.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-css/css_03_0096.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | css:IKThesaurus:get | Read | cluster \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurus 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-css/css_03_0071.html)。 **约束限制**： 不涉及 **取值范围**： 账户的项目ID，长度为32个字符，由小写字母和数字组成。 **默认取值**： 不涉及 | | cluster_id | 是 | String | **参数解释**： 指定需查询词库状态的集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-css/css_03_0101.html)。 **约束限制**： 不涉及 **取值范围**： UUID格式，36个字符。 **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 自定义词库加载状态。 **取值范围**： - Init：正在初始化。 - Loaded：加载成功。 - Loading：正在加载中。 - Failed：加载失败。 - NeedReboot：示需要重启集群。 - Undefined：未定义。 | | bucket | String | **参数解释**： 最近一次更新存放词库文件的OBS桶。 **取值范围**： 不涉及 | | mainObj | String | **参数解释**： 主词词库文件对象。 **取值范围**： 不涉及 | | stopObj | String | **参数解释**： 停词词库文件对象。 **取值范围**： 不涉及 | | synonymObj | String | **参数解释**： 同义词词库文件对象。 **取值范围**： 不涉及 | | staticMainObj | String | **参数解释**： 静态主词词库文件对象。 **取值范围**： 不涉及 | | staticStopObj | String | **参数解释**： 静态停词词库文件对象。 **取值范围**： 不涉及 | | extraMainObj | String | **参数解释**： Extra主词词库文件对象。 **取值范围**： 不涉及 | | extraStopObj | String | **参数解释**： Extra停词词库文件对象。 **取值范围**： 不涉及 | | updateTime | Integer | **参数解释**： 词库最近更新时间，用Unix时间戳格式，单位：毫秒。 **取值范围**： 不涉及 | | updateDetails | String | **参数解释**： 词库更新详情。 **取值范围**： 不涉及 | | clusterId | String | **参数解释**： 指定配置自定义词库的集群ID。 **取值范围**： 不涉及 | | id | String | **参数解释**： 词库的ID。 **取值范围**： 不涉及 | #### 请求示例 查询自定义词库的加载状态。 ``` GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/thesaurus ``` #### 响应示例 **状态码：200** ``` { "status" : "Loaded", "id" : "e766bd5a-79b0-4d1a-8402-fdeb017a36d1", "bucket" : "test-bucket", "mainObj" : "word/main.txt", "stopObj" : "word/stop.txt", "synonymObj" : "word/synonym.txt", "staticMainObj" : "Unused", "staticStopObj" : "Unused", "extraMainObj" : "Unused", "extraStopObj" : "Unused", "updateTime" : 1521184757000, "updateDetails" : "allinstancesareloadedsuccessfully.", "clusterId" : "ea244205-d641-45d9-9dcb-ab2236bcd07e" } ``` #### 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.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class ShowIkThesaurusSolution { 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); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("")) .build(); ShowIkThesaurusRequest request = new ShowIkThesaurusRequest(); request.withClusterId("{cluster_id}"); try { ShowIkThesaurusResponse response = client.showIkThesaurus(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 huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.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 = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("")) \ .build() try: request = ShowIkThesaurusRequest() request.cluster_id = "{cluster_id}" response = client.show_ik_thesaurus(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" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/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 := css.CssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := css.NewCssClient(hcClient) request := &model.ShowIkThesaurusRequest{} request.ClusterId = "{cluster_id}" response, err := client.ShowIkThesaurus(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CSS/sdk?api=ShowIkThesaurus&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 500 | 表明服务端能被请求访问到，但是不能理解用户的请求。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-css/css_03_0076.html)。