ListPolicyClasses - API Gateway: 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

apig:ListPolicyClasses

none

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /v1/policy-classes HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
type	string	Não	O tipo de modelo de política.	FlowControl
direction	string	Não	A direção da política. Valores válidos: OutBound: saída. InBound: entrada. Both: ambas as direções.	InBound
attachResourceType	string	Não	O tipo de recurso ao qual a política pode ser associada. Valores válidos: HttpApi: HttpApi. Operation: uma operação de HttpApi. GatewayRoute: rota do gateway. GatewayService: serviço do gateway. GatewayServicePort: porta de serviço do gateway. Domain: nome de domínio do gateway. Gateway: gateway.	Operation
pageNumber	integer	Não	O número da página. Valor padrão: 1.	1
pageSize	integer	Não	O número de entradas por página.	10
attachResourceId	string	Não	O ID do recurso associado.	route-001
gatewayId	string	Não	O ID do gateway.	gw-001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura de resposta.
requestId	string	O ID da solicitação.	23B45FA9-7208-5E55-B5CE-B6B2567DD822
code	string	O código de resposta.	Ok
message	string	A mensagem de resposta.	success
data	object	As informações do modelo de política.
pageNumber	integer	O número da página.	1
pageSize	integer	O número de entradas por página.	10
totalSize	integer	O número total de entradas.	10
items	array	A lista de modelos de política.
	PolicyClassInfo	As informações do modelo de política.

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "23B45FA9-7208-5E55-B5CE-B6B2567DD822",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": [
      {
        "classId": "pc-cpqm0s94ckt1displ8ng",
        "name": "ConcurrencyLimit",
        "alias": "并发控制",
        "version": "1.0.0",
        "description": "通过控制并发线程数以保证系统的稳定性。适用于应用内部或下游依赖出现不稳定的场景，例如慢SQL、下游应用响应时间变长等。",
        "type": "FlowControl",
        "direction": "InBound",
        "attachableResourceTypes": [
          "Gateway"
        ],
        "executeStage": "POST",
        "executePriority": "1",
        "enableLog": true,
        "deprecated": false,
        "configExample": "{}"
      }
    ]
  }
}

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.