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 de gateway dedicadas (V2)/ Gerenciamento de aplicações/ Modificação de uma aplicação
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Modificação de uma aplicação

Função

Esta API é usada para modificar as informações sobre uma aplicação. Somente os parâmetros de nome e observação podem ser modificados. Se a função de personalização de chaves e segredos estiver habilitada, app_key e app_secret também podem ser modificados.

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}

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.

app_id

Sim

String

ID de aplicação.

Parâmetros de solicitação

Tabela 2 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.
Tabela 3 Parâmetros de corpo de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

name

Sim

String

Nome de aplicação. Pode conter 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 de aplicação. Não pode exceder 255 caracteres.

app_key

Não

String

AppKey. Pode conter de 8 a 64 caracteres, começando com uma letra ou dígito. Apenas letras, números, hifens (-) e sublinhados (_) são permitidos.

app_secret

Não

String

AppSecret. Pode conter de 8 a 64 caracteres, começando com uma letra ou dígito. Somente letras, dígitos e os seguintes caracteres especiais são permitidos: _-!@#$%

Parâmetros de resposta

Código de status: 201

Tabela 4 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

id

String

ID.

name

String

Nome.

remark

String

Descrição.

creator

String

Criador da aplicação.

  • USER: a aplicação é criada por um usuário da API.

  • MARKET: a aplicação é alocada pelo KooGallery.

O valor MARKET não é suportado no momento.

Valores de enumeração:

  • USER

  • MARKET

update_time

String

Hora da atualização.

app_key

String

AppKey.

app_secret

String

AppSecret.

register_time

String

Tempo de registro.

status

Integer

Status.

  • 1: válido

Valores de enumeração:

  • 1

app_type

String

Tipo de aplicação.

  • apig: aplicação do APIG, que não é recomendada.

  • roma: aplicação de integração ROMA.

O valor padrão é apig. Outros tipos não são suportados atualmente.

Valores de enumeração:

  • apig

  • roma

roma_app_type

String

Tipo de aplicação de ROMA.

  • subscrição: aplicação de subscrição

  • integração: aplicação de integração

Atualmente, este parâmetro não é suportado.

Código de status: 400

Tabela 5 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 6 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 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: 404

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: 500

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.

Exemplo de solicitações

{
  "name" : "app_demo",
  "remark" : "Demo app"
}

Exemplo de respostas

Código de status: 201

OK

{
  "creator" : "USER",
  "update_time" : "2020-08-03T13:21:48.381148828Z",
  "app_key" : "ee8f878c252747028f07eb116c2cd91b",
  "name" : "app_demo",
  "remark" : "Demo app",
  "id" : "356de8eb7a8742168586e5daf5339965",
  "app_secret" : "416b6b2a1d394111b9bc1df0e6842ab8",
  "register_time" : "2020-08-03T13:09:13",
  "status" : 1,
  "app_type" : "apig"
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:id. 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: 404

Não encontrado

{
  "error_code" : "APIG.3002",
  "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
}

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

201

OK

400

Solicitação inválida

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Gerenciamento de aplicações