Redefinição do AppSecret de uma aplicação
Função
Esta API é usada para redefinir o AppSecret de uma aplicação.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{app_id}
|
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
|
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âmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
app_secret |
Não |
String |
Um AppSecret consiste de 8 a 64 caracteres, começando com uma letra ou dígito. Somente letras, dígitos e caracteres especiais (_-!@#$%) são permitidos. Para personalizar o AppSecrets certifique-se de que a autenticação de AppSecret foi ativada. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID. |
|
name |
String |
Nome. |
|
remark |
String |
Descrição. |
|
creator |
String |
Criador da aplicação.
O valor MARKET não é suportado no momento. Valores de enumeração:
|
|
update_time |
String |
Hora da atualização. |
|
app_key |
String |
AppKey. |
|
app_secret |
String |
AppSecret. |
|
register_time |
String |
Tempo de registro. |
|
status |
Integer |
Status.
Valores de enumeração:
|
|
app_type |
String |
Tipo de aplicação.
O valor padrão é apig. Outros tipos não são suportados atualmente. Valores de enumeração:
|
|
roma_app_type |
String |
Tipo de aplicação de ROMA.
Atualmente, este parâmetro não é suportado. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 401
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 403
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 404
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitações
{
"app_secret" : "1ff226f0d2b54ac48c2d298c52ba49a4"
}
Exemplo de respostas
Código de status: 200
OK
{
"creator" : "USER",
"update_time" : "2020-08-03T14:12:43.038171689Z",
"app_key" : "ee8f878c252747028f07eb116c2cd91b",
"name" : "app_demo",
"remark" : "Demo app",
"id" : "356de8eb7a8742168586e5daf5339965",
"app_secret" : "1ff226f0d2b54ac48c2d298c52ba49a4",
"register_time" : "2020-08-03T13:09:13Z",
"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 |
|---|---|
|
200 |
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.