Add a table for the table data connector.
Operation description
- RAM users (sub-accounts) must first obtain the API permissions for Chinese China Bailian (requires
AliyunBailianDataFullAccess, which includes the sfm:AddTable permission), and join a workspace before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest Chinese China Bailian SDK. - This API is not idempotent.
Try it now
Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.
Test
RAM authorization
The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:
-
Action: The actions can be used in the
Actionelement of RAM permission policy statements to grant permissions to perform the operation. - API: The API that you can call to perform the action.
- Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
-
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
- Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.
Action | Access level | Resource type | Condition key | Dependent action |
|---|---|---|---|---|
sfm:AddTable | create | *All Resource
| None | None |
Request syntax
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | The ID of the workspace to which the file belongs. For information about how to obtain the workspace ID, see How to use a workspace. | llm-3shx2gu255oqxxxx |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| TableName | string | Yes | The table name. | ads_wjjr_basc_enterprise_di |
| TableDesc | string | No | The table description. | table description |
| ConnectorId | string | Yes | The connector ID. | connector-d51861492df64257 |
| TableColumns | array<object> | Yes | The column information of the table. | |
object | Yes | The information of a single column. | ||
| ColumnName | string | Yes | The column name. | column1 |
| ColumnDesc | string | No | The column description. | desc |
| DataType | string | Yes | The data type. | string |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | The error status code. | Index.Forbidden |
| Data | object | The returned data. | |
| TableId | string | The table ID. | table_b6ddc67e7df14db38b74ef5e2e0fe24e_12792097 |
| Message | string | The error message. | Required parameter(%s) missing or invalid, please check the request parameters. |
| RequestId | string | The request ID. | 778C0B3B-03C1-5FC1-A947-36EDD13606AB |
| Status | string | The status code returned by the interface. | 200 |
| Success | boolean | Indicates whether the API call was successful. Valid values:
| True |
Examples
Success response
JSON format