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

Descripción de la operación

Cuando modifica una sentencia de consulta, solo puede modificar el JsonObject de nivel superior. No puede modificar parámetros anidados en múltiples niveles. Para obtener más información sobre los parámetros, consulte Crear un origen de datos de API.

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

update

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ApiId	string	Sí	El ID del origen de datos de API.	b66a66de51f24d149116c17718138194
WorkspaceId	string	Sí	El ID del espacio de trabajo.	726bee5a-****-43e1-9a8e-b550f0120f35
Parameters	string	Sí	La configuración de los parámetros de datos de la API en formato JSONArray. Puede modificar un máximo de 10 parámetros. name: el nombre de un parámetro común o de un parámetro en una sentencia de consulta. value: el valor de un parámetro común o de un parámetro en una sentencia de consulta.	[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La información devuelta.
RequestId	string	El ID de la solicitud.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	boolean	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": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": true,
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	ApiDataSource.NotIn.Workspace	Target apiId not in target workspace.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	ApiDatasource.Not.Exist	Api datasource not exist.
400	ApiDatasource.Param.IsNull	Api datasource modify parameters is null.
400	ApiDatasource.Param.Oversize	The number of parameters of API data source exceeds the limit and cannot exceed %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.