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.
Central de ajuda/ API Gateway/ Referência de API/ APIs compartilhadas de gateway (para usuários existentes)/ Gerenciamento de grupos de API/ Modificação de um grupo de API
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Modificação de um grupo de API

Função

Esta API é usada para modificar os atributos de um grupo de APIs. Somente os atributos name e remark de um grupo de APIs podem ser modificados.

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

PUT

/v1.0/apigw/api-groups/{id}

A tabela a seguir lista o parâmetro no URI.

Tabela 2 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

id

Sim

String

ID do grupo da API

Solicitação

Tabela 3 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

name

Sim

String

Nome do grupo da API

Um nome de grupo da API consiste de 3 a 64 caracteres, começando com uma letra. Apenas letras, dígitos e sublinhados (_) são permitidos.

remark

Não

String

Descrição do grupo da API

A descrição não pode exceder 255 caracteres.

Exemplo de solicitação:

{
	"name": "api_group_001",
	"remark": "API group 001"
}

Resposta

Tabela 4 Descrição do parâmetro

Parâmetro

Tipo

Descrição

id

String

ID do grupo da API

name

String

Nome do grupo da API

status

Integer

Status do grupo da API

sl_domain

String

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

sl_domains

String

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

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

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

is_default

Integer

Indica se o grupo da API é o grupo da API padrão. Por padrão, o grupo da API não é o grupo da API padrão. O valor pode ser:

  • 1: grupo da API padrão
  • 2: grupo da API não padrão
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: em andamento
  • 3: bem-sucedido
  • 4: falhou

ssl_id

String

ID do certificado SSL

ssl_name

String

Nome do certificado SSL

Exemplo de resposta:

{
	"id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950",
	"name": "api_group_001",
	"status": 1,
	"sl_domain": "0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com",
        "sl_domains": ["0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com","0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.cn"],
	"remark": "API group 001",
	"register_time": "2017-12-28T11:44:53Z",
	"update_time": "2017-12-28T11:49:01.048600577Z",
	"on_sell_status": 2,
        "is_default": 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

403

Proibido

404

Não encontrado

409

Conflito

500

Erro do servidor interno
Tópico principal: Gerenciamento de grupos de API