# 查询指令列表 - ListInstruction #### 功能介绍 该接口用于查询指令列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-metastudio/metastudio_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-metastudio/metastudio_02_0071.html)。 #### URI GET /v1/{project_id}/wise-brain-manager/instruction 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | 否 | Integer | 每页显示的条目数量。 **取值范围：** 1\~100 **默认取值：** 10 | | instruction_library_id | 是 | String | 指令集ID。 | | name | 否 | String | 指令名称 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | | X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息。 | | X-App-UserId | 否 | String | 第三方用户ID。不允许输入中文。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 请求ID。 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | 与第一条数据的偏移量 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | Integer | 页面大小 **取值范围：** 1\~1000 **默认取值：** 10 | | count | Integer | 总数量 **取值范围：** 0\~2147483647 | | data | Array of [InstructionInfo] objects | 指令信息 | 表6InstructionInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instruction_id | String | 指令ID。 | | name | String | 指令名称。 | | description | String | 指令描述。 | | instruction | String | 操作指令。 | | slot_list | Array of [InstructionSlotInfo] objects | 槽位列表 | | reply_words_list | Array of [InstructionReplyWordsInfo] objects | 指令回复话术列表 | | create_time | String | 创建时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | update_time | String | 更新时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | 表7InstructionSlotInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 槽位名称。 | | description | String | 槽位描述。 | | knowledge_library_list | Array of [SlotKnowledgeLibraryInfo] objects | 知识库列表 | 表8SlotKnowledgeLibraryInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | language | String | 智能交互语言 - CN:中文 - EN:英文 | | knowledge_library_id | String | 知识库ID。 | 表9InstructionReplyWordsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | language | String | 智能交互语言 - CN:中文 - EN:英文 | | reply_words | String | 回复话术，多个回复话术间用换行符\\n分隔。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/wise-brain-manager/instruction?instruction_library_id=80ac485c5fa545a79f741df0aacf739a ``` #### 响应示例 **状态码：200** 处理成功返回。 ``` { "offset" : 0, "limit" : 10, "count" : 1, "data" : [ { "instruction_id" : "ea2934bd5354442d80b4df11a52bbfe9", "name" : "看电视", "description" : "IPTV指令，用于播放电视对应频道的节目", "instruction" : "{\"type\":20,\"instruct\":\"CHANNEL\",\"channelName\":\"{channelName}\"}", "slot_list" : [ { "name" : "channelName", "description" : "频道名称", "knowledge_library_list" : [ { "language" : "CN", "knowledge_library_id" : "8a2de18a95ac6b280195ac6b84ad0000" } ] } ], "reply_words_list" : [ { "language" : "CN", "reply_words" : "已为您打开。\\n已操作完成。" } ], "create_time" : "2023-09-01T06:34:21Z", "update_time" : "2023-09-01T06:34:21Z" } ] } ``` **状态码：400** 请求传参异常，包含错误码及对应描述。 ``` { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 处理成功返回。 | | 400 | 请求传参异常，包含错误码及对应描述。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。