Quick BI:Crear una API

Procedimiento

Para crear una API en DataService Studio:

1. En la página principal de Quick BI, cree una nueva API como se muestra a continuación.

   

2. En la página Create API > Basic Information Configuration, introduzca el API Name, el Interface Workspace, el Interface Dataset, el Data Return Type y la API Description; luego, haga clic en Next.

3. En la página Create API > Add API Parameters, configure los parámetros de solicitud y de retorno; luego, haga clic en Save o en Save And Debug.

   Nota

   Save almacena la configuración actual. Save And Debug lo dirige a la página Debug API.

4. Haga clic en Save And Debug para abrir la página Debug API. Introduzca los valores de los parámetros y seleccione los parámetros de retorno.

5. Haga clic en Run Debug. La página Debug Results muestra el Returned JSON y la Data Preview.

   Nota

   Para invocar una API de DataService Studio, la cuenta de Alibaba Cloud que realiza la llamada debe tener los roles de administrador de organización y administrador de permisos de Quick BI, y debe haber accedido a Quick BI como mínimo una vez.

Operaciones relacionadas

Después de crear una API, puede consultar su ID, nombre, conjunto de datos y espacio de trabajo en el módulo DataService Studio. Las APIs y operaciones disponibles dependen de la pestaña seleccionada.

• La pestaña My enumera todas las APIs que usted creó. Operaciones disponibles:

  • View

    Haga clic en el icono junto al ID de la API para consultar la Basic Information, los Request Parameters y los Return Parameters. Desde esta ventana también puede Edit, Debug, Delete o Transfer la API.

  • Edit

    Haga clic en el icono para abrir la página Edit API. Modifique la Basic Information y la Parameter Information; luego, haga clic en Save o en Save and Test.

  • Debug

    Haga clic en el icono para abrir la página Debug API. Actualice los parámetros y haga clic en Run Debug.

  • Statistics

    Haga clic en el icono para consultar los datos de llamadas en la página API Call Statistics > Details. API call statistics.

  • Transfer

    Haga clic en el icono . En la página Transfer API > Creator, seleccione el nuevo creador y haga clic en Confirm.

    Nota

    El rol de creador incluye permisos de llamada y gestión de la API de forma predeterminada.

    

  • Delete

    Haga clic en el icono y luego haga clic en Confirm para eliminar la API.

• La pestaña All enumera todas las APIs del inquilino actual.

  • APIs que usted creó: Puede gestionarlas y consultar sus detalles. Las operaciones son las mismas que en la pestaña My.

  • APIs creadas por otros usuarios: Solo puede consultar los detalles. Las operaciones de gestión no están disponibles.