Lists synonyms in a specified workspace.
Debug
You can run this API directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After a successful run, OpenAPI Explorer can automatically generate SDK code examples.
Debug
RAM authorization
The following table describes the authorization information for this API. You can use the Action element in RAM permission policy statements to grant RAM users or RAM roles the permission to call this API. For more information, see the following:
- Operation: the specific permission point.
- Access level: the access level of each operation. Valid values: Write, Read, or List.
-
Resource type: the resource types that support authorization for the operation. For more information:
- For required resource types, an asterisk (*) is prefixed.
- For operations that do not support resource-level authorization, All Resources is used.
- Condition key: the condition keys defined by the cloud service itself.
- Dependent action: other permissions required to perform the operation. The caller must have the permissions of all dependent actions for the operation to succeed.
| Operation | Access level | Resource type | Condition key | Dependent action |
|---|---|---|---|---|
| dataanalysisgbi:ListSynonyms | none | *All resources * |
| None |
Request syntax
Request parameters
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| workspaceId | string | Yes | The ID of the Alibaba Cloud Model Studio workspace for the current request. | llm-2v3934xtp49esw64 |
| body | object | No | The request body parameters. | |
| nextToken | string | No | The paging cursor.
| e8Z0nRyY51ZQmYljqGNK |
| maxResults | long | No | The maximum number of entries to return on each page. | 10 |
Response elements
| Element | Type | Description | Example value |
|---|---|---|---|
| object | Result | ||
| data | any | The returned information. | { "data": { "data": [ { "gmtModified": 1734401404000, "columns": [ "test.id", "user_info.createdt" ], "synonymIdKey": "synonyms-AAAAAAAAAVLaD8z63NnFhA", "wordSynonyms": [ "1" ], "workSpaceId": "10024809", "gmtCreate": 1734401404000, "word": "1", "status": 1 } ], "nextToken": "k1BLjEN114wyfrhDHoJlbg==", "totalCount": 0 } } |
| errorMsg | string | The error description. | NoAuth |
| code | string | The error code. | NoAuth |
| success | boolean | Indicates whether the call was successful. A value of true indicates success, and a value of false indicates failure. | true |
| requestId | string | The request ID. Each request has a unique ID, which helps with troubleshooting. | D02D895A-5E58-5A9F-963D-D8B027AB7AE2 |
Examples
Success response
JSON format
Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 401 | Internal.Error | Bad Request: Internal Error. | Internal error. Contact customer service personnel for troubleshooting. |
| 401 | NoAuth | Bad Request: Workspace.Illegal.Auth. | The current account does not have the permission to the specified business space. |
| 401 | NoResourceAuth | Bad Request: Resource Auth Error. | You do not have permission for the requested resource. Make sure that the requested resource belongs to the business space in the current parameter. |
| 401 | SystemOperationInProgress | Xiyan GBI is learning your previous modifications. Please try again later. | Xiyan GBI is learning your previous modifications. Please try again later. |