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

delete

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorksId	string	Sí	El ID de la obra cuya recopilación se va a cancelar.	5d6ae4e7-cede-43cd-b4d3-d2fd442a9202
UserId	string	Sí	El ID del usuario que marcó como favorito. El ID de usuario es el UserID de Quick BI, no el UID de Alibaba Cloud.	121344444790****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	7c7223ae-****-3c744528014b
Result	boolean	Se devuelve el resultado de ejecución de la interfaz. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
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": "7c7223ae-****-3c744528014b",
  "Result": true,
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	Favorite.NotCancel.Permission	You have not added this work to favorites.
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %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.