Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda> API Gateway> Referencia de la API> Las API de gateway dedicado (V2)> Gestión de clave de firma> Consulta de claves de firma
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF

Consulta de claves de firma

Función

Esta API se utiliza para consultar todas las claves de firma.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/signs

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.

instance_id

Sí

String

Gateway ID, que se puede obtener de la información de gateway en la consola APIG.
Tabla 2 Parámetros de Query

Parámetro

Obligatorio

Tipo

Descripción

offset

No

Long

Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0.

Predeterminado: 0

limit

No

Integer

Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500.

Mínimo: 1

Máximo: 500

Predeterminado: 20

id

No

String

ID de clave de firma.

name

No

String

Nombre de clave de firma.

precise_search

No

String

Nombre del parámetro (nombre) para la coincidencia exacta.

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Token de usuario. Se puede obtener llamando 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ámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

size

Integer

Longitud de la lista de recursos devuelta.

total

Long

Número de recursos que coinciden con las condiciones de consulta.

signs

Array of SignatureWithBindNum objects

Lista de claves de firma.
Tabla 5 SignatureWithBindNum

Parámetro

Tipo

Descripción

name

String

Nombre de clave de firma. Puede contener letras, dígitos y guiones bajos (_) y debe comenzar con una letra.

Mínimo: 3

Máximo: 64

sign_type

String

Tipo de clave de firma.

  • hmac

  • basic

  • public_key

  • aes

Para utilizar una clave de firma básica, asegúrese de que la versión del gateway la admita. Si el gateway no admite este tipo de clave de firma, póngase en contacto con el soporte técnico para actualizar su gateway.

Para usar una clave de firma de public_key, asegúrese de que la función public_key se haya configurado para su gateway. Para obtener más información, consulte "Apéndice" > "Características compatibles". Si su gateway no admite esta función, póngase en contacto con el soporte técnico para habilitarla.

Para utilizar una clave de firma AES, asegúrese de que la versión del gateway la admita. Si el gateway no admite este tipo de clave de firma, póngase en contacto con el soporte técnico para actualizar su gateway.

Valores de enumeración:

  • hmac

  • basic

  • public_key

  • aes

sign_key

String

Clave de firma.

  • hmac: El valor contiene de 8 a 32 caracteres, incluidas letras, dígitos, guiones bajos (_), y guiones (-). Debe comenzar con una letra o un dígito. Si no se especifica, se genera automáticamente un valor.

  • basic: El valor contiene de 4 a 32 caracteres, incluyendo letras, dígitos, guiones bajos (_), y guiones (-). Debe comenzar con una carta. Si no se especifica, se genera automáticamente un valor.

  • public_key: El valor contiene de 8 a 512 caracteres, incluyendo letras, dígitos y caracteres especiales (_-+/=). Debe comenzar con una letra, dígito, signo más (+) o barra inclinada (/). Si no se especifica, se genera automáticamente un valor.

  • aes: El valor contiene 16 caracteres si se utiliza el algoritmo aes-128-cfb o 32 caracteres si se utiliza el algoritmo aes-256-cfb. Se permiten letras, dígitos y caracteres especiales (_-!@#$%+/=). El valor debe comenzar con una letra, un dígito, un signo más (+) o una barra inclinada (/). Si no se especifica, se genera automáticamente un valor.

sign_secret

String

Firma secreta.

  • hmac: el valor contiene entre 16 y 64 caracteres. Se permiten letras, dígitos y caracteres especiales (_-!@#$%). Debe comenzar con una letra o un dígito. Si no se especifica, se genera automáticamente un valor.

  • basic: El valor contiene de 8 a 64 caracteres. Se permiten letras, dígitos y caracteres especiales (_-!@#$%). Debe comenzar con una letra o un dígito. Si no se especifica, se genera automáticamente un valor.

  • public_key: el valor contiene de 15 a 2048 caracteres, incluidas letras, dígitos y caracteres especiales (_-!@#$%+/=). Debe comenzar con una letra, dígito, signo más (+) o barra inclinada (/). Si no se especifica, se genera automáticamente un valor.

  • aes: El valor contiene 16 caracteres, incluidas letras, dígitos y caracteres especiales (_-!@#$%+/=). Debe comenzar con una letra, dígito, signo más (+) o barra inclinada (/). Si no se especifica, se genera automáticamente un valor.

sign_algorithm

String

Algoritmo de firma. Especifique un algoritmo de firma sólo cuando utilice una clave de firma AES. Por defecto, no se utiliza ningún algoritmo.

Valores de enumeración:

  • aes-128-cfb

  • aes-256-cfb

update_time

String

Hora de actualización.

create_time

String

Hora de creación.

id

String

ID de clave de firma.

bind_num

Integer

Número de API enlazadas.

ldapi_bind_num

Integer

Número de backends personalizados enlazados.

Actualmente, este parámetro no es compatible.

Código de estado: 400

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 7 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

Ninguna

Ejemplo de respuestas

Código de estado: 200

OK

{
  "total" : 2,
  "size" : 2,
  "signs" : [ {
    "sign_secret" : "signsecretsignsecretsignsecretsignsecret",
    "update_time" : "2018-02-07T02:00:27.964766Z",
    "create_time" : "2018-02-06T12:17:36Z",
    "name" : "signature_demo",
    "id" : "0b0e8f456b8742218af75f945307173c",
    "sign_key" : "signkeysignkey",
    "sign_type" : "hmac",
    "bind_num" : 0,
    "ldapi_bind_num" : 0
  }, {
    "sign_secret" : "9ce16b029034464898ee33540c42e16a",
    "update_time" : "2020-07-30T03:56:58Z",
    "create_time" : "2020-07-30T03:56:58Z",
    "name" : "Signature_udlu",
    "id" : "9dc388382fba485aadd19f932303f4c9",
    "sign_key" : "ca50c5b670044c83b5b890a9a68a30d5",
    "sign_type" : "hmac",
    "bind_num" : 0,
    "ldapi_bind_num" : 0
  } ]
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Código de estado: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de estado: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de estado: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de clave de firma