API 中心

数字工厂底座

地市云

查询实例列表

最近更新时间：11/9/2023, 4:19:05 PM作者：andrewren(任豪)

本页目录：

接口描述

接口请求域名：http://instance-console-api.{工业环境域名}

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeInstances

接口是否需要携带Token：是

本接口用于查询实例列表。

输入参数

参数名称 必选 类型 描述
Action 是 String openapi公共参数，本接口取值：DescribeInstances
ProductSource 是 String 商品来源。cloud_market:云市场;local:本地应用iop_third:第三方应用第三方接入一般使用iop_third
DeliverType 否 Array of String 交付类型,筛选条件，不填写则不进行筛选[Saas:交付;manual:人工交付]
CategoryID 否 Array of String 类目分类ID，不填写不进行筛选
Bid 是 Integer 业务ID
Status 是 Array of String 状态列表，必填expired - 已过期delivered - 使用中/已发货 delivering - 交付中
Offset 否 Integer 偏移量，默认为0
Limit 否 Integer 限制数目，默认为20
SortSet 否 Array of SortSet 排序条件，[{"Key":"created_at","Direction":"asc"}]

SortSet

参数名称 必选 类型 描述
Key 否 String 排序字段
Direction 否 String 排序支持desc、asc、DESC、ASC

输出参数

Response

参数名称 类型 描述
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId
Data Data 返回数据

Data

参数名称 类型 描述
TotalCount Integer 总数
Instances Instances 返回数据

Instances

参数名 类型 描述
UUID String 实例UUID
ProductName String 商品名
ProductID String 商品ID
CategoryName String 分类名
CategoryID String 分类ID
DeliverType String 人工交付
InstanceCreateTime String 创建时间
InstanceExpireTime String 过期时间
Status String 状态default:默认;delivering:发货中;delivered:使用中;deliver_failed:发货失败;expired:已过期;destroyed:se已关闭;deleted:已删除
Renewable bool 是否显示续费按钮true 可续费，false 不可续费
LastOrderID String 当前订单id
LoginType object 登录类型idaas - 接入idaas授权password - 提供登录信息（账号、密码等信息）none - 无需登录
SpecUuid String 产品规格UUID
LifeType String 生命周期类型limited:有有效期限制的unlimited:长久有效的
IsTrial bool 是否试用
SourceInstanceId String 源实例id(云市场/其他第三方)
IsConfirm bool 云市场人工交付类按钮是否显示(true:显示)
CanRefund bool 是否显示可退款按钮（true:显示）
HasRefunding bool 是否显示退款详情标签(true:显示)
Upgradable bool 是否可以升级（true:可升级）
Logo String 产品图片
ProductSource String 商品来源
CanCancelRefund String 是否可取消退款（true:可升级）
SubStatus String 子状态
InstanceName String 实例名称

示例

示例1 请求例子

输入示例

{
  "Action":"DescribeInstances",
  "ProductSource": "String",
  "DeliverType": [
    "String"
  ],
  "CategoryID": [
    "String"
  ],
  "Bid": 3,
  "Status": [
    "String"
  ],
  "Offset": 3,
  "Limit": 3,
  "SortSet": [
    {
      "Key": "String",
      "Direction": "String"
    }
  ]
}

输出示例

{
  "Response": {
    "RequestId": "String",
    "Data": {
      "TotalCount": 3,
      "Instances": [
        {
          "UUID": "String",
          "ProductName": "String",
          "ProductID": "String",
          "CategoryName": "String",
          "CategoryID": "String",
          "DeliverType": "String",
          "InstanceCreateTime": "String",
          "InstanceExpireTime": "String",
          "Status": "String",
          "Renewable": true,
          "LastOrderID": "String",
          "LoginType": "String",
          "SpecUuid": "String",
          "LifeType": "String",
          "IsTrial": true,
          "SourceInstanceId": "String",
          "IsConfirm": true,
          "CanRefund": true,
          "HasRefunding": true,
          "Upgradable": true,
          "Logo": "String",
          "ProductSource": "String",
          "CanCancelRefund": "String",
          "SubStatus": "String",
          "InstanceName": "String"
        }
      ]
    }
  }
}

错误码

以下仅列出了接口业务逻辑相关的错误码

错误码 描述