查询设备类工单详情

最近更新时间:2025-04-25 01:16:39

我的收藏

1. 接口描述

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

用于查询设备类工单的工单详情,如:'receiving', 'rackOn', 'powerOn', 'powerOff', 'rackOff', 'quit'

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceWorkOrderDetail。
Version String 公共参数,本接口取值:2023-04-18。
Region String 公共参数,详见产品支持的 地域列表
OrderId String 工单ID
示例值:ord-24121717264943561

3. 输出参数

参数名称 类型 描述
OrderId String 工单ID
示例值:ord-25032218485126792
ServiceType String 服务类型
示例值:rackOn
OrderType String 工单类型
示例值:powerOn
OrderStatus String 工单状态
示例值:finish
StepSet Array of OrderStep 工单流程状态
DeviceSet Array of DeviceHistory 工单设备信息
BaseInfo DeviceOrderBaseInfo 工单的入参信息
RejectReason String 工单的拒绝原因,工单状态为reject的时候返回
示例值:拒绝原因
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询设备类工单详情

输入示例

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

{
    "OrderId": "ord-25022518110325063"
}

输出示例

{
    "Response": {
        "BaseInfo": {
            "DeviceType": "server",
            "IdcId": 373,
            "IdcName": "天津数据备份中心东区3栋DC",
            "IsPowerOffConfirm": "1",
            "Remark": "",
            "StuffOption": "2"
        },
        "DeviceSet": [
            {
                "AssetId": "TH2502250006E",
                "DeviceType": "server",
                "IdcId": 373,
                "IdcName": "天津数据备份中心东区3栋DC",
                "IdcUnitId": 2559,
                "IdcUnitName": "天津数据备份中心东区3栋DCM204",
                "PositionCode": 4,
                "RackName": "M204-J10",
                "Sn": "lihwli10225011"
            },
            {
                "AssetId": "TH2502250006D",
                "DeviceType": "server",
                "IdcId": 373,
                "IdcName": "天津数据备份中心东区3栋DC",
                "IdcUnitId": 2559,
                "IdcUnitName": "天津数据备份中心东区3栋DCM204",
                "PositionCode": 3,
                "RackName": "M204-J10",
                "Sn": "lihwli10225012"
            }
        ],
        "OrderId": "ord-25022518110325063",
        "OrderStatus": "finish",
        "OrderType": "rackOff",
        "RequestId": "c03f33b4-e3e3-4c22-9af3-e8791cee35df",
        "ServiceType": "rackOff",
        "StepSet": [
            {
                "FinishTime": "2025-02-25 18:11:03",
                "OwnerName": "godwin2@test.com",
                "StepName": "发起申请",
                "StepStatus": "finish"
            },
            {
                "FinishTime": "2025-02-25 18:12:05",
                "OwnerName": "",
                "StepName": "数经审核",
                "StepStatus": "finish"
            },
            {
                "FinishTime": "2025-02-25 18:18:07",
                "OwnerName": "",
                "StepName": "现场实施",
                "StepStatus": "finish"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码