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

Consulta la lista de objetos con los que se ha compartido un trabajo y devuelve solo las configuraciones de uso compartido que aún están dentro de su período de validez.

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:QueryShareList

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ReportId	string	Sí	El ID del trabajo. Los trabajos incluyen portal de datos, panel de control, hoja de cálculo, recuperación de datos de autoservicio, análisis ad hoc, entrada de datos y pantalla de datos.	6b407e50-e774-406b-9956-da2425c2****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Success	boolean	Indica si la solicitud fue exitosa. Valores posibles: true: La solicitud fue exitosa. false: La solicitud falló.	true
RequestId	string	El ID de la solicitud.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	array<object>	Devuelve la lista de objetos con los que se ha compartido el trabajo.
	object
AuthPoint	integer	Permisos de uso compartido. Valores posibles: 1: Solo visualización 3: Visualización y exportación	3
ExpireDate	integer	La marca de tiempo en milisegundos que indica la hora de vencimiento de la autorización.	1640102400000
ReportId	string	El ID del trabajo.	6b407e50-e774-406b-9956-da2425c2****
ShareId	string	El ID de la configuración de uso compartido.	0ab9659e-29cf-47d7-a364-3a91553b****
ShareToId	string	El ID del destino de uso compartido, que puede ser un ID de usuario o un ID de grupo en Quick BI. Cuando ShareToType=2 (todos los miembros de una organización), ShareToId es el ID de la organización.	95296e95-ca89-4c7d-8af9-dedf0ad0****
ShareToName	string	El nombre del destino de uso compartido.	小张
ShareToType	integer	El tipo de uso compartido. Valores posibles: 0: Usuario 1: Grupo 2: Organización 3: Espacio	0
ShareType	string	El tipo de trabajo compartido. El rango de valores incluye: dataProduct: Portal de datos dashboard: Panel de control report: Hoja de cálculo dashboardOfflineQuery: Extracción de datos de autoservicio ANALYSIS: Análisis ad hoc DATAFORM: Entrada de datos SCREEN: Pantalla de visualización de datos	dashboard

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "AuthPoint": 3,
      "ExpireDate": 1640102400000,
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ShareId": "0ab9659e-29cf-47d7-a364-3a91553b****",
      "ShareToId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "ShareToName": "小张",
      "ShareToType": 0,
      "ShareType": "dashboard"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %s.	This work does not exist. It may have been deleted. Work ID is %s.
400	Workspace.Not.Exist	The group workspace does not exist.	The group workspace does not exist.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.

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.