更新时间:2025-11-10 GMT+08:00
分享

查询角色列表 - ListRole

功能介绍

该接口用于查询角色列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/{project_id}/wise-brain-manager/role

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

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

角色信息

表6 RoleInfo

参数

参数类型

描述

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

插件配置列表

mcp_server_info_list

Array of McpServerBaseInfo objects

MCP服务端对接配置信息列表

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"。

表7 RoleBusinessInfo

参数

参数类型

描述

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"。

表8 RoleKnowledgeLibraryInfo

参数

参数类型

描述

knowledge_type

String

知识库类型

  • QUESTION_ANSWER:问答

  • DOCUMENT:文档

knowledge_library_info_list

Array of KnowledgeLibraryBaseInfo objects

知识库列表

表9 KnowledgeLibraryBaseInfo

参数

参数类型

描述

knowledge_library_id

String

知识库ID。

name

String

知识库名称。

表10 RolePluginConfigInfo

参数

参数类型

描述

plugin_type

String

插件类型

  • WEATHER_QUERY:天气查询

  • WEB_SEARCH:网络搜索

plugin_source

String

使用的插件来源

  • PLUGIN_CONFIG:插件配置

  • DEFAULT:默认

plugin_config_id

String

插件配置ID。

表11 McpServerBaseInfo

参数

参数类型

描述

mcp_server_id

String

MCP服务端对接配置ID。

name

String

MCP服务端对接配置名称。

状态码:400

表12 响应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"
}

SDK代码示例

SDK代码示例如下。

 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.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;


public class ListRoleSolution {

    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);

        MetaStudioClient client = MetaStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListRoleRequest request = new ListRoleRequest();
        try {
            ListRoleResponse response = client.listRole(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 huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.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 = MetaStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListRoleRequest()
        response = client.list_role(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"
    metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/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 := metastudio.NewMetaStudioClient(
        metastudio.MetaStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListRoleRequest{}
	response, err := client.ListRole(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

处理成功返回。

400

请求传参异常,包含错误码及对应描述。

错误码

请参见错误码

相关文档