# 查询角色列表 - ListRole #### 功能介绍 该接口用于查询角色列表。 #### 调用方法 请参见[如何调用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/role 表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 | | 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 [RoleInfo] objects | 角色信息 | 表6RoleInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | role_id | String | 角色ID。 | | name | String | 角色名称。 | | description | String | 角色描述。 | | role_business_list | Array of [RoleBusinessInfo] objects | 角色业务配置列表。 | | llm_source | String | 使用的大语言模型来源 - LLM_CONFIG：大语言模型配置 - DEEP_SEEK：内置的DEEPSEEK | | llm_config_id | String | 大语言模型配置ID。 | | plugin_config_list | Array of [RolePluginConfigInfo] objects | 插件配置列表 | | instruction_library_id | String | 指令集ID。 | | create_time | String | 创建时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | update_time | String | 更新时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | 表7RoleBusinessInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | role_business_id | String | 角色业务配置ID。 | | role_id | String | 角色ID。 | | language | String | 角色语言 - CN:中文 - EN:英文 | | prompt | String | 提示词。 | | knowledge_library_list | Array of [RoleKnowledgeLibraryInfo] objects | 知识库列表 | | create_time | String | 创建时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | update_time | String | 更新时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | 表8RoleKnowledgeLibraryInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | knowledge_type | String | 知识库类型 - QUESTION_ANSWER：问答 - DOCUMENT：文档 | | knowledge_library_info_list | Array of [KnowledgeLibraryBaseInfo] objects | 知识库列表 | 表9KnowledgeLibraryBaseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | knowledge_library_id | String | 知识库ID。 | | name | String | 知识库名称。 | 表10RolePluginConfigInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | plugin_type | String | 插件类型 - WEATHER_QUERY：天气查询 - WEB_SEARCH：网络搜索 | | plugin_source | String | 使用的插件来源 - PLUGIN_CONFIG：插件配置 - DEFAULT：默认 | | plugin_config_id | String | 插件配置ID。 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/wise-brain-manager/role ``` #### 响应示例 **状态码：200** 处理成功返回。 ``` { "offset" : 0, "limit" : 10, "count" : 1, "data" : [ { "role_id" : "b3e2b1db10b34f45bff241b133142627", "name" : "展厅接待", "description" : "我是展厅接待", "role_business_list" : [ { "language" : "CN", "prompt" : "请扮演一名展厅接待", "knowledge_library_list" : [ { "knowledge_type" : "QUESTION_ANSWER", "knowledge_library_info_list" : [ { "knowledge_library_id" : "2c9f0081938721d801938723cd2d0001", "name" : "问答库" } ] } ] } ], "llm_source" : "LLM_CONFIG", "llm_config_id" : "87f7c101f727403fb018987603a3802b", "plugin_config_list" : [ { "plugin_type" : "WEATHER_QUERY", "plugin_source" : "PLUGIN_CONFIG", "plugin_config_id" : "87f7c101f727403fb018987603a3802b" } ], "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)。