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

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

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
CopilotId	string	Sí	El ID del módulo de Copilot integrado.	ccd3428c-dd23-460c-a608-26bae29dffee
TicketNum	integer	No	El número de veces que se puede utilizar el ticket. El valor puede oscilar entre 1 y 99,999. Valor predeterminado: 1. Recomendado: 1. Máximo: 99,999. Cada acceso reduce el recuento de uso del ticket en uno.	1
UserId	string	No	El ID del usuario de Quick BI. Este no es su ID de cuenta de Alibaba Cloud. Llame a la operación QueryUserInfoByAccount para obtener el ID de usuario. Ejemplo: `fe67f61a35a94b7da1a34ba174a7**`. Importante** Nota: Especifique UserId o AccountName. Si deja ambos parámetros vacíos, el ticket se vincula al llamador de la API de forma predeterminada. A continuación, se concede el acceso según la identidad del llamador.	9c-asdawf-casxcasd-asdasd
AccountName	string	No	El nombre de la cuenta de usuario. Importante Nota: Especifique UserId o AccountName. Si deja ambos parámetros vacíos, el ticket se vincula al llamador de la API de forma predeterminada. A continuación, se concede el acceso según la identidad del llamador.	测试用户
AccountType	integer	No	El tipo de cuenta de usuario: 1: Cuenta de Alibaba Cloud 3: Usuario de Quick BI 4: DingTalk 5: Usuario de RAM 6: Cuenta de terceros (una cuenta integrada mediante protocolos como SAML u OAuth) 9: WeCom 10: Lark Importante Nota: Este parámetro es obligatorio si especifica AccountName.	1
ExpireTime	integer	No	La hora de caducidad del ticket. Unidad: minutos. El periodo de validez máximo es de 240 minutos (4 horas). Valor predeterminado: 240 minutos.	200

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 ticket generado.	f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
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": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	CopilotEmbed.Config.NotFind	Can not find copilot embed config with this copilot ID.	Cannot find this embedded configuration
400	Authorize3rdTicket.Num.HasNoLeft	There is no ticket number left, please generate new ticket.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Authorize3rdTicket.Num.Exceed	The number of tickets %s is invalid.

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.