Alibaba Cloud Model Studio:ListCategory

Obtém os detalhes de uma ou mais categorias em um workspace especificado.

Descrição da operação

• Esta API não oferece suporte à consulta de tabelas de dados.
• Para chamar esta API, um usuário RAM deve primeiro obter a permissão de API necessária para o Model Studio e ingressar em um workspace. Isso requer a permissão AliyunBailianDataFullAccess, que inclui a permissão sfm:ListCategory. Contas Alibaba Cloud podem chamar esta API diretamente. Use a versão mais recente do SDK do Model Studio.
• Esta operação oferece suporte à paginação. Ao fazer sua primeira solicitação, defina o parâmetro MaxResults para especificar o número máximo de itens a serem retornados. Se houver mais itens disponíveis, a resposta incluirá um NextToken. Para recuperar a próxima página de resultados, defina o parâmetro NextToken com o valor da resposta anterior e especifique MaxResults novamente. Um NextToken vazio indica que não há mais resultados disponíveis.
• Esta operação é idempotente.

Limitação de taxa: Esta API está sujeita à limitação de taxa. Não exceda 5 solicitações por segundo. Se o sistema limitar uma solicitação, tente novamente após um curto intervalo.

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.

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
sfm:ListCategory	list	*All Resource *	Nenhuma	Nenhuma

Sintaxe da solicitação

POST /{WorkspaceId}/datacenter/categories HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
WorkspaceId	string	Sim	O ID do workspace. Para obter detalhes, consulte Trabalhar com workspaces.	llm-3shx2gu255oqxxxx

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ConnectorId	string	Não	O ID do conector.	file_conn_xxxxx
CategoryType	string	Sim	O tipo de categoria a ser consultado. Valor válido: UNSTRUCTURED: Uma categoria para dados não estruturados. Esta API não oferece suporte à consulta de tabelas de dados estruturados.	UNSTRUCTURED
ParentCategoryId	string	Não	O ID da categoria pai.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
NextToken	string	Não	O token de paginação. Para recuperar a próxima página de resultados, passe o valor de NextToken da resposta anterior.	AAAAAdH70eOCSCKtacdomNzak4U=
MaxResults	integer	Não	O número máximo de categorias a serem retornadas por página. O intervalo válido é de 1 a 200. Valor padrão: 20. Se este parâmetro não for especificado ou for definido com um valor menor que 1, o valor padrão será usado. Se um valor maior que 200 for especificado, o valor máximo de 200 será usado.	20
CategoryName	string	Não	Filtra os resultados para incluir apenas a categoria com este nome exato. Se este parâmetro for omitido, nenhuma filtragem será aplicada.	产品清单

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
Code	string	O código de erro.	success
Data	object	O payload da resposta.
CategoryList	array<object>	A lista de categorias.
	object	Um objeto de categoria.
CategoryId	string	The category ID.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CategoryName	string	The category name.	类目1
CategoryType	string	The category type. The only valid value is: UNSTRUCTURED: A standard category.	UNSTRUCTURED
IsDefault	boolean	Indicates whether the category is the default. Valid values: true: The category is the default. false: The category is not the default. You cannot delete the default category.	true
ParentCategoryId	string	The parent category ID.	cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
HasNext	boolean	Indica se há mais resultados disponíveis para recuperação. Valores válidos: true: Há mais resultados disponíveis. false: Esta é a última página de resultados.	true
MaxResults	integer	O número máximo de resultados a serem retornados por página.	20
NextToken	string	O token usado para recuperar a próxima página de resultados. Este parâmetro é omitido quando não há mais resultados disponíveis.	AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ
TotalCount	integer	O número total de categorias correspondentes.	20
Message	string	A mensagem de erro.	workspace id is null or invalid.
RequestId	string	O ID da solicitação.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	O código de status da solicitação.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "success",
  "Data": {
    "CategoryList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
        "CategoryName": "类目1",
        "CategoryType": "UNSTRUCTURED",
        "IsDefault": true,
        "ParentCategoryId": "cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx"
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ",
    "TotalCount": 20
  },
  "Message": "workspace id is null or invalid.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

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.