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

Obtém um funcionário digital.

Descrição da operação

Obtém um funcionário digital.

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:GetDigitalEmployee

get

*DigitalEmployee

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

Nenhuma

Sintaxe da solicitação

GET /digital-employee/{name} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
name	string	Sim	O nome do funcionário digital.	test

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	0B9377D9-C56B-5C2E-A8A4-************
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-03-11T08:21:58Z
displayName	string	O nome de exibição do funcionário digital.	test
updateTime	string	A hora de atualização.	2025-02-18T02:25:06Z
roleArn	string	O ARN da função RAM.	acs:ram::12345678912:role/testrole
regionId	string	O ID da região.	cn-beijing
knowledges	object	A lista de bases de conhecimento.
bailian	array<object>	A lista de bases de conhecimento do Bailian.
	object	A lista de bases de conhecimento do Bailian.
workspaceId	string	O ID do workspace Bailian.	llm-xxxxx
indexId	string	O ID do índice Bailian.	index-xxxx
region	string	A região da base de conhecimento.	cn-beijing
attributes	string	Os atributos da base de conhecimento.	test
sop	array<object>	A lista de bases de conhecimento SOP.
	object	A base de conhecimento SOP.	{ "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
tags	array	As tags.
	Tag	As tags.
resourceGroupId	string	O ID do grupo de recursos.	rg-ae******ey
attributes	object	Os atributos.
	string	Os atributos.	{}
toolPolicy	object	A política de ferramentas.	{"aliyun":{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}}
aliyun	object	A configuração de política de segurança para chamadas de ferramentas da CLI Aliyun.	{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}
enable	boolean	Indica se a política está ativada.	true
statements	array<object>	A lista de instruções da política de ferramentas Aliyun CLI.	[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]
	object	Uma única instrução da política de ferramentas Aliyun OpenAPI.	{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}
decision	string	A política de execução. Valores válidos: allow : allow. user_ack : user_ack.	user_ack
product	string	O código do serviço de nuvem.	Sls
apiVersion `deprecated`	string	A versão da API.	2020-12-30
actions	array	A lista de ações RAM.	["log:GetProject","log:CreateDashboard"]
	string	Ação RAM.	log:GetProject
sandboxNetworkPolicy	object	A configuração de política ACL de rede do sandbox para o funcionário digital.	{"allowFqdns":["api.example.com"],"allowCidrs":["1.2.3.0/24","8.8.8.8"],"enableAcl":false}
allowFqdns	array	A lista de FQDNs permitidos.
	string	A lista de FQDNs permitidos.	api.example.com
allowCidrs	array	A lista de CIDRs ou endereços IP permitidos.
	string	A lista de CIDRs ou endereços IP permitidos.	1.2.3.0/24
enableAcl	boolean	Indica se a ACL de rede do sandbox está ativada.	false

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "0B9377D9-C56B-5C2E-A8A4-************\n",
  "name": "test",
  "defaultRule": "test",
  "description": "test",
  "createTime": "2025-03-11T08:21:58Z\n",
  "displayName": "test",
  "updateTime": "2025-02-18T02:25:06Z\n",
  "roleArn": "acs:ram::12345678912:role/testrole",
  "regionId": "cn-beijing\n",
  "knowledges": {
    "bailian": [
      {
        "workspaceId": "llm-xxxxx\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",
  "tags": [
    {
      "key": "test-key",
      "value": "test-value"
    }
  ],
  "resourceGroupId": "rg-ae******ey",
  "attributes": {
    "key": "{}"
  },
  "toolPolicy": {
    "aliyun": {
      "enable": true,
      "statements": [
        {
          "decision": "user_ack",
          "product": "Sls",
          "apiVersion": "2020-12-30",
          "actions": [
            "log:GetProject"
          ]
        }
      ]
    }
  },
  "sandboxNetworkPolicy": {
    "allowFqdns": [
      "api.example.com"
    ],
    "allowCidrs": [
      "1.2.3.0/24"
    ],
    "enableAcl": false
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDigitalEmployee.NotFound	The specified DigitalEmployee does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.