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.

Nesta página

Mostrar todos

Central de ajuda/ API Gateway/ Referência de API/ APIs de gateway dedicadas (V2)/ Gerenciamento de grupos de APIs/ Consulta de grupos de API

Consulta de grupos de API

Atualizado em 2023-05-29 GMT+08:00

Ver PDF

Função

Esta API é usada para consultar grupos de API.

Você pode consultar todos os grupos de API em sua conta como um locatário ou consultar grupos de API de todos os locatários usando uma conta de administrador.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.
instance_id	Sim	String	ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
offset	Não	Long	Deslocamento a partir do qual a consulta é iniciada. Se o valor estiver menor que 0, ele é automaticamente convertido para 0. Padrão: 0
limit	Não	Integer	Número de itens exibidos em cada página. Um valor menor ou igual a 0 será automaticamente convertido em 20, e um valor maior que 500 será automaticamente convertido em 500. Mínimo: 1 Máximo: 500 Padrão: 20
id	Não	String	ID do grupo da API.
name	Não	String	Nome do grupo de APIs.
precise_search	Não	String	Nome do parâmetro para correspondência exata. Somente nomes de grupos de API são suportados.

Parâmetros de solicitação

**Tabela 3** Parâmetros do cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

Parâmetros de resposta

Código de status: 200

**Tabela 4** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
size	Integer	Comprimento da lista de recursos retornados.
total	Long	Número de recursos que atendem às condições de consulta.
groups	Array of ApiGroupInfo objects	Grupos de API.

**Tabela 5** ApiGroupInfo
Parâmetro	Tipo	Descrição
id	String	ID.
name	String	Nome do grupo de APIs.
status	Integer	Status. 1: válido Valores de enumeração: 1
sl_domain	String	Nome do subdomínio que o APIG aloca automaticamente ao grupo da API.
register_time	String	Tempo de criação.
update_time	String	Hora da última modificação.
on_sell_status	Integer	Indica se o grupo de APIs foi listado no KooGallery. 1: listado 2: não listado 3: em revisão
url_domains	Array of UrlDomain objects	Nomes de domínio independentes vinculados ao grupo de APIs.
sl_domains	Array of strings	Nomes de subdomínio alocados automaticamente.
remark	String	Descrição.
call_limits	Integer	Número total de vezes que todas as APIs no grupo da API podem ser acessadas. Considere a capacidade de carga útil do serviço de back-end ao definir esse parâmetro. Por padrão, não há limite no número de chamadas de API. Atualmente, este parâmetro não é suportado.
time_interval	Integer	Período de tempo para limitar o número de chamadas de API. Atualmente, este parâmetro não é suportado.
time_unit	String	Unidade de tempo para limitar o número de chamadas de API. Atualmente, este parâmetro não é suportado.
is_default	Integer	Indica se o grupo de API é o grupo padrão.
version	String	Versão do grupo. V1: grupo global V2: grupo no nível da aplicação O valor padrão é V1. Este parâmetro não é suportado atualmente.
roma_app_id	String	ID da aplicação de integração ao qual o grupo de APIs pertence. Este parâmetro é necessário quando a versão do grupo é V2. Atualmente, este parâmetro não é suportado.
roma_app_name	String	Nome da aplicação de integração ao qual o grupo de APIs pertence. Atualmente, este parâmetro não é suportado.

**Tabela 6** UrlDomain
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. 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.
min_ssl_version	String	Versão SSL mínima. TLS 1.1 e TLS 1.2 são suportados. Padrão: TLSv1.1 Valores de enumeração: TLSv1.1 TLSv1.2

Código de status: 400

**Tabela 7** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 401

**Tabela 8** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 403

**Tabela 9** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 500

**Tabela 10** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

{
  "total" : 2,
  "size" : 2,
  "groups" : [ {
    "update_time" : "2020-07-31T06:55:55Z",
    "name" : "api_group_001",
    "on_sell_status" : 2,
    "remark" : "API group 1",
    "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
    "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
    "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "register_time" : "2020-07-31T06:55:55Z",
    "status" : 1,
    "is_default" : 2
  }, {
    "update_time" : "2020-06-24T15:29:42.421926Z",
    "name" : "api_group_002",
    "on_sell_status" : 2,
    "remark" : "API group 2",
    "sl_domain" : "02a8ab3cb2784de5a096852829671ae7.apic.****.com",
    "sl_domains" : [ "02a8ab3cb2784de5a096852829671ae7.apic.****.com", "02a8ab3cb2784de5a096852829671ae7.apic.****.cn" ],
    "id" : "02a8ab3cb2784de5a096852829671ae7",
    "register_time" : "2020-06-24T15:29:42.421926Z",
    "status" : 1,
    "is_default" : 2
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status	Descrição
200	OK
400	Solicitação inválida
401	Não autorizado
403	Proibido
500	Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Gerenciamento de grupos de APIs

Tópico anterior: Consulta de detalhes do grupo de APIs

Próximo tópico: Gerenciamento de ambiente

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar