有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: tione.tencentcloudapi.com 。

用于创建、发布一个新的模型服务

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateModelService。
Version String 公共参数,本接口取值:2021-11-11。
Region String 公共参数,详见产品支持的 地域列表
ServiceGroupId String 新增版本时需要填写
示例值:ms-testtest
ServiceGroupName String 不超过60个字,仅支持英文、数字、下划线"_"、短横"-",只能以英文、数字开头
示例值:test-myname
ServiceDescription String 模型服务的描述
示例值:这是一个用于测试的模型服务
ChargeType String 付费模式,有 PREPAID (包年包月)和 POSTPAID_BY_HOUR(按量付费)
示例值:PREPAID
ResourceGroupId String 预付费模式下所属的资源组id,同服务组下唯一
示例值:ins-ttttt
ModelInfo ModelInfo 模型信息,需要挂载模型时填写
ImageInfo ImageInfo 镜像信息,配置服务运行所需的镜像地址等信息
Env.N Array of EnvVar 环境变量,可选参数,用于配置容器中的环境变量
Resources ResourceInfo 资源描述,指定包年包月模式下的cpu,mem,gpu等信息,后付费无需填写
InstanceType String 使用DescribeBillingSpecs接口返回的规格列表中的值,或者参考实例列表:
TI.S.MEDIUM.POST 2C4G
TI.S.LARGE.POST 4C8G
TI.S.2XLARGE16.POST 8C16G
TI.S.2XLARGE32.POST 8C32G
TI.S.4XLARGE32.POST 16C32G
TI.S.4XLARGE64.POST 16C64G
TI.S.6XLARGE48.POST 24C48G
TI.S.6XLARGE96.POST 24C96G
TI.S.8XLARGE64.POST 32C64G
TI.S.8XLARGE128.POST 32C128G
TI.GN7.LARGE20.POST 4C20G T41/4
TI.GN7.2XLARGE40.POST 10C40G T4
1/2
TI.GN7.2XLARGE32.POST 8C32G T41
TI.GN7.5XLARGE80.POST 20C80G T4
1
TI.GN7.8XLARGE128.POST 32C128G T41
TI.GN7.10XLARGE160.POST 40C160G T4
2
TI.GN7.20XLARGE320.POST 80C320G T4*4
示例值:TI.S.MEDIUM.POS
ScaleMode String 扩缩容类型 支持:自动 - "AUTO", 手动 - "MANUAL",默认为MANUAL
示例值:AUTO
Replicas Integer 实例数量, 不同计费模式和调节模式下对应关系如下
PREPAID 和 POSTPAID_BY_HOUR:
手动调节模式下对应 实例数量
自动调节模式下对应 基于时间的默认策略的实例数量
HYBRID_PAID:
后付费实例手动调节模式下对应 实例数量
后付费实例自动调节模式下对应 时间策略的默认策略的实例数量
示例值:1
HorizontalPodAutoscaler HorizontalPodAutoscaler 自动伸缩信息
LogEnable Boolean 是否开启日志投递,开启后需填写配置投递到指定cls
示例值:true
LogConfig LogConfig 日志配置,需要投递服务日志到指定cls时填写
AuthorizationEnable Boolean 是否开启接口鉴权,开启后自动生成token信息,访问需要token鉴权
示例值:true
Tags.N Array of Tag 腾讯云标签
NewVersion Boolean 是否新增版本
示例值:true
CronScaleJobs.N Array of CronScaleJob 定时任务配置,使用定时策略时填写
ScaleStrategy String 自动伸缩策略配置 HPA : 通过HPA进行弹性伸缩 CRON 通过定时任务进行伸缩
示例值:HPA
HybridBillingPrepaidReplicas Integer 计费模式[HYBRID_PAID]时生效, 用于标识混合计费模式下的预付费实例数
示例值:1
CreateSource String [AUTO_ML 自动学习,自动学习正式发布 AUTO_ML_FORMAL, DEFAULT 默认]
示例值:AUTO_ML
ModelHotUpdateEnable Boolean 是否开启模型的热更新。默认不开启
示例值:false
ScheduledAction ScheduledAction 定时停止配置
VolumeMount VolumeMount 挂载配置,目前只支持CFS
ServiceLimit ServiceLimit 服务限速限流相关配置
CallbackUrl String 回调地址,用于回调创建服务状态信息,回调格式&内容详情见:TI-ONE 接口回调说明
ModelTurboEnable Boolean 是否开启模型的加速, 仅对StableDiffusion(动态加速)格式的模型有效。
ServiceCategory String 服务分类
Command String 服务的启动命令,如遇特殊字符导致配置失败,可使用CommandBase64参数
ServiceEIP ServiceEIP 是否开启TIONE内网访问外部,此功能仅支持后付费机型与从TIONE平台购买的预付费机型;使用从CVM选择资源组时此配置不生效。
CommandBase64 String 服务的启动命令,以base64格式进行输入,与Command同时配置时,仅当前参数生效
ServicePort Integer 服务端口,仅在非内置镜像时生效,默认8501。不支持输入8501-8510,6006,9092

3. 输出参数

参数名称 类型 描述
Service Service 生成的模型服务
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建示例

创建一个基于自定义镜像的服务

输入示例

POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateModelService
<公共请求参数>

{
    "ServiceGroupId": "",
    "ServiceGroupName": "demo-create",
    "ServiceDescription": "",
    "ChargeType": "POSTPAID_BY_HOUR",
    "InstanceType": "TI.S.MEDIUM.POST",
    "ImageInfo": {
        "ImageType": "CCR",
        "ImageUrl": "ccr.ccs.tencentyun.com/test-ccr/hellotest",
        "RegistryRegion": "ap-guangzhou",
        "RegistryId": ""
    },
    "Tags": [],
    "LogEnable": false,
    "Env": [],
    "ScaleMode": "MANUAL",
    "Replicas": 1,
    "AuthorizationEnable": false,
    "ModelHotUpdateEnable": false,
    "ServiceLimit": {
        "EnableInstanceRpsLimit": false,
        "InstanceRpsLimit": 500
    },
    "ScheduledAction": {
        "ScheduleStop": false,
        "ScheduleStopTime": "2023-04-24T11:54:53+08:00"
    }
}

输出示例

{
    "Response": {
        "Service": {
            "ServiceGroupId": "ms-skdg89rx",
            "ServiceId": "ms-skdg89rx-1",
            "ServiceGroupName": "demo-create",
            "ServiceDescription": "",
            "ServiceInfo": {
                "Replicas": 1,
                "ImageInfo": {
                    "ImageType": "CCR",
                    "ImageUrl": "ccr.ccs.tencentyun.com/test-ccr/hellotest",
                    "RegistryRegion": "ap-guangzhou",
                    "RegistryId": ""
                },
                "Env": [],
                "Resources": {
                    "Cpu": 2000,
                    "Memory": 4096,
                    "Gpu": 0,
                    "RealGpu": 0,
                    "GpuType": "none",
                    "RealGpuDetailSet": []
                },
                "InstanceType": "TI.S.MEDIUM.POST",
                "ModelInfo": null,
                "LogEnable": false,
                "LogConfig": null,
                "AuthorizationEnable": false,
                "ScaleMode": "MANUAL",
                "HorizontalPodAutoscaler": null,
                "CronScaleJobs": [],
                "ScaleStrategy": "",
                "Status": null,
                "Weight": 100,
                "PodList": [],
                "Pods": null,
                "PodInfos": [],
                "ResourceTotal": null,
                "OldReplicas": 0,
                "HybridBillingPrepaidReplicas": 0,
                "OldHybridBillingPrepaidReplicas": 0,
                "ModelHotUpdateEnable": false
            },
            "ClusterId": "",
            "Region": "ap-guangzhou",
            "Namespace": "",
            "ChargeType": "POSTPAID_BY_HOUR",
            "ResourceGroupId": "",
            "ResourceGroupName": "",
            "Tags": [],
            "IngressName": "user-ingress-1",
            "CreatedBy": "10000000000",
            "CreateTime": "",
            "UpdateTime": "",
            "Uin": "10000000000",
            "SubUin": "10000000000",
            "AppId": 10000000000,
            "BusinessStatus": "CREATING",
            "CreateFailedReason": "",
            "Status": "",
            "BillingInfo": "",
            "Weight": 100,
            "CreateSource": "DEFAULT",
            "Version": "",
            "LatestVersion": "",
            "ServiceLimit": {
                "EnableInstanceRpsLimit": false,
                "InstanceRpsLimit": 0,
                "EnableInstanceReqLimit": false,
                "InstanceReqLimit": 0
            },
            "ScheduledAction": {
                "ScheduleStop": false,
                "ScheduleStopTime": "2023-04-24T11:54:53+08:00"
            }
        },
        "RequestId": "b8f848e4-64ea-475c-864e-6d4b0c9ec6ea"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.CamException CAM系统异常。
FailedOperation 操作失败。
FailedOperation.ApiGatewayQueryFailed API网关访问失败,请重试。
FailedOperation.BillingQueryFailed 计费模块访问失败。
FailedOperation.ClusterQueryFailed 集群访问失败。
FailedOperation.DuplicateName 名称重复。
FailedOperation.ExecDatabaseFail 数据库执行错误。
FailedOperation.InsufficientWhitelistQuota 白名单免费配额不足。
FailedOperation.QueryDatabaseFail 数据库查询错误。
FailedOperation.StsQueryFailed 密钥服务访问失败,请重试。
FailedOperation.UnknownInstanceType 未知的实例规格。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ModelFileInvalid 模型包不符合规范。
InvalidParameter.ValidateError 请求参数校验失败。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.BalanceInsufficient 余额不足,创建/更新失败。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。