ModifyInferenceService

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to modify the inference service, supporting updates to the listening port, request path, container image, resource configuration, and description. Only the passed parameters are modified, while others remain unchanged.

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: ModifyInferenceService.
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	Site ID.
ServiceId	Yes	String	ID of the inference service.
ListenPort	No	Integer	Ports monitored by the model service. Only integers between 1 and 65535 are supported.
RequestPaths.N	No	Array of String	Request path list for inference service. Supports up to 20 paths.
Containers.N	No	Array of InferenceContainerConfigForModify	Container configuration of the inference service. Currently only support setting 1 container.
ResourceConfig	No	InferenceResourceConfigForModify	Resource configuration of the inference service.
Description	No	String	Description. The length is limited to 60 characters.

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 Modify reasoning service information

Modify the service description and resource information.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInferenceService
<Common request parameters>

{
    "ZoneId": "zone-3eox****5tad",
    "ServiceId": "inf-lwdnt***rgss",
    "ListenPort": 8080,
    "RequestPaths": [
        "/v1/predictions"
    ],
    "Containers": [
        {
            "ImageType": "TCR",
            "TcrRepositoryConfig": {
                "TCRType": "Personal",
                "Image": "ccr.ccs.tencentyun.com/namespace/image:v1.0.0",
                "RegionName": "ap-guangzhou"
            },
            "StartupCommand": "python app.py",
            "EnvironmentVariables": [
                {
                    "Key": "MODEL_PATH",
                    "Value": "/models/v1"
                }
            ]
        }
    ],
    "ResourceConfig": {
        "ScalingMode": "Manual",
        "ManualInstanceConfig": {
            "FixedInstanceCount": 1
        },
        "Concurrency": 10
    },
    "Description": "Image inference based on ResNet50 model"
}

Output Example

{
    "Response": {
        "RequestId": "c6e1ea80-881c-46f7-bc9b-c55c7a1befa8"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
- Example1 Modify reasoning service information
5. Developer Resources
- SDK
- Command Line Interface
6. Error Code