Todos los productos
Search
Centro de documentos

Quick BI:UpdateDataSource

Última actualización: Sep 01, 2026

Modifica una configuración de origen de datos.

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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

UpdateModel

string

Sí

Una cadena con formato JSON que define la configuración del origen de datos que se va a actualizar. Consulte el ejemplo para conocer el formato específico. La cadena JSON incluye los siguientes parámetros:

  • dsId: Obligatorio. El ID del origen de datos.

  • userId: Opcional. El ID de usuario de Quick BI del usuario que modifica el origen de datos. Si especifica este parámetro, la actualización se ejecuta como este usuario.

  • dsType: Obligatorio. El tipo del origen de datos. Este valor no se puede cambiar y debe coincidir con el tipo de origen de datos existente.

  • showName: Opcional. El nombre para mostrar del origen de datos.

  • address: Opcional. El endpoint de conexión de la base de datos, que puede ser un nombre de dominio o una dirección IP.

  • port: Opcional. El puerto de conexión para la base de datos.

  • schema: Opcional. El esquema de la base de datos. Este parámetro es obligatorio solo para los tipos de bases de datos que admiten esquemas. Por ejemplo, el esquema predeterminado para SQL Server es dbo, mientras que MySQL no utiliza esquemas.

  • instance: Opcional. La instancia de la base de datos.

  • username: Opcional. El nombre de usuario de la cuenta de la base de datos o el AccessKey ID.

  • password: Opcional. La contraseña de la cuenta de la base de datos.

  • resource: Especifica el tipo de VPC. Este parámetro es obligatorio si utiliza una conexión VPC. Si el origen de datos se creó con configuraciones de VPC, debe incluir este parámetro en su solicitud de actualización. Omitir este parámetro en la solicitud deshabilita la conexión VPC. Para obtener una lista de valores de resource, consulte la sección Información adicional a continuación.

  • accessId: Opcional. El AccessKey ID para la instancia VPC. Este parámetro es obligatorio si se especifica el parámetro resource.

  • accessKey: Opcional. El AccessKey secret para la instancia VPC. Este parámetro es obligatorio si se especifica el parámetro resource.

  • instanceId: Opcional. El ID de la instancia VPC. Este parámetro es obligatorio si se especifica el parámetro resource.

  • region: Opcional. La región donde se encuentra la instancia VPC. Este parámetro es obligatorio si se especifica el parámetro resource. Para obtener una lista de ID de regiones, consulte la sección Información adicional a continuación.

  • config: Opcional. Un objeto JSON que contiene parámetros de configuración adicionales para la base de datos. Solo necesita incluir los campos que desea actualizar. Cualquier campo que incluya se actualiza al nuevo valor, incluso si es una cadena vacía. Los campos que no se incluyen en la solicitud permanecen sin cambios.

{ "schema": "schema", "userId":"S*****46345", "password": "Ta****34", "showName": "test", "address": "11*****.55", "instance": "quickbi_test", "dsId": "34d6d******3ca8ac267", "port": "3306", "dsType": "mysql", "username": "root", "config": { "initialSql": "Set timezone = '-10'" } }

Código de ejemplo @Test

public void UpdateDataSource () throws SDKException, ClientException {
    UpdateDataSourceRequest request = new UpdateDataSourceRequest();
    HashMap<String,Object> updateModel = new HashMap<>();
    updateModel.put("dsId", "342e*******455");
    updateModel.put("userId","74f5*****20ebf278c8");
    updateModel.put("dsType", "impala");
    updateModel.put("address", "12***22");
    updateModel.put("instance", "default");
    updateModel.put("showName", "wk***_update");
    request.setUpdateModel(JSONObject.toJSONString(updateModel));
    System.out.println(JSONObject.toJSONString(updateModel));
    request.setSysConnectTimeout(60000);request.setSysReadTimeout(60000);
    UpdateDataSourceResponse  acsResponse = getPopAPIClient("test").getAcsResponse(request);

    System.out.println(JSONObject.toJSONString(acsResponse.getResult()));
}

Información adicional

Asignaciones de recursos
La siguiente tabla enumera los valores de resource para los tipos comunes de orígenes de datos. Si su origen de datos admite conexiones VPC pero no aparece en la lista, puede encontrar su valor de recurso mediante las herramientas de desarrollador de su navegador. Inspeccione la solicitud de red realizada al endpoint de la API detect cuando hace clic en Probar conexión en el editor de orígenes de datos. El valor se encuentra en el campo config.resource de la carga útil de la solicitud.

















  • Servicios de Alibaba Cloud (como ApsaraDB RDS): rds

  • AnalyticDB for MySQL: adb

  • AnalyticDB for PostgreSQL: gpdb

  • Hologres: hologres

  • ClickHouse: clickhouse

  • E-MapReduce Serverless StarRocks: starrocks

  • PolarDB for MySQL: polardb

  • PolarDB-X: drds

  • PolarDB for PostgreSQL: polardb

  • PolarDB for PostgreSQL (compatible con Oracle): polardb

  • SelectDB: selectdb

  • OceanBase: oceanbase

  • Lindorm: lindorm

  • Alibaba HybridDB for MySQL: petaData

  • HBase: hbase

  • Orígenes de datos autogestionados y orígenes de datos de Huawei Cloud: ecs

  • AWS, Microsoft Azure, Tencent Cloud y Google Cloud: rds

  • TDSQL-H LibraDB: tdsql

  • Dataphin: api_gateway

Asignaciones de regiones

  • China (Qingdao): cn-qingdao

  • China (Beijing): cn-beijing

  • China (Zhangjiakou): cn-zhangjiakou

  • China (Hohhot): cn-huhehaote

  • China (Ulanqab): cn-wulanchabu

  • China (Hangzhou): cn-hangzhou

  • China (Shanghai): cn-shanghai

  • China (Nanjing-Local Region): cn-nanjing

  • China (Shenzhen): cn-shenzhen

  • China (Heyuan): cn-heyuan

  • China (Guangzhou): cn-guangzhou

  • China (Fuzhou-Local Region): cn-fuzhou

  • China (Wuhan-Local Region): cn-wuhan-lr

  • China (Chengdu): cn-chengdu

  • China (Hong Kong): cn-hongkong

  • Japón (Tokio): ap-northeast-1

  • Corea (Seúl): ap-northeast-2

  • Singapur: ap-southeast-1

  • Malasia (Kuala Lumpur): ap-southeast-3

  • Filipinas (Manila): ap-southeast-6

  • Indonesia (Yakarta): ap-southeast-5

  • Tailandia (Bangkok): ap-southeast-7

  • EE. UU. (Virginia): us-east-1

  • EE. UU. (Silicon Valley): us-west-1

  • México (Querétaro): na-south-1

  • Reino Unido (Londres): eu-west-1

  • Emiratos Árabes Unidos (Dubái): me-east-1

  • Alemania (Fráncfort): eu-central-1

Elementos de la respuesta

Elemento

Tipo

Descripción

Ejemplo

object

El contenedor para los datos devueltos.

RequestId

string

El ID de la solicitud.

D787E1A***********5DF8D885

Result

boolean

El resultado de la operación. Valores válidos:

  • true: La operación fue exitosa.

  • false: La operación falló.

true

Success

boolean

Indica si la solicitud fue exitosa. Valores válidos:

  • true: La solicitud fue exitosa.

  • false: La solicitud falló.

true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D787E1A***********5DF8D885",
  "Result": true,
  "Success": true
}

Códigos de error

Código de estado HTTP

Código de error

Mensaje de error

Descripción

400 Internal.System.Error An internal system error occurred. An internal system error occurred.
400 Invalid.Parameter.Error The parameter is invalid:%s. invalid parameter: ${0}.
400 User.NotIn.Workspace The user is not a member of the group workspace. The user is not a member of the group workspace.
400 NoPermissionTo.Operate.Object You are not authorized to operate the objects. You are not authorized to do this.
400 DatasourceId.IsNull.Error You must select a data source before selecting the table. You must select a data source before selecting the table.
400 Datasource.NotFound.Error The specified data source does not exist: %s. The specified data source does not exist: %s.
400 Name.RegularExpression.Error Name format validation failed.
400 NameExceeded.MaxLength.Error The name cannot exceed %s characters in length. The name cannot be longer than% s characters.
400 Database.PortInvalid.Error The database port is invalid. The database port is invalid.
400 VpcInstance.Info.Error Get vpc instance info error.please check vpc config %s. Get VPC instance info error.please check VPC config %s.
400 VpcInstance.Info.EmptyError Not found instance. please check vpc config and authorization %s. Not found instance. please check VPC config and authorization %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.