Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2023-05-29 GMT+08:00

Consulta da lista de grupos da API

Função

Esta API é usada para consultar a lista de grupos de APIs.

Se a operação for executada por um locatário, todos os grupos do locatário serão consultados. Se a operação for executada por um administrador de locatários, os grupos de todos os locatários serão consultados.

URI

A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.

Tabela 1 Método de solicitação HTTP/HTTPS e URI

Método de solicitação

URI

GET

/v1.0/apigw/api-groups[?page_size, page_no, id, name]

  • Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
  • As condições de consulta incluem: id, name, page_size e page_no.

A tabela a seguir lista os parâmetros no URI.

Tabela 2 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

id

Não

String

ID do grupo da API

name

Não

String

Nome do grupo da API

page_size

Não

Integer

Número de registros exibidos em cada página. O valor padrão é 20.

Valor máximo: 500

page_no

Não

Integer

Número da página. O valor padrão é 1.

precise_search

Não

String

Nome do parâmetro para correspondência exata

Solicitação

N/D

Resposta

Tabela 3 Descrição do parâmetro

Parâmetro

Tipo

Descrição

total

Integer

Número de grupos de API que correspondem às condições de consulta

size

Integer

Comprimento da lista de grupos de API retornada

groups

Dicionário

Lista de grupos da API

Tabela 4 Descrição do parâmetro do grupo da API

Parâmetro

Tipo

Descrição

id

String

ID do grupo da API

name

String

Nome do grupo da API

status

Integer

Status do grupo de API

sl_domain

String

Nome do subdomínio que o APIG aloca automaticamente para o grupo da API

sl_domains

Array of strings

Lista de nomes de subdomínio que o APIG aloca automaticamente para o grupo da API

register_time

Timestamp

Hora em que o grupo da API é criado

update_time

Timestamp

Hora em que o grupo da API foi modificado pela última vez

remark

String

Descrição do grupo da API

on_sell_status

Integer

Indica se o grupo de APIs foi listado no marketplace. O valor pode ser:

  • 1: listado
  • 2: não listado
  • 3: sob aprovação

call_limits

Integer

Número total de vezes que todas as APIs no grupo da API podem ser acessadas. Defina esse parâmetro ao considerar a capacidade de carga útil do serviço de back-end. Por padrão, não há limite no número de chamadas de API.

time_interval

Integer

Período de tempo para limitar o número de chamadas de API

time_unit

String

Unidade de tempo para limitar o número de chamadas de API

url_domains

Array of UrlDomainsResp objects

Lista de nomes de domínio independentes vinculados ao grupo da API

Tabela 5 UrlDomainsResp

Parâmetro

Tipo

Descrição

id

String

ID do domínio

domain

String

Nome de domínio

cname_status

Integer

Status de resolução CNAME do nome de domínio, que pode ser:

  • 1: não resolvido
  • 2: resolvendo
  • 3: resolvido
  • 4: resolução falhou

ssl_id

String

ID do certificado SSL

ssl_name

String

Nome do certificado SSL

Exemplo de resposta:

{
	"total": 2,
	"size": 2,
	"groups": [{
		"id": "02a8ab3c-b278-4de5-a096-852829671ae7",
		"name": "api_group_002",
		"status": 1,
		"sl_domain": "19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.com",
                "sl_domains": ["19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.com","19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.cn"],
		"remark": "API group 002",
		"register_time": "2017-12-28T11:57:35Z",
		"update_time": "2017-12-28T11:57:35Z",
		"on_sell_status": 2
	},
	{
		"id": "73c58022-f20d-495a-a188-85d718647f09",
		"name": "api_group_001",
		"status": 1,
		"sl_domain": "c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.com",
                "sl_domains": ["c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.com","c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.cn"],
		"remark": "API group 001",
		"register_time": "2017-12-28T11:57:27Z",
		"update_time": "2017-12-28T11:57:27Z",
		"on_sell_status": 2
	}]
}

Códigos de status

Tabela 6 Códigos de status

Código de status

Descrição

200

OK

400

Solicitação inválida

401

Não autorizado

500

Erro do servidor interno