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

Genera un ticket necesario para el acceso a reportes incrustados.

Descripción de la operación

Para obtener más información, consulte Mejora de seguridad para el control de permisos de datos y el paso de parámetros en reportes incrustados.

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

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorksId	string	Sí	El ID del reporte para el que está habilitada la incrustación. Se admiten paneles, libros de trabajo, pantallas de datos, consultas ad hoc, análisis ad hoc y formularios de entrada de datos.	a206f5f3-****-e9b17c835b03
CmptId	string	No	El ID del componente. Este es el ID de un componente específico dentro del panel. No se admiten otros tipos de reportes. Para obtener el ID del componente, consulte QueryWorksBloodRelationship.	0fc6a275c7f64f17b1****a306ce0f31
TicketNum	integer	No	El número de veces que se puede utilizar el ticket. Cada vez que se utiliza el ticket para acceder, el recuento disminuye en 1. Valor predeterminado: 1. Valor recomendado: 1. Valor máximo: 99999.	1
UserId	string	No	El ID de usuario de Quick BI, no el ID de su cuenta de Alibaba Cloud. Puede llamar a la operación QueryUserInfoByAccount para obtener el ID de usuario. Ejemplo: fe67f61a35a94b7da1a34ba174a7**. Nota** Especifique UserId o AccountName. Si no se especifica ninguno, se utiliza el propietario del reporte de forma predeterminada y se accede al reporte con la identidad de ese usuario. Para configurar permisos a nivel de fila para los datos, consulte Permisos a nivel de fila.	46e537466****92704c8
AccountName `deprecated`	string	No	El nombre de la cuenta del usuario. Si el usuario es una cuenta de Alibaba Cloud wangwu, el formato es [cuenta principal], por ejemplo, wangwu. Si el usuario es una cuenta de usuario de Resource Access Management (RAM) zhangsan@aliyun.cn, el formato es [cuenta principal:usuario de RAM], por ejemplo, wangwu:zhangsan. Nota** Especifique UserId o AccountName. Si no se especifica ninguno, se asocia el propietario del reporte de forma predeterminada y se accede al reporte con la identidad de ese usuario. Para configurar permisos a nivel de fila para los datos, consulte Permisos a nivel de fila.	test
AccountType `deprecated`	integer	No	El tipo de cuenta del usuario. Valores válidos: 1: Cuenta de Alibaba Cloud 3: Cuenta personalizada de Quick BI 4: DingTalk 5: Usuario de RAM 9: WeCom 10: Lark Nota Si se especifica AccountName, también se debe especificar AccountType.	1
ExpireTime	integer	No	La hora de caducidad. Unidad: minutos. Valor predeterminado: 240.	200
WatermarkParam	string	No	El parámetro de marca de agua para el reporte. El valor no puede exceder los 50 caracteres. Los parámetros de marca de agua no se admiten cuando el tipo de reporte es pantalla de datos.	ticket embed
GlobalParam	string	No	El parámetro global.	[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	string	El valor del ticket generado.	ccd3428c-**-**-a608-26bae29dffee
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": "ccd3428c-****-****-a608-26bae29dffee",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Authorize3rdTicket.BindedWorks.Mismatch	The report bound by the ticket mismatches the actual report.
400	Authorize3rdTicket.Expired	Ticket [%s] has expired.
400	Authorize3rdTicket.HasNo.LoginToken	The request [%s] has no token.
400	Authorize3rdTicket.NotExist	Ticket %s does not exist.
400	Authorize3rdTicket.Num.Exceed	The number of tickets %s is invalid.
400	Authorize3rdTicket.Num.HasNoLeft	There is no ticket number left, please generate new ticket.
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	Authorize3Rd.Report.Unauthorized	The report is not enabled for third party embedding.	This report is not enabled for 3rd party embedding.
400	Cube.Not.Exist	The Cube does not exist.	The Cube does not exist.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.	The specified data source does not exist: %s.
400	Report.NotExist	The dashboard does not exist.	The current work does not exist.
400	Organization.Workspace.Inconformity	The workspace does not match the organization.	workspace inconformity with organization.
400	Parameter.Length.Exceed	Parameter length exceeds maximum limit: [%s].
400	GlobalParam.Restricted.Use	The global parameter function is restricted in your version.
400	Authorize3rdTicket.Unsupport.ScreenWatermark	Screen embed does not support watermark parameters.	Screen embed does not support watermark parameters.
400	NoPermissionTo.Operate.Object	You are not authorized to operate the objects.	You are not authorized to do this.

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.