ListDigitalEmployees - STAROps: Central de Documentação do Alibaba Cloud

Retorna uma lista de funcionários digitais.

Descrição da operação

Lista os funcionários digitais.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

starops:ListDigitalEmployees

list

*DigitalEmployee

acs:starops:{#regionId}:{#accountId}:digitalemployee/*

Nenhuma

Sintaxe da solicitação

GET /digital-employee HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
maxResults	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 20.	10
nextToken	string	Não	O token usado para recuperar a próxima página de resultados.	xxxxxx
name	string	Não	O nome do funcionário digital.	test
employeeType	string	Não	O tipo do funcionário digital.	custom
displayName	string	Não	O nome de exibição do funcionário digital.	test
tags	array	Não	As tags.
	Tag	Não	A tag.
resourceGroupId	string	Não	O ID do grupo de recursos.	rg-ae******ey

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	8FDE2569-626B-5176-9844-28877A*****
nextToken	string	O token para recuperar a próxima página de resultados.	xxxxx
total	integer	A contagem total.	56
maxResults	integer	O número máximo de entradas retornadas.	10
digitalEmployees	array<object>	Uma lista de funcionários digitais.
	array<object>	Um funcionário digital.
name	string	O nome do funcionário digital.	test
defaultRule	string	A regra padrão do funcionário digital.	test
description	string	A descrição do funcionário digital.	test
createTime	string	A hora de criação.	2025-11-04T08:08:57Z
displayName	string	O nome de exibição do funcionário digital.	test
updateTime	string	A hora de modificação.	2025-05-07T02:26:01Z
roleArn	string	O ARN da função RAM.	acs:ram::12345678912:role/testrole
knowledges	object	Uma lista de bases de conhecimento.
bailian	array<object>	A list of Model Studio knowledge bases.
	object	A knowledge base in Model Studio.
workspaceId	string	The ID of the Model Studio workspace.	llm-xxxx
indexId	string	The ID of the Model Studio index.	index-xxxx
region	string	The region of the knowledge base.	cn-beijing
attributes	string	The attributes of the knowledge base.	test
sop	array<object>	A list of SOP knowledge bases.
	object	An SOP knowledge base.	{ "type": "oss", "basePath": "docs/", "region": "cn-hangzhou", "endpoint": "oss-cn-hangzhou.aliyuncs.com", "bucket": "my-sop-bucket", "description": "sls sop" }
employeeType	string	O tipo do funcionário digital.	custom
resourceGroupId	string	O ID do grupo de recursos.	rg-ae******ey
tags	array	Uma lista de tags.
	Tag	Uma tag.
attributes	object	The custom attributes of the digital employee.
	string

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "8FDE2569-626B-5176-9844-28877A*****\n",
  "nextToken": "xxxxx",
  "total": 56,
  "maxResults": 10,
  "digitalEmployees": [
    {
      "name": "test",
      "defaultRule": "test",
      "description": "test",
      "createTime": "2025-11-04T08:08:57Z\n",
      "displayName": "test",
      "updateTime": "2025-05-07T02:26:01Z\n",
      "roleArn": "acs:ram::12345678912:role/testrole\n",
      "knowledges": {
        "bailian": [
          {
            "workspaceId": "llm-xxxx\n",
            "indexId": "index-xxxx\n",
            "region": "cn-beijing\n",
            "attributes": "test"
          }
        ],
        "sop": [
          {
            "type": "oss",
            "basePath": "docs/",
            "region": "cn-hangzhou",
            "endpoint": "oss-cn-hangzhou.aliyuncs.com",
            "bucket": "my-sop-bucket",
            "description": "sls sop"
          }
        ]
      },
      "employeeType": "custom",
      "resourceGroupId": "rg-ae******ey",
      "tags": [
        {
          "key": "test-key",
          "value": "test-value"
        }
      ],
      "attributes": {
        "key": ""
      }
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.