GetApiSchemaUsage - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

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

esa:GetApiSchemaUsage

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	integer	Não	O ID do site. Você pode obter esse ID chamando a operação ListSites.	1159101787****
SiteVersion	integer	Não	A versão do site.	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados para a solicitação.
RequestId	string	O ID da solicitação.	952ea16b-1f05-4a76-bb32-420282d8****
InstanceId	string	O ID da instância do plano.	esa-site-agknce3n****
InstanceUsage	integer	A contagem total de arquivos de esquema de API carregados na instância do plano.	10
Usages	array<object>	Os detalhes de uso de cada site.
	object	Os detalhes de uso de um site individual.
Usage	integer	O número de arquivos de esquema de API carregados para este site.	0
Id	integer	O ID do site.	40000449
Name	string	O nome do site.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "952ea16b-1f05-4a76-bb32-420282d8****",
  "InstanceId": "esa-site-agknce3n****",
  "InstanceUsage": 10,
  "Usages": [
    {
      "Usage": 0,
      "Id": 40000449,
      "Name": "test"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.ApiShield.Quota	This website does not have the permission to view API security features.	This website does not have the permission to view API security features.
400	SiteVersion.NotExist	The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.	The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.