1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
查询单个服务
默认接口请求频率限制:50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeModelService。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ServiceId | 是 | String | 服务id 示例值:ms-xyz11 |
ServiceCategory | 否 | String | 服务分类 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Service | Service | 服务信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询单个服务
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeModelService
<公共请求参数>
{
"ServiceId": "ms-xxxxxx-1"
}
输出示例
{
"Response": {
"Service": {
"ServiceGroupId": "ms-ndxkhtb2",
"ServiceId": "ms-ndxkhtb2-1",
"ServiceGroupName": "luis-test-timeout",
"ServiceDescription": "",
"ServiceInfo": {
"Replicas": 0,
"ImageInfo": {
"ImageType": "CCR",
"ImageUrl": "ccr.ccs.tencentyun.com/tiemsdev/hellotest:latest",
"RegistryRegion": "ap-guangzhou",
"RegistryId": ""
},
"Env": [],
"Resources": {
"Cpu": 2000,
"Memory": 4096,
"Gpu": 0,
"RealGpu": 0,
"GpuType": "",
"RealGpuDetailSet": []
},
"InstanceType": "TI.S.MEDIUM.POST",
"ModelInfo": null,
"InferCodeInfo": null,
"VolumeMount": null,
"LogEnable": false,
"LogConfig": null,
"AuthorizationEnable": true,
"ScaleMode": "MANUAL",
"HorizontalPodAutoscaler": null,
"CronScaleJobs": [],
"ScaleStrategy": "",
"ScheduledAction": null,
"Status": {
"Replicas": 0,
"UpdatedReplicas": 0,
"ReadyReplicas": 0,
"AvailableReplicas": 0,
"UnavailableReplicas": 0,
"Status": "Stopped",
"Reason": "",
"Conditions": [
{
"Message": "Deployment has minimum availability.",
"Reason": "MinimumReplicasAvailable",
"Status": "True",
"Type": "Available",
"LastTransitionTime": "2023-12-27T16:21:02+08:00",
"LastUpdateTime": "2023-12-27T16:21:02+08:00"
},
{
"Message": "ReplicaSet \"ms-ndxkhtb2-1-8579fcbb7f\" has successfully progressed.",
"Reason": "NewReplicaSetAvailable",
"Status": "True",
"Type": "Progressing",
"LastTransitionTime": "2023-12-27T16:21:02+08:00",
"LastUpdateTime": "2023-12-27T16:22:54+08:00"
}
]
},
"Weight": 0,
"PodList": [],
"Pods": null,
"PodInfos": [],
"ResourceTotal": {
"Cpu": 0,
"Memory": 0,
"Gpu": 0,
"RealGpu": 0,
"GpuType": "",
"RealGpuDetailSet": []
},
"OldReplicas": 1,
"HybridBillingPrepaidReplicas": 0,
"OldHybridBillingPrepaidReplicas": 0,
"ServiceLimit": {
"EnableInstanceRpsLimit": false,
"InstanceRpsLimit": 1000000,
"EnableInstanceReqLimit": false,
"InstanceReqLimit": 1000000
},
"Command": "",
"ModelHotUpdateEnable": false,
"ModelTurboEnable": false,
"ServiceEIP": null
},
"ClusterId": "manger",
"Region": "ap-guangzhou",
"Namespace": "infer-100005348929",
"ChargeType": "POSTPAID_BY_HOUR",
"ResourceGroupId": "",
"ResourceGroupName": "",
"Tags": [],
"IngressName": "user-ingress-gz-6",
"CreatedBy": "243224118",
"CreateTime": "2023-12-27T08:20:48Z",
"UpdateTime": "2023-12-27T09:18:59Z",
"Uin": "100005348929",
"SubUin": "",
"AppId": 0,
"BusinessStatus": "CREATE_SUCCEED",
"CreateFailedReason": "CREATE_SUCCEED",
"Status": "Stopped",
"BillingInfo": "",
"Weight": 100,
"CreateSource": "DEFAULT",
"Version": "1",
"LatestVersion": "1",
"ResourceGroupSWType": "",
"ServiceLimit": null,
"ScheduledAction": null
},
"RequestId": "841f61f9-daed-49aa-88a3-b3f860be5be4"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.CamException | CAM系统异常。 |
FailedOperation | 操作失败。 |
FailedOperation.ApiGatewayQueryFailed | API网关访问失败,请重试。 |
FailedOperation.BillingQueryFailed | 计费模块访问失败。 |
FailedOperation.ClsServiceNotActived | 尚未开通CLS日志服务,请开前往开通。 |
FailedOperation.ClusterQueryFailed | 集群访问失败。 |
FailedOperation.DuplicateName | 名称重复。 |
FailedOperation.ExecDatabaseFail | 数据库执行错误。 |
FailedOperation.InvalidUserType | 操作失败,用户类型异常。 |
FailedOperation.KmsKeyNotOpen | 密钥管理系统服务未开通,请先开通腾讯云密钥管理系统服务。 |
FailedOperation.NoFreeBucket | 没有空闲免费桶。 |
FailedOperation.NoPermission | 没有权限。 |
FailedOperation.NotAllow | 操作不允许。 |
FailedOperation.Processing | 请求正在处理中,请稍后再试。 |
FailedOperation.QueryDatabaseFail | 数据库查询错误。 |
FailedOperation.RepoBindByInstance | 存储库有绑定的实例,请先删除绑定的实例。 |
FailedOperation.StsQueryFailed | 密钥服务访问失败,请重试。 |
FailedOperation.Timedout | 实例启动失败。 |
FailedOperation.UnknownInstanceType | 未知的实例规格。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.BadName | 名称不合法。 |
InvalidParameterValue.ClsConfigRequired | 请设置日志集、日志主题ID。 |
InvalidParameterValue.CodeRepoNotFound | 存储库不存在。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.BalanceInsufficient | 余额不足,创建/更新失败。 |
ResourceNotFound | 资源不存在。 |