GetCategories - ApsaraVideo VOD: Central de Documentação do Alibaba Cloud

Invoca esta operação para realizar uma consulta filtrada das informações de categorização especificadas e da lista de suas subcategorias por ID ou tipo.

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

vod:GetCategories

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CateId	integer	Não	O ID da categoria. Se você especificar este parâmetro, poderá consultar a categoria com o ID especificado. Você pode especificar apenas um ID de categoria. Você pode obter o ID da categoria usando um dos seguintes métodos:\n- Faça login no console do ApsaraVideo VOD e escolha Gerenciamento de Configurações > Configuração de Ativos de Mídia > Gerenciamento de Categorias para visualizar o ID da categoria.\n- O ID da categoria é retornado quando você chama a operação AddCategory para criar uma categoria.	49339****
PageNo	integer	Não	O número da página da lista de subcategorias. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página na lista de subcategorias. Valor padrão: 10. Valor máximo: 100.	10
SortBy	string	Não	O método de classificação dos resultados da consulta. Valores válidos:\n\n- CreationTime:Desc (padrão): Classifica por hora de criação em ordem decrescente.\n- CreationTime:Asc: Classifica por hora de criação em ordem crescente.	CreationTime:Desc
Type	string	Não	O tipo de categorização. Se você especificar este parâmetro, poderá realizar uma consulta filtrada para categorizações do tipo especificado. Valores válidos:\n- default: Categorização de áudio, vídeo ou imagem.\n- material: Categorização de material de vídeo curto.	default

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
SubTotal	integer	O número total de subcategorias.	2
RequestId	string	O ID da solicitação.	25818875-5F78-4AF6-D7393642CA58****
Category	object	Os detalhes da categoria.
Type	string	O tipo de categoria. Valores válidos:\n- default: Categoria de áudio, vídeo ou imagem.\n- material: Categoria de material de vídeo curto.	default
ParentId	integer	O ID da categoria pai.	100012****
CateName	string	O nome da categoria.	movie
CateId	integer	O ID da categoria.	100
Level	integer	O nível da categoria. Valores válidos:\n\n- 0: Categoria de nível 1.\n- 1: Categoria de nível 2.\n- 2: Categoria de nível 3.	0
SubCategories	object
Category	array<object>	Os detalhes das subcategorias.
	object
Type	string	O tipo da subcategoria. Valores válidos:\n- default: Categoria de áudio, vídeo ou imagem.\n- material: Categoria de material de vídeo curto.	default
CateName	string	O nome da categoria.	Movie
ParentId	integer	O ID da categoria pai.	10020****
CateId	integer	O ID da categoria.	100
SubTotal	integer	O número total de subcategorias.	1
Level	integer	O nível da categoria. Valores válidos:\n\n- 0: Categoria de nível 1.\n- 1: Categoria de nível 2.\n- 2: Categoria de nível 3.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "SubTotal": 2,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Category": {
    "Type": "default",
    "ParentId": 0,
    "CateName": "movie",
    "CateId": 100,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "电影",
        "ParentId": 0,
        "CateId": 100,
        "SubTotal": 1,
        "Level": 1
      }
    ]
  }
}

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.