1. 接口描述
接口请求域名: chc.tencentcloudapi.com 。
查询通用服务工单详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCommonServiceWorkOrderDetail。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
OrderId | 是 | String | 工单ID 示例值:ord-24120215310024323 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
StepSet | Array of OrderStep | 进度 |
BaseInfo | CommonServiceBaseInfo | 基本信息 |
DeviceSet | Array of DevicePosition | 设备信息 |
OrderStatus | String | 工单状态 示例值:工单状态 订单状态, processing 处理中 ,reject 已拒绝 ,finish 已完成,exception 异常 |
RejectReason | String | 拒绝原因 示例值:不符合规范 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求网络设备的通用服务订单详情
输入示例
POST / HTTP/1.1
Host: chc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCommonServiceWorkOrderDetail
<公共请求参数>
{
"OrderId": "ord-25030712531166778"
}
输出示例
{
"Response": {
"BaseInfo": {
"ContactName": "zhangsan",
"ContactPhone": "13134567876",
"IdcName": "天津数据备份中心东区4栋DC",
"Instructions": "remark",
"PreAuthorization": true,
"ServiceLevel": 1
},
"DeviceSet": [
{
"DeviceType": "netDevice",
"IdcName": "天津数据备份中心东区4栋DC",
"IdcUnitName": "天津数据备份中心东区4栋DCM208",
"RackName": "M208-C08",
"Sn": "lhshenNet101"
}
],
"OrderStatus": "finish",
"RequestId": "8df49659-bc07-4364-ab1b-2c5981d3ab61",
"StepSet": [
{
"FinishTime": "2025-03-07 12:53:11",
"OwnerName": "zhangsan",
"StepName": "发起申请",
"StepStatus": "finish"
},
{
"FinishTime": "2025-03-07 13:02:37",
"OwnerName": "",
"StepName": "现场实施",
"StepStatus": "finish"
},
{
"FinishTime": "",
"OwnerName": "",
"StepName": "客户验证确认",
"StepStatus": "processing"
}
]
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。