Consulta de instancias a las que se puede aplicar una plantilla de parámetros
Función
Esta API se utiliza para consultar instancias de BD a las que se puede aplicar una plantilla de parámetros. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3/{project_id}/configurations/{configuration_id}/applicable-instances
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
configuration_id |
Sí |
String |
ID de plantilla de parámetros. Para obtener este valor, véase Consulta de plantillas de parámetros. Una vez procesada la solicitud, el valor de id en el cuerpo de la respuesta es el valor de configuration_id. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Integer |
Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor predeterminado es 0, lo que indica que la consulta comienza desde el primer dato. El valor no puede ser un número negativo. |
limit |
No |
Integer |
Número de registros que se van a consultar. El valor predeterminado es 100. El valor debe ser un entero positivo. El valor mínimo es de 1 y el valor máximo es de 100. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
X-Language |
No |
String |
Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
instances |
Array of ApplicableInstances objects |
Lista de instancias a las que se puede aplicar la plantilla de parámetros. |
total_count |
Integer |
Número de instancias a las que se puede aplicar la plantilla de parámetros. |
Parámetro |
Tipo |
Descripción |
---|---|---|
instance_id |
String |
ID de instancia. |
instance_name |
String |
Nombre de instancia. |
Código de estado: 400
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 la solicitud
Consulta de instancias a las que se puede aplicar una plantilla de parámetro de plantilla
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/0c82974e2354466098d7b4b72e55129dpr07/applicable-instances
Ejemplo de la respuesta
Código de estado: 200
Operación exitosa.
{ "total_count" : 10, "instances" : [ { "instance_id" : "75e1935142974ca685357dc784626f22in07", "instance_name" : "gauss-ff14-hll" }, { "instance_id" : "cf72c31a689c40b7883c355a0bb5cc1din07", "instance_name" : "tst-bbbnew" }, { "instance_id" : "4a99fbae95df43648281cdd9e269c1c7in07", "instance_name" : "gauss-62d8" }, { "instance_id" : "fb6244dc9b1443b7ad0aae81283d5d28in07", "instance_name" : "gauss-test-1" }, { "instance_id" : "2260da7e105e485ebc9c060c1663d89ain07", "instance_name" : "gauss-f4c6-cx" }, { "instance_id" : "1cf7357f931448f89229de664c114d05in07", "instance_name" : "gauss-wry-0710-3" }, { "instance_id" : "5280b1a667d142378fe28816afb2e4b8in07", "instance_name" : "taurus_WAkJSzVy" }, { "instance_id" : "56c6924923804259a1b15b846c6b4bf1in07", "instance_name" : "tck-update3" }, { "instance_id" : "72a8f4287e04427985087795825fcddain07", "instance_name" : "critBack" }, { "instance_id" : "c5df1dec75ed48ab85fe52c72ba784bbin07", "instance_name" : "gauss-f873-cx" } ] }
Código de estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.