OperateInferenceService
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to operate an inference service, support stopping, starting up, and deleting the inference service. Once deleted, resources cannot be recovered.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: OperateInferenceService. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Zone ID. |
| ServiceId | Yes | String | ID of the inference service. |
| Operation | Yes | String | Operation type, including the following: |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Deleting an inference service
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OperateInferenceService
<Common request parameters>
{
"ZoneId": "zone-2***8ev000",
"ServiceId": "inf-9f8***4a3210",
"Operation": "Delete"
}Output Example
{
"Response": {
"RequestId": "d8421228-6851-4b2c-bff0-a1c415c48ced"
}
}Example2 Starting an inference service
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OperateInferenceService
<Common request parameters>
{
"ZoneId": "zone-2***8ev000",
"ServiceId": "inf-9f8***4a3210",
"Operation": "Resume"
}Output Example
{
"Response": {
"RequestId": "cbabe886-9d89-4333-a815-a44f6ffe2604"
}
}Example3 Stopping an inference service
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OperateInferenceService
<Common request parameters>
{
"ZoneId": "zone-2***8ev000",
"ServiceId": "inf-9f8***4a3210",
"Operation": "Stop"
}Output Example
{
"Response": {
"RequestId": "c78690b2-ece1-4fc6-b03e-8ea6c56c2bdc"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameterValue.ZoneNotFound | No corresponding site. please ensure correct information entry. |
| ResourceNotFound.InferenceService | The reasoning service does not exist. |