Consulta de detalhes do AppCode
Função
Esta API é usada para criar um AppCode para uma aplicação para autenticação simples.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_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. |
|
app_code_id |
Sim |
String |
ID do AppCode. |
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âmetros de resposta
Código de status: 201
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
app_code |
String |
Valor do AppCode. O valor pode conter de 64 a 180 caracteres, começando com uma letra, sinal de adição (+), ou barra (/). Somente letras e os seguintes caracteres especiais são permitidos: +_!@#$%/= |
|
id |
String |
ID. |
|
app_id |
String |
ID de aplicação. |
|
create_time |
String |
Tempo de criação. |
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
Nenhum
Exemplo de respostas
Código de status: 201
Criado
{
"app_code" : "fdc8d90a30174460a91ddacfa54d6f04c92e523a85cc4a1894f87cb13b6f572a",
"app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
"id" : "b3d34f746d0847fb95138670e10207ed",
"create_time" : "2020-07-24T02:31:45Z"
}
Código de status: 400
Solicitação inválida
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:app_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.3004",
"error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc 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 |
Criado |
|
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.