设备管理接口

设备接口用于查询和管理设备。

设备管理接口规范

用途

方法

请求参数

返回值

查询设备详情

get_device

URI: /v1/device/get_device

 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "get_device",
  "params": {
    "body": {
      "name": "dummy",
      "detail": true,
    }
  }
}

{
  "jsonrpc": "2.0",
  "result": {
    "name": "dummy",
    "alias_name": "空载测试设备",
    "description": "空载测试设备(dummy)",
    "driver_name": "DriverDummy",
    "enable": true,
    "status": "online",
    "configs": {
      "transpiler": {
        "qpu_configs": {
          "qubits": 6,
        },
        "decomposition_rule": {
        }
      }
    },
    "details": {
      "single_qubit_prop": {
        "qubit1": {
          "single_qubit_gate_fidelity": 0.999,
          "qubit_frequency": 5.018,
          "readout_frequency": 6.8295,
          "single_qubit_gate_duration": 30.0,
          "T1": 28.994326898773733,
          "T2": 5.690175203450656,
          "readout_fidelity_state0": 0.9705333333333334,
          "readout_fidelity_state1": 0.8440000000000001,
        }
      },
      "double_qubit_prop": null,
      "tupo_configs": null,
    },
  },
  // 有错误时会出现, 具体格式参照<错误返回>
  "error": {}
  "id": 1
}

查询设备列表

get_devices

URI: /v1/device/get_devices

 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "get_devices",
  "params": {
    "filters": {}  // 过滤
  }
}

{
  "jsonrpc": "2.0",
  "result": {
    "dummy": {
      "name": "dummy",
      "alias_name": "空载测试设备",
      "description": "空载测试设备(dummy)",
      "driver_name": "DriverDummy",
      "enable": true,
      "status": "online",
      "configs": {
        "transpiler": {
          "qpu_configs": {
            "qubits": 6,
          },
          "decomposition_rule": {
          }
        }
      },
      "details": null
    }
  },
  // 有错误时会出现, 具体格式参照<错误返回>
  "error":
  "id": 1
}

校准设备

calibrate

URI: /v1/device/calibrate

 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "calibrate",
  "params": {
    "body": {
      "device_name": "dummy",
      "options": { // 校准参数选项
          "init_freq": 5.018,
          "step": 0.001,
          "machine_type": "superconducting",
          "scan_param": "qubit_frequency",
          "scan_shots": 100,
      }
    }
  }
}

设置设备选项

set_device_options

URI: /v1/device/set_device_options

 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "set_device_options",
  "params": {
    "body": {
      "device_name": "dummy"
    }
  }
}

{
  "jsonrpc": "2.0",
  "result": {
    "sleep": 300, // 设备休眠300s
    "shot_gap": 100, // 量子任务shot间隔100ms
    "readout_threshold": 0.8,
  },
  // 有错误时会出现, 具体格式参照<错误返回>
  "error":
  "id": 1
}

使能去使能量子比特

enable_and_disable_qubit

URI: /v1/device/enable_and_disable_qubit

 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "enable_and_disable_qubit",
  "params": {
    "body": {
      "device_name": "dummy",
      "qubits": {
         "qubit1": true, // qubit1 可用于单量子比特门
         "qubit2": false, // qubit1 不可用于单量子比特门
         "qubit1_qubit2": false, // qubit1 和 qubit2 不可用于双量子比特门
      }
    }
  }
}

{
  "jsonrpc": "2.0",
  "result": {
    "qubit1": true, // qubit1 使能操作成功
    "qubit2": true, // qubit2 去使能操作成功
    "qubit1_qubit2": true, // "qubit1_qubit2" 去使能操作成功
  },
  // 有错误时会出现, 具体格式参照<错误返回>
  "error":
  "id": 1
}