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/ API de gateway dedicados (V2)/ Gestión de reglas de orquestación/ Consulta de reglas de orquestación
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Consulta de reglas de orquestación

Función

Esta API se utiliza para ver las reglas de orquestación.

Método de invocación

Para obtener más información, véase invocación de API.

URI

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

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto.

instance_id

Sí

String

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

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

orchestration_name

No

String

Nombre de regla de orquestación.

precise_search

No

String

Nombre del parámetro para la coincidencia exacta. Se separa varios nombres de parámetros con comas (,). Solo se admite orchestration_name.

orchestration_id

No

String

ID de regla de orquestación.

Se separa varios ID de regla de orquestación con comas (,). El número máximo de ID es el número máximo de reglas que se pueden vincular a una API. Para obtener más información, véase "Notas y restricciones" en Descripción del servicio de APIG.

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 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ámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo 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.

orchestrations

Array of OrchestrationBaseResp objects

Reglas de orquestación que se consultan.
Tabla 5 OrchestrationBaseResp

Parámetro

Tipo

Descripción

orchestration_name

String

Nombre de regla de mapeo de orquestación.

El nombre debe tener entre 3 y 64 caracteres, comenzar con una letra y utilizar solo letras, dígitos y guiones bajos (_). Debe ser único en el mismo gateway.

Mínimo: 3

Máximo: 64

orchestration_strategy

String

Política de orquestación. Opciones:

  • list
  • hash
  • range
  • hash_range
  • none_value
  • default
  • head_n
  • tail_n.

    Si la política de orquestación es list, el número de objetos de orchestration_map multiplicado por el de map_param_list no puede ser superior a 3,000.

orchestration_mapped_param

OrchestrationMappedParam object

Configuración de parámetros después de orquestación. Este parámetro es obligatorio cuando isPreprocessing se establece en false.

is_preprocessing

Boolean

Indica si la política es una política de preprocesamiento. Una política de preprocesamiento genera solo parámetros temporales como entrada de la regla de orquestación de parámetros subsiguiente. Y no se puede utilizar como la última regla de orquestación excepto la regla de orquestación predeterminada.

orchestration_id

String

ID de regla de orquestación.

orchestration_create_time

String

Hora en la que se creó una regla de orquestación.

orchestration_update_time

String

Hora en la que se actualizó una regla de orquestación.
Tabla 6 OrchestrationMappedParam

Parámetro

Tipo

Descripción

mapped_param_name

String

Nombre del parámetro de solicitud después de la orquestación. El valor puede contener de 1 a 128 caracteres, incluidas letras, dígitos y guiones (-). Debe comenzar con una letra y no puede ser igual al nombre de un parámetro existente. Por defecto, el nombre del parámetro se transmite de forma transparente al backend.

Mínimo: 1

Máximo: 128

mapped_param_type

String

Tipo del parámetro después de la orquestación. El valor puede ser cadena o número.

mapped_param_location

String

Posición del parámetro orquestado. El valor puede ser consulta o encabezado.

Código de estado: 400

Tabla 7 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Descripción de error.

Código de estado: 401

Tabla 8 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Descripción de error.

Código de estado: 403

Tabla 9 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Descripción de error.

Código de estado: 404

Tabla 10 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Descripción de error.

Código de estado: 500

Tabla 11 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Descripción de error.

Ejemplo de las solicitudes

Ninguno

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "total" : 2,
  "size" : 2,
  "orchestrations" : [ {
    "orchestration_id" : "76545e81d9cb4424bf704ef2b0ac7600",
    "orchestration_name" : "orchestration_demo_1",
    "orchestration_create_time" : "2023-07-02T12:31:23.353Z",
    "orchestration_update_time" : "2023-07-02T13:31:23.353Z",
    "orchestration_strategy" : "list",
    "orchestration_mapped_param" : {
      "mapped_param_name" : "shared-tag",
      "mapped_param_type" : "number",
      "mapped_param_location" : "header"
    }
  }, {
    "orchestration_id" : "yt655e81d9cb4424bf704ef2b0ac7600",
    "orchestration_name" : "orchestration_demo_2",
    "orchestration_create_time" : "2023-07-02T12:31:23.353Z",
    "orchestration_update_time" : "2023-07-02T13:31:23.353Z",
    "orchestration_strategy" : "range",
    "orchestration_mapped_param" : {
      "mapped_param_name" : "shared-tag",
      "mapped_param_type" : "number",
      "mapped_param_location" : "header"
    }
  } ]
}

Código de estado: 400

Error en la solicitud

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

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.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

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

400

Error en la solicitud

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.