CreateTicket - Quick BI: Central de Documentação do Alibaba Cloud

Gera um ticket necessário para o acesso a um relatório incorporado.

Descrição da operação

Para mais informações, consulte Melhoria de segurança para controle de permissão de dados e passagem de parâmetros em relatórios incorporados.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

quickbi-public:CreateTicket

create

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
WorksId	string	Sim	O ID do relatório para o qual a incorporação está ativada. Há suporte para painéis, pastas de trabalho, telas de dados, consultas ad hoc, análises ad hoc e formulários de entrada de dados.	a206f5f3-****-e9b17c835b03
CmptId	string	Não	O ID do componente. Este é o ID de um componente específico no painel. Não há suporte para outros tipos de relatório. Para obter o ID do componente, consulte QueryWorksBloodRelationship.	0fc6a275c7f64f17b1****a306ce0f31
TicketNum	integer	Não	O número de vezes que o ticket pode ser usado. Cada vez que o ticket é usado para acesso, a contagem diminui em 1. Valor padrão: 1. Valor recomendado: 1. Valor máximo: 99999.	1
UserId	string	Não	O ID de usuário do Quick BI, não o ID da sua conta Alibaba Cloud. Você pode chamar a operação QueryUserInfoByAccount para obter o ID do usuário. Exemplo: fe67f61a35a94b7da1a34ba174a7**. Nota** Especifique UserId ou AccountName. Se nenhum for especificado, o proprietário do relatório será usado por padrão, e o relatório será acessado sob a identidade desse usuário. Para configurar permissões no nível de linha para dados, consulte Permissões no nível de linha.	46e537466****92704c8
AccountName `deprecated`	string	Não	O nome da conta do usuário. Se o usuário for uma conta Alibaba Cloud wangwu, o formato é [conta primária], por exemplo, wangwu. Se o usuário for uma conta de usuário do Resource Access Management (RAM) zhangsan@aliyun.cn, o formato é [conta primária:usuário RAM], por exemplo, wangwu:zhangsan. Nota** Especifique UserId ou AccountName. Se nenhum for especificado, o proprietário do relatório será usado por padrão, e o relatório será acessado sob a identidade desse usuário. Para configurar permissões no nível de linha para dados, consulte Permissões no nível de linha.	test
AccountType `deprecated`	integer	Não	O tipo de conta do usuário. Valores válidos: 1: Conta Alibaba Cloud 3: Conta personalizada do Quick BI 4: DingTalk 5: Usuário RAM 9: WeCom 10: Lark Nota Se AccountName for especificado, AccountType também deverá ser especificado.	1
ExpireTime	integer	Não	O tempo de expiração. Unidade: minutos. Valor padrão: 240.	200
WatermarkParam	string	Não	O parâmetro de marca d'água para o relatório. O valor não pode exceder 50 caracteres. Não há suporte para parâmetros de marca d'água quando o tipo de relatório é tela de dados.	ticket embed
GlobalParam	string	Não	O parâmetro global.	[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	string	O valor do ticket gerado.	ccd3428c-**-**-a608-26bae29dffee
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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.
400	Authorize3Rd.Report.Unauthorized	The report is not enabled for third party embedding.
400	Cube.Not.Exist	The Cube does not exist.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.
400	Report.NotExist	The dashboard does not exist.
400	Organization.Workspace.Inconformity	The workspace does not match the 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.
400	NoPermissionTo.Operate.Object	You are not authorized to operate the objects.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.