# Alibaba Cloud DataAnalysisGBI API

> Alibaba Cloud DataAnalysisGBI API on Apizie: 30 endpoints (Delete synonyms in bulk from the specified workspace, Cancels authorization for an associated data source, Creates a business logic definition in the specified workspace, Creates an authorization to associate a data source with a specified workspace. After the association is…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dataanalysisgbi`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dataanalysisgbi
- Page: https://www.apizie.tech/api/cloud/aliyun-dataanalysisgbi
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-dataanalysisgbi/openapi.json

Alibaba Cloud OpenAPI for DataAnalysisGBI (dataanalysisgbi, version 2024-08-23). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Delete synonyms in bulk from the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/batch-delete-synonyms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| synonymIdKeys | array | yes | List of synonym IDs to delete |

### Cancels authorization for an associated data source
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/cancel-datasource-authorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |

### Creates a business logic definition in the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/create-business-logic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Model Studio workspace for the current request |
| description | string | no | The content of the business logic explanation |
| type | integer | no | The type of the business logic explanation to create |

### Creates an authorization to associate a data source with a specified workspace. After the association is…
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/create-datasource-authorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace for the current request |
| password | string | no | The password for the username to log on to the data source |
| type | integer | yes | The type of the data source to associate |
| url | string | no | The JDBC connection string of the data source to create |
| userName | string | no | The username to log on to the data source |
| vdbId | string | no | The instance ID of the virtual data source. Specify this parameter only when you associate a virtual data source |

### Creates a synonym in the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/create-synonyms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace for the request |
| columns | array | no | To associate the synonym with a specific column in a data table, specify the column name in the table_name.column_name format |
| word | string | yes | The synonym |
| wordSynonyms | array | yes | A list of words to map to the synonym |

### Creates a virtual data source instance in the specified workspace. This instance represents a virtual…
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/create-virtual-datasource-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace for the current request |
| description | string | no | The description of the virtual data source instance |
| name | string | no | The name of the virtual data source instance |
| type | integer | no | The type of the virtual data source |

### Delete a business logic definition from the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/delete-business-logic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| businessLogicIdKeys | array | yes | List of unique identifiers for the business logic definitions to delete |

### Delete a column from the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/delete-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace used for this request |
| columnIdKey | string | yes | The unique identifier of the column to delete |

### Deletes the specified data table from the designated workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/delete-selected-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace for the current request |
| tableIdKey | string | yes | The unique identifier for the data table |

### Deletes a virtual data source instance in the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/delete-virtual-datasource-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| vdbId | string | yes | ID of the virtual data source instance |

### Lists the definitions of enterprise knowledge terms in the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/list-business-logic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| maxResults | integer | no | Maximum number of entries per page |
| nextToken | string | no | Pagination token. Omit this parameter for the first call. For subsequent calls, use the nextToken value returned in the previous response |

### Retrieve column information for a specified table in the current workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/list-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| maxResults | integer | no | Maximum number of entries per page |
| nextToken | integer | no | Paging token Omit this parameter for the first call For subsequent calls, use the nextToken value returned in the previous response |
| tableIdKey | string | yes | Unique identifier of the data table |

### Retrieve enumeration values for the specified table and column within the current workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/list-enum-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace used for the current request |
| columnIdKey | string | yes | The unique identifier ID of the data column |
| tableIdKey | string | yes | The unique identifier ID of the data table |

### Retrieve the data tables associated with the current workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/list-selected-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace used for the current request |
| maxResults | integer | no | Maximum number of entries per page |
| nextToken | string | no | Paging cursor. If this is the first call, do not pass this parameter. For subsequent calls, pass the nextToken returned from the previous… |

### Lists synonyms in a specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/list-synonyms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace for the current request |
| maxResults | integer | no | The maximum number of entries to return on each page |
| nextToken | string | no | The paging cursor. If this is your first call, do not include this parameter. For subsequent calls, set this parameter to the nextToken… |

### Retrieve the list of data source instances in the current workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/list-virtual-datasource-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The Alibaba Cloud Model Studio workspace ID used for the current request |
| maxResults | integer | no | Maximum number of entries per page |
| nextToken | string | no | Paging cursor. If this is the first call, do not pass this parameter. If this is not the first call, pass the \`nextToken\` returned by… |

### Restores a data column in a specified data table to its initial state
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/recover-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| columnIdKey | string | yes | Unique ID of the data column |
| tableIdKey | string | yes | Unique ID of the data table |

### Refreshes information about the associated data table from the remote database
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/resync-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The Alibaba Cloud Model Studio workspace ID used in the current request |
| keep | string | no | Enable "Keep and Add." Set to true to enable. Keep and Add: For tables with this option enabled, Xiyan retains information about already… |
| tableIdKey | string | yes | The unique identifier of the data table |

### Xianyan provides you with OpenAPI operations that deliver the same conversational experience as the official…
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/run-data-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The Alibaba Cloud Model Studio workspace ID used for the current request |
| agentCtrlParams | string | no | Custom parameters passed through by the current conversation API. Currently supported options include: skip rewriting, skip visualization… |
| dataRole | array | no | A list of database permission role names. You must configure the relevant database permission settings on the product page before you can… |
| generateSqlOnly | string | no | The current request only generates and returns SQL without executing it |
| query | string | yes | The query input by the user |
| sessionId | string | no | The message session ID returned in the service window callback message |
| specificationType | string | no | The version to use for the current request. If not specified, the default workspace version is used |
| userParams | string | no | Custom parameters on which the data role depends. If the role is configured with external parameters, these must be provided. You must… |

### Analyze the execution results of structured data types and generate visualization information.
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/run-data-result-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The Alibaba Cloud Model Studio workspace ID used for the current request |
| analysisMode | string | no | The type of visualization to execute. You can generate only a chart or only a text analysis |
| requestId | string | yes | Request ID. This request ID must be the one returned by the RunSqlGeneration API. If a request ID that has not been executed by… |
| sqlData | object | no | The structured data content retrieved after executing the SQL query. This parameter is required in the current scenario. Sample sqlData {… |

### This operation generates SQL statements based on the current query information and associated data tables.…
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/run-sql-generation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace used for the current request |
| query | string | yes | The query entered by the user |
| sessionId | string | no | The message session ID. Multiple request IDs can belong to the same session ID |
| specificationType | string | no | The version information specified for the current request. If empty, the default workspace version is used |

### Add DDL statements to a virtual data source instance in your current workspace. Alibaba Cloud GBI parses…
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/save-virtual-datasource-ddl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| ddl | string | yes | A CREATE DDL statement for a database. You can pass multiple statements. Separate them with line feeds ( ) |
| vdbId | string | yes | ID of the virtual data source instance |

### Update the data tables associated with your workspace by syncing the latest tables from a remote virtual…
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/sync-remote-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| keepTableNames | array | no | List of table names to keep and add columns for during association. Keep and add: For tables marked as Keep and Add, the system retains… |
| noModifiedTableNames | array | no | List of table names to keep and skip column updates for during association. Keep and skip: For tables marked as Keep and Skip, the system… |
| pullSamples | string | no | Whether to pull sample data when associating tables |
| tableNames | array | yes | List of names of tables to associate |

### Update a business logic description in the specified Alibaba Cloud Model Studio workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/update-business-logic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| businessLogicIdKey | string | yes | Unique ID of the business logic description |
| description | string | yes | Content of the business logic description |
| type | integer | yes | Type of the business logic description |

### Updates column information in the specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/update-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| chineseName | string | no | Chinese name of the column |
| columnIdKey | string | yes | Unique ID of the column |
| description | string | no | Description of the column |
| enumType | integer | yes | Indicates whether the field is an enumeration type. If set to 1, you can provide values in the enumValues field |
| enumValues | array | no | List of enumeration values |
| rangeMax | integer | no | Maximum value for numeric data |
| rangeMin | integer | no | Minimum value for numeric data |
| samples | array | no | List of sample data values. This field populates automatically if you enable sample data pull when associating a table |
| tableIdKey | string | yes | Unique ID of the table |

### Modifies the enumeration mapping for a specified column in a workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/update-enum-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Alibaba Cloud Model Studio workspace for the current request |
| columnIdKey | string | yes | The unique ID of the data column |
| enumMapping | object | no | The value mapping for the enumeration |
| tableIdKey | string | yes | The unique ID of the data table |

### Update synonym information in the current workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/update-synonyms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used for this request |
| columns | array | no | Column names to associate with this synonym, in table.column format |
| synonymIdKey | string | yes | Unique ID of the synonym |
| word | string | yes | The synonym term |
| wordSynonyms | array | yes | List of terms to map to this synonym |

### Updates information for a specified data table
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/update-table-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | ID of the Alibaba Cloud Model Studio workspace used in this request |
| description | string | no | Description of the data table |
| foreignKeys | array | no | List of foreign key relationships for this table, formatted as "table_name.column_name=table_name.column_name" |
| primaryKey | string | no | Primary key field |
| tableIdKey | string | yes | Unique ID of the data table |

### Updates the information of a virtual data source in a specified workspace
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/update-virtual-datasource-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |
| workspaceId | string | no | ID of the Alibaba Cloud Model Studio workspace used for this request |
| description | string | no | Description of the virtual data source |
| name | string | no | Name of the virtual data source |
| type | integer | no | Type of the virtual data source |
| vdbId | string | yes | ID of the virtual data source instance |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/batch-delete-synonyms" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud DataAnalysisGBI API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-dataanalysisgbi/batch-delete-synonyms with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud DataAnalysisGBI API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud DataAnalysisGBI itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud DataAnalysisGBI API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dataanalysisgbi.

### What is the status of the Alibaba Cloud DataAnalysisGBI API?
Needs your own provider key (bring your own key)