Query service information
Usage notes
This API is used with the Table Q&A service. Call this API to retrieve the bot_id parameter using the service ID from the console. The bot_id parameter is required to call the Table Q&A service.
Supported language: Chinese
This API queries basic service information, such as the service name, description, and bot_id, using the service ID from the service list in the console. If you do not have a service ID, go to the Conversational Intelligence console to create a service.
Request parameters
Name | Type | Required | Example | Description |
Action | String | Yes | GetTableQAServiceInfoById | A required parameter. Set the value to GetTableQAServiceInfoById. |
ServiceCode | String | Yes | alinlp | A static field. Only alinlp is supported. |
ServiceId | String | Yes | 68 | The service ID displayed in the service list of the console. |
Return Data
Name | Type | Sample value | Description |
RequestId | String | 2E14E12B-291D-149E-933D-137025837825 | The unique ID of the request. Use this ID to troubleshoot issues. |
Data | String | |
|
API access
For more information about how to integrate the API, see Quick Start.
Error codes
If an error occurs during a call, refer to the following table. The table describes the cause of each error and provides a solution.
HttpCode | Error code | Error message | Description |
400 | UserStatusInvalid | The user status is invalid. | The user status is invalid. Check whether your account has overdue payments or unpaid bills. |
400 | BasicServiceNotActivated | The NLP API (Version : base) service has not been activated. Please click the url to confirm the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpBasePost_public_cn#/buy | The NLP API (Basic Edition) service is not activated. Click the link to check the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpBasePost_public_cn#/buy |
400 | AdvancedServiceNotActivated | The NLP API (Version : advanced) service has not been activated. Please click the url to confirm the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpAdvancedPost_public_cn#/buy | The NLP API (Premium Edition) service is not activated. Click the link to check the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpAdvancedPost_public_cn#/buy |
400 | IndustryServiceNotActivated | The NLP API (Version : industry) service has not been activated. Please click the url to confirm the activation status:https://common-buy.aliyun.com/?commodityCode=nlp_alinlpIndustryPost_public_cn#/buy | The NLP API (Industry Application Edition) service is not activated. Click the link to check the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpIndustryPost_public_cn#/buy |
401 | InvalidParameter | The parameter is invalid. | The parameter is invalid. Check the request parameters. |
403 | Forbidden.NoAuth | You are not authorized to operate on the specified resource. Please click the URL for help information:https://help.aliyun.com/document_detail/177209.html | Your account does not have the permissions to operate on the specified resource. Click the URL for help: https://help.aliyun.com/document_detail/177209.html |
405 | TextLimitExceeded | The maximum length of the text is exceeded. | The text length exceeds the limit. |
406 | TextCodingError | An encoding error occurred to the input text. | The encoding of the input text is incorrect. |
410 | FrameworkError | Framework internal server error. | A framework error occurred. |
411 | FrameworkApiError | Framework API error. | A framework API error occurred. |
412 | FrameworkFormatError | Framework request format error. | The format of the framework request is incorrect. |
413 | FrameworkReturnError | Framework return type format error. | The format of the framework response is incorrect. |
429 | Throttling.User | Flow control has been triggered. | The maximum number of queries per second (QPS) is exceeded. Click the URL for help: https://help.aliyun.com/document_detail/69780.html#p-wq5-zb9-5wu |
500 | InternalError | A server error occurred while processing your request. Please try again later or contact customer support. | A server error occurred while processing your request. Try again later or contact customer support. |
For more error codes, visit the Error Center.