Guías de integración › Guía de referencia de API de servicio Web › Sintaxis genérica de la API

Sintaxis genérica de la API

Para iniciar una solicitud de API para un objeto, utilice un comando con el formato siguiente:

GET "http://ws-ip/api/v1/obj/method?arg1=<value>&arg2=<value>&vdc=<grid>"

Donde:: ws-ip es la dirección IP que se utiliza para acceder a la aplicación "WS_API".
object es un objeto de API, como app, class, etc.
method es la acción que se tiene que realizar para el objeto, como inicio, detención, etc.
arg1, arg2 son los argumentos que se envían al método.
vdc es el nombre del controlador de grid.
Notes

Sintaxis de una opción con valor: una opción con valor se expresa generalmente con el formato siguiente:
```
<property_name>=<value>
```
El valor debe estar codificado mediante URI (código por ciento del Identificador uniforme de recursos), según las reglas específicas del componente de ruta del URI. Reemplace cualquier carácter reservado para el campo de ruta de un URI (como por ciento, espacio y tabulador, igual, coma, barra diagonal delantera, interrogación y comillas simples y dobles) por su versión codificada por ciento %HH, donde HH es la representación de ASCII hexadecimal para el carácter que proceda.

Nota: Consulte RFC 3986 para obtener más detalles sobre la codificación mediante URI.

Sintaxis de indicador de opción: aunque la CLI utiliza un guión doble o raya (—) como prefijo para designar un indicador de opción (normalmente una opción sin un valor), la API de servicios Web todavía utiliza el ampersand (&) como prefijo en su lugar. Por lo tanto, donde la CLI usa --option, los servicios Web utilizarán &option. Por ejemplo, si la CLI usa --debug, la API de servicios Web utilizarán &debug.
Aunque las descripciones de solicitudes de API para un objeto incluyen todos los parámetros obligatorios, solamente incluyen algunos de los parámetros opcionales. Los parámetros opcionales no incluidos en esta guía se describen en la Guía de referencia del shell de la línea de comandos.

Ejemplo:

Obtener los métodos para el objeto app
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid

Ejemplo de salida:

{
   "method" : [
      {
         "name" : "config"
      },
      {
         "name" : "copy"
      },
      {
         "name" : "create"
      },
      {
         "name" : "destroy"
      },
      .
      .
      .
   ]
}

Formatos de salida

Los formatos de resultado aceptables pueden ser XML o JSON. Éstos se pueden especificar en la solicitud de API.

Ejemplo:

Obtención de los métodos para el objeto app en formato XML.

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/xml"

Obtención de los métodos para el objeto app en formato JSON.

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/json"

Nota: Todas las salidas en JSON se encuentran codificadas en UTF8. Utilice un descodificador de UTF8 para descodificar la salida de UTF8. A continuación se muestra un ejemplo de script PHP sencillo para descodificar la salida de JSON en UTF8:

<? 
$json ='{"a": "\u00e3\u0081\u0082"}'; 
$j = json_decode($json); 
eco utf8_decode($j->{'a'}); 
?>

Esta sección contiene los siguientes temas:

Tipos de argumentos habituales

Se puede utilizar el siguiente tipo de argumento genérico que es común para muchos comandos. Cuando se hace referencia a un tipo de argumento específico desde cualquier descripción de comando particular, utilice la siguiente información detallada siguiente para el tipo en cuestión.

<principal>

<principal> representa a una persona (ya sea un individuo o un grupo), de un alcance dado, local o global. Especifique un elemento principal según una de las siguientes sintaxis posibles:

<nombre>: Usuario o grupo local.
/<name>: Usuario o grupo global.
<scope>:<type>:<name>: Un nombre completo del elemento principal donde <scope> sea global o local, <type> sea group o user y <name> sea el grupo o el nombre de usuario.

Nota: Un elemento principal debe ser una URL codificada. Por ejemplo, local:user:api@3tera.com se debería pasar como local%3Auser%3Aapi%403tera.com