QueryOrganizationWorkspaceList - Quick BI - Centro de documentación de Alibaba Cloud

Obtiene la lista de espacios de trabajo en la organización actual.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

quickbi-public:QueryOrganizationWorkspaceList

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Keyword	string	No	La palabra clave del nombre del espacio de trabajo.	application
PageNum	integer	No	El número de página de la lista de espacios de trabajo. Valor mínimo: 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de filas por página en una consulta paginada. Valor predeterminado: 10. Valor máximo: 1000.	10
UserId	string	No	El ID del usuario en Quick BI.	fe67f61a35a94b7da1a34ba174a7****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Success	boolean	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.	true
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	El resultado paginado de la lista de espacios de trabajo. La información detallada de los espacios de trabajo se almacena en el parámetro de respuesta Data.
Data	array<object>	La lista de espacios de trabajo.
	array<object>	La información del espacio de trabajo.
AllowPublishOperation	boolean	Indica si las obras pueden hacerse públicas. Valores válidos: true: Público. false: No público.	true
AllowShareOperation	boolean	Indica si las obras pueden compartirse con autorización. Valores válidos: true: Autorizado. false: No autorizado.	true
CreateTime	string	La hora en que se creó el espacio de trabajo.	2020-11-10 17:51:07
CreateUser	string	El ID de usuario de Quick BI del creador.	de4bc5f9429141cc8091cdd1c15b****
CreateUserAccountName	string	El nombre de la cuenta de Alibaba Cloud del creador.	pop****@aliyun.com
ModifiedTime	string	La hora de la última modificación del espacio de trabajo.	2020-11-10 17:51:07
ModifyUser	string	El ID de usuario de Quick BI del modificador.	de4bc5f9429141cc8091cdd1c15b****
ModifyUserAccountName	string	El nombre de la cuenta de Alibaba Cloud del modificador.	pop****@aliyun.com
OrganizationId	string	El ID de la organización a la que pertenece el espacio de trabajo.	2fe4fbd8-588f-489a-b3e1-e92c7af0****
Owner	string	El ID de usuario de Quick BI del propietario del espacio de trabajo.	de4bc5f9429141cc8091cdd1c15b****
OwnerAccountName	string	El nombre de la cuenta de Alibaba Cloud del propietario del espacio de trabajo.	pop****@aliyun.com
WorkspaceDescription	string	La descripción del espacio de trabajo.	Este espacio de trabajo es un espacio de trabajo de prueba
WorkspaceId	string	El ID del espacio de trabajo.	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	El nombre del espacio de trabajo.	Espacio de trabajo de prueba
RealOwnerAccountName	string	El nombre de la cuenta de Quick BI del propietario del espacio de trabajo.	test
WorkspaceExportConfig	object	La configuración de exportación del espacio de trabajo.
ExportMainSwitch	boolean	El interruptor principal para la exportación. Si se establece en false, todas las configuraciones de exportación siguientes no surten efecto.	true
ImageExport	boolean	Especifica si se permite exportar como imagen.	true
ExportToServer	boolean	Especifica si se permite exportar a un servidor.	true
DefaultExportType	boolean	El tipo de exportación predeterminado (con formato: true. Sin formato: false).	true
AllowExcelImageFile	boolean	Especifica cómo se manejan las imágenes al exportar archivos Excel con formato. Este campo solo surte efecto cuando se configura a nivel de organización. Valores válidos: false: Los campos de imagen no se convierten en imágenes. true: Los campos de imagen pueden convertirse en imágenes. La opción aparece en la página de exportación de informes y los usuarios deben seleccionarla manualmente para convertir las imágenes.	true
PdfExport	boolean	Especifica si se permite exportar como PDF.	true
ExportToPublicWork	boolean	Especifica si los enlaces públicos de las obras admiten exportación.	true
ExportToLocal	boolean	Especifica si se permite exportar a un dispositivo local.	true
DataExport	boolean	Especifica si se permite exportar datos como un archivo de Excel.	true
PageNum	integer	El número de página.	1
PageSize	integer	El número de filas por página especificado en la solicitud.	10
TotalNum	integer	El número total de filas.	1
TotalPages	integer	El número total de páginas.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AllowPublishOperation": true,
        "AllowShareOperation": true,
        "CreateTime": "2020-11-10 17:51:07",
        "CreateUser": "de4bc5f9429141cc8091cdd1c15b****",
        "CreateUserAccountName": "pop****@aliyun.com",
        "ModifiedTime": "2020-11-10 17:51:07",
        "ModifyUser": "de4bc5f9429141cc8091cdd1c15b****",
        "ModifyUserAccountName": "pop****@aliyun.com",
        "OrganizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
        "Owner": "de4bc5f9429141cc8091cdd1c15b****",
        "OwnerAccountName": "pop****@aliyun.com",
        "WorkspaceDescription": "该空间是测试空间",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试空间",
        "RealOwnerAccountName": "test",
        "WorkspaceExportConfig": {
          "ExportMainSwitch": true,
          "ImageExport": true,
          "ExportToServer": true,
          "DefaultExportType": true,
          "AllowExcelImageFile": true,
          "PdfExport": true,
          "ExportToPublicWork": true,
          "ExportToLocal": true,
          "DataExport": true
        }
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Invalid.Parameter.Error	The parameter is invalid:%s.	Parámetro no válido: %s.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.