Modificación de un autorizador personalizado
Función
Esta API se utiliza para modificar un autorizador personalizado.
Método de invocación
Para obtener más información, véase invocación de API.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto.For details about how to obtain it, see Obtaining a Project ID. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
|
authorizer_id |
Sí |
String |
ID de autorizador personalizado. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
name |
Sí |
String |
Nombre personalizado del autorizador. Puede contener de 3 a 64 caracteres, comenzando con una letra. Solo se permiten letras, dígitos y guiones bajos (_). |
|
type |
Sí |
String |
Tipo de autorizador personalizado.
No se permite la modificación. |
|
authorizer_type |
Sí |
String |
Valor: FUNC. |
|
authorizer_uri |
Sí |
String |
URN de la función. |
|
network_type |
No |
String |
Arquitectura de red de funciones:
Predeterminado: V1 |
|
authorizer_version |
No |
String |
Versión de función. Si se pasa un URN de alias de función y una versión, se usará el URN de alias y se ignorará la versión. Máximo: 64 |
|
authorizer_alias_uri |
No |
String |
URN de alias de función. Si se pasa un URN de alias de función y una versión, se usará el URN de alias y se ignorará la versión. |
|
identities |
No |
Array of Identity objects |
Fuente de identidad. |
|
ttl |
No |
Integer |
Vigencia máxima de la caché. |
|
user_data |
No |
String |
Datos de usuario. |
|
ld_api_id |
No |
String |
ID de backend personalizado. Actualmente, este parámetro no es compatible. |
|
need_body |
No |
Boolean |
Indica si se debe enviar el cuerpo. |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
name |
String |
Nombre personalizado del autorizador. Puede contener de 3 a 64 caracteres, comenzando con una letra. Solo se permiten letras, dígitos y guiones bajos (_). |
|
type |
String |
Tipo de autorizador personalizado.
No se permite la modificación. |
|
authorizer_type |
String |
Valor: FUNC. |
|
authorizer_uri |
String |
URN de la función. |
|
network_type |
String |
Arquitectura de red de funciones:
Predeterminado: V1 |
|
authorizer_version |
String |
Versión de función. Si se pasa un URN de alias de función y una versión, se usará el URN de alias y se ignorará la versión. Máximo: 64 |
|
authorizer_alias_uri |
String |
URN de alias de función. Si se pasa un URN de alias de función y una versión, se usará el URN de alias y se ignorará la versión. |
|
identities |
Array of Identity objects |
Fuente de identidad. |
|
ttl |
Integer |
Vigencia máxima de la caché. |
|
user_data |
String |
Datos de usuario. |
|
ld_api_id |
String |
ID de backend personalizado. Actualmente, este parámetro no es compatible. |
|
need_body |
Boolean |
Indica si se debe enviar el cuerpo. |
|
id |
String |
ID de autorizador personalizado. |
|
create_time |
String |
Tiempo de creación. |
|
roma_app_id |
String |
ID de la aplicación a la que pertenece el autorizador personalizado. Actualmente, este parámetro no es compatible. |
|
roma_app_name |
String |
Nombre de la aplicación a la que pertenece el autorizador personalizado. Actualmente, este parámetro no es compatible. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
name |
String |
Nombre del parámetro. |
|
location |
String |
Ubicación del parámetro. |
|
validation |
String |
Expresión de verificación de parámetros. El valor predeterminado es nulo, lo que indica que no se realiza ninguna verificación. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 404
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Actualización de un autorizador personalizado frontend
{
"name" : "Authorizer_demo",
"type" : "FRONTEND",
"authorizer_type" : "FUNC",
"authorizer_uri" : "urn:fss:xx-xxx:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
"network_type" : "V1",
"authorizer_version" : "v1",
"authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
"user_data" : "authorizer_test",
"identities" : [ {
"name" : "header",
"location" : "HEADER"
} ]
}
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"name" : "Authorizer_demo",
"type" : "FRONTEND",
"authorizer_type" : "FUNC",
"authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
"network_type" : "V1",
"authorizer_version" : "v1",
"authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
"identities" : [ {
"name" : "header",
"location" : "HEADER"
} ],
"ttl" : 5,
"user_data" : "authorizer_test",
"id" : "0d982c1ac3da493dae47627b6439fc5c",
"create_time" : "2020-07-08T03:27:52.000+0000"
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3081",
"error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Aceptar |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
404 |
No se ha encontrado |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.