Cria uma categoria em um workspace especificado para classificar e gerenciar arquivos. Cada workspace suporta no máximo 500 categorias.
Descrição da operação
- Você não pode usar uma API para adicionar tabelas de dados. Para adicionar tabelas de dados, acesse a página Application Data no console.
- Um usuário RAM deve obter as permissões de API necessárias para o Alibaba Cloud Model Studio e ingressar em um workspace antes de chamar esta operação. A permissão
AliyunBailianDataFullAccess, que inclui a permissãosfm:AddCategory, é necessária. Uma conta Alibaba Cloud pode chamar esta operação diretamente sem necessidade de autorização. Para chamar esta operação, use a versão mais recente do SDK do Alibaba Cloud Model Studio. - Esta operação não é idempotente.
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
Actiondas 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
Resourceda política. - Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento
Resourceda política.
- 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
- 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:AddCategory | create | *All Resource
| Nenhuma | Nenhuma |
Sintaxe da solicitação
Parâmetros de caminho
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| WorkspaceId | string | Sim | O ID do workspace onde você deseja criar a categoria. Para mais informações sobre como obter um ID de workspace, consulte Trabalhar com workspaces. | llm-3z7uw7fwz0vxxxx |
Parâmetros da solicitação
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| CategoryName | string | Sim | O nome da categoria. O nome deve ter de 1 a 20 caracteres. Pode conter letras Unicode, como letras em inglês e caracteres chineses, além de dígitos, dois-pontos (:), underscores (_), pontos (.) e hifens (-). | 产品清单 |
| CategoryType | string | Sim | O tipo da categoria. Valor válido:
| UNSTRUCTURED |
| ParentCategoryId | string | Não | O ID da categoria pai sob a qual a nova categoria é criada. Se você deixar este parâmetro vazio, uma categoria de nível superior será criada. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| ConnectorId | string | Não | O ID da instância do conector. Você pode obter o ID no console do Alibaba Cloud Model Studio. | conn_xxxx |
Elementos de resposta
Elemento | Tipo | Descrição | Exemplo |
|---|---|---|---|
object | O objeto de resposta. | ||
| Code | string | O código de erro. | success |
| Data | object | Os dados retornados. | |
| CategoryId | string | O ID da categoria. Salve este ID para futuras chamadas de API que utilizem esta categoria. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| CategoryName | string | O nome da categoria. | 类目名称 |
| Message | string | A mensagem de erro. | Requests throttling triggered. |
| RequestId | string | O ID da solicitação. | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Status | string | O código de status HTTP retornado. | 200 |
| Success | boolean | Indica se a solicitação foi bem-sucedida. Valores válidos:
| true |
Exemplos
Resposta de sucesso
JSON formato