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)/ Vinculación/desvinculación de claves de firma/ Consulta de APIs no vinculadas con una clave de firma
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Consulta de APIs no vinculadas con una clave de firma

Función

Esta API se utiliza para consultar las API a las que no se ha vinculado una clave de firma. Solo se mostrarán las API publicadas.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-apis

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

sign_id

Sí

String

ID de clave de firma.

env_id

No

String

ID de entorno.

api_id

No

String

ID de API.

api_name

No

String

Nombre de API.

group_id

No

String

ID de grupo de API.

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.

apis

Array of ApiForSign objects

Lista de API.
Tabla 5 ApiForSign

Parámetro

Tipo

Descripción

auth_type

String

Modo de autenticación de API.

run_env_name

String

Nombre del entorno en el que se ha publicado la API.

group_name

String

Nombre del grupo de API al que pertenece la API.

publish_id

String

ID del registro de publicación.

group_id

String

ID del grupo de API al que pertenece la API.

name

String

Nombre de API.

remark

String

Descripción de API.

run_env_id

String

ID del entorno en el que se ha publicado la API.

id

String

ID de API.

req_uri

String

Dirección de solicitud de API.

type

Integer

Tipo de API.

signature_name

String

Nombre de la clave de firma vinculada a la API.

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

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.

Código de estado: 500

Tabla 10 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" : 1,
  "size" : 1,
  "apis" : [ {
    "run_env_name" : "RELEASE",
    "group_name" : "api_group_001",
    "remark" : "Mock backend API",
    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "name" : "Api_mock",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
    "type" : 1,
    "auth_type" : "IAM",
    "req_uri" : "/test/mock"
  } ]
}

Código de estado: 400

Bad Request

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

Not Found

{
  "error_code" : "APIG.3017",
  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
}

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

404

Not Found

500

Internal Server Error

Códigos de error

Consulte Códigos de error.