1. 接口描述
接口请求域名: chc.tencentcloudapi.com 。
获取用户可用的工单类型
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeWorkOrderTypes。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CollectedWorkOderTypeSet | Array of WorkOrderTypeDetail | 已收藏的工单类型列表 |
WorkOrderFamilySet | Array of WorkOrderFamilyDetail | 全部工单类型列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: chc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkOrderTypes
<公共请求参数>
{}
输出示例
{
"Response": {
"CollectedWorkOderTypeSet": [
{
"CollectFlag": true,
"SlaMessage": "2个工作日",
"WorkOrderDescription": "客户设备托管到腾讯IDC机房,为了确保设备符合机房的上架标准, 在入场前,需要提前进行托管设备入场的评估。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "托管设备型号评估",
"WorkOrderType": "modelEvaluation"
},
{
"CollectFlag": true,
"SlaMessage": "2 个工作日",
"WorkOrderDescription": "提供现场外包资产管理员,进行现场物资的收货和验收操作。\n",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备收货",
"WorkOrderType": "receiving"
},
{
"CollectFlag": true,
"SlaMessage": "2 个工作日",
"WorkOrderDescription": "提供现场外包工程师,将指定设备上到机位上。 ",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备上架",
"WorkOrderType": "rackOn"
},
{
"CollectFlag": true,
"SlaMessage": "最快 2 个工作日",
"WorkOrderDescription": "提供设备的开电操作。机架的开电由IDC平台部数经判断,自行发起。\n",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备开电",
"WorkOrderType": "powerOn"
},
{
"CollectFlag": true,
"SlaMessage": "最快 1 个工作日",
"WorkOrderDescription": "根据客户要求, 在同IDC内对指定设备进行搬迁操作。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "机房内搬迁",
"WorkOrderType": "moving"
}
],
"RequestId": "3dad52cf-67c5-4eed-b191-e4f542ce4d80",
"WorkOrderFamilySet": [
{
"WorkOrderFamily": "设备服务",
"WorkOrderTypeSet": [
{
"CollectFlag": true,
"SlaMessage": "2个工作日",
"WorkOrderDescription": "客户设备托管到腾讯IDC机房,为了确保设备符合机房的上架标准, 在入场前,需要提前进行托管设备入场的评估。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "托管设备型号评估",
"WorkOrderType": "modelEvaluation"
},
{
"CollectFlag": true,
"SlaMessage": "2 个工作日",
"WorkOrderDescription": "提供现场外包资产管理员,进行现场物资的收货和验收操作。\n",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备收货",
"WorkOrderType": "receiving"
},
{
"CollectFlag": true,
"SlaMessage": "2 个工作日",
"WorkOrderDescription": "提供现场外包工程师,将指定设备上到机位上。 ",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备上架",
"WorkOrderType": "rackOn"
},
{
"CollectFlag": true,
"SlaMessage": "最快 2 个工作日",
"WorkOrderDescription": "提供设备的开电操作。机架的开电由IDC平台部数经判断,自行发起。\n",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备开电",
"WorkOrderType": "powerOn"
},
{
"CollectFlag": true,
"SlaMessage": "最快 1 个工作日",
"WorkOrderDescription": "根据客户要求, 在同IDC内对指定设备进行搬迁操作。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "机房内搬迁",
"WorkOrderType": "moving"
},
{
"CollectFlag": false,
"SlaMessage": "最快 2 个工作日",
"WorkOrderDescription": "提供设备的关电操作。\n",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备关电",
"WorkOrderType": "powerOff"
},
{
"CollectFlag": false,
"SlaMessage": "最快当天完成",
"WorkOrderDescription": "提供现场外包工程师,将指定设备从机位上下架。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "设备下架",
"WorkOrderType": "rackOff"
},
{
"CollectFlag": false,
"SlaMessage": "1 个工作日",
"WorkOrderDescription": "客户将设备等资产迁出腾讯机房, 腾讯提供指定设备的交接服务, 不包含物流服务,不包含包装、搬车和装运服务。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "退出交接",
"WorkOrderType": "quit"
},
{
"CollectFlag": false,
"SlaMessage": "最快 2 个工作日",
"WorkOrderDescription": "提供机架的开电操作。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "机架开电",
"WorkOrderType": "rackPowerOn"
},
{
"CollectFlag": false,
"SlaMessage": "最快 2 个工作日",
"WorkOrderDescription": "提供机架的关电操作。",
"WorkOrderFamily": "设备服务",
"WorkOrderName": "机架关电",
"WorkOrderType": "rackPowerOff"
}
]
},
{
"WorkOrderFamily": "人员服务",
"WorkOrderTypeSet": [
{
"CollectFlag": false,
"SlaMessage": "最快 1 个工作日",
"WorkOrderDescription": "非机房常驻运维及授权人员,因运维需要进入机房,需提交人员到访申请。",
"WorkOrderFamily": "人员服务",
"WorkOrderName": "人员到访",
"WorkOrderType": "personnelVisit"
}
]
},
{
"WorkOrderFamily": "通用服务",
"WorkOrderTypeSet": [
{
"CollectFlag": false,
"SlaMessage": "最快 30min 响应",
"WorkOrderDescription": "提供网络设备的设备重启、状态查看等通用服务受理",
"WorkOrderFamily": "通用服务",
"WorkOrderName": "网络设备通用服务",
"WorkOrderType": "netDeviceCommon"
},
{
"CollectFlag": false,
"SlaMessage": "最快 30min 响应",
"WorkOrderDescription": "提供服务器的设备重启、插拔硬盘、重装系统、状态查看等通用服务受理",
"WorkOrderFamily": "通用服务",
"WorkOrderName": "服务器通用服务",
"WorkOrderType": "serverCommon"
}
]
}
]
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。