API 中心

数字工厂底座

地市云

根据实例UUID查询实例详情

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

本页目录：

接口描述

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

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeInstance

接口是否需要携带Token：是

本接口用于根据实例UUID查询实例详情。

输入参数

参数名称 必选 类型 描述
Action 是 String openapi公共参数，本接口取值：DescribeInstance
InstanceUUID 是 String 实例uuid
With 否 Array of String 状态列表[InstanceCustomSpecs:包含额外计费项]

输出参数

Response

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

Data

参数名称 类型 描述
Instance Instance Instance

Instance

参数名 类型 描述
ID string 自增id
Appid string 租户Id 默认0
Bid string 上层应用id 默认0
UUID string 实例UUID
SourceInstanceID string 源实例id(云市场/其他第三方)
Status string 工业云实例状态
InstanceExpireTime string 过期时间
Renewable bool true 可续费，false 不可续费 是否显示续费按钮
LastOrderID string 当前订单id
ProductID string 商品id
ProductType string 产品类型:cvm/cbs/ip/others
SpecUuid string 产品规格UUID
LifeType string limited:有有效期限制的;unlimited:长久有效的
IsTrial bool 是否试用
SourceInstanceId string 源实例id(云市场/其他第三方)
InstanceCreateTime bool 创建时间
CanRefund bool 是否显示可退款按钮（true:显示）
HasRefunding bool 是否显示退款详情标签(true:显示)
Upgradable bool 是否可以升级（true:可升级）
InstanceExpireTimeUnix string 实例过期时间 - unix
ProductSource string 商品来源
BuyerUserID string 工业云购买者id
SubStatus string 子状态
InstanceName string 实例名称
CategoryID string 分类ID
DeliverType string 枚举: saas,manual 枚举备注: saas - SAAS交付 manual - 人工交付
ApplicationID string IDaaS应用ID
SSOUrl string 免密登录URL
BuyerCorpID string 工业云购买者企业id
AdditionalInfo string 服务信息
AppInfo string 服务信息
IsvUin string 服务提供商id
CreatedAt string
UpdatedAt string
CustomSpecItems CustomSpecItems

CustomSpecItems

参数名 类型 描述
ID Integer 自增id
InstanceUUID string 实例UUID
Name string 名称
Value string 取值
NameEn string 参数项
Type string 类型
CustomUuid string 自定义计费项UUid
UnitType string 数量型类型
Unit string 单位

示例

示例1 请求例子

输入示例

{
  "Action":"DescribeInstance",
  "InstanceUUID": "string",
  "With": [
    "string"
  ]
}

输出示例

{
  "Response": {
    "RequestId": "string",
    "Data": {
      "Instance": {
        "ID": 3,
        "Appid": 3,
        "Bid": 3,
        "UUID": "string",
        "SourceInstanceID": "string",
        "Status": "string",
        "LastOrderID": "string",
        "ProductID": "string",
        "ProductType": "string",
        "ProductSource": "string",
        "CategoryID": "string",
        "DeliverType": "string",
        "ApplicationID": "string",
        "SSOUrl": "string",
        "Certificate": "string",
        "LifeType": "limited 有有效期限制的",
        "InstanceCreateTime": "string",
        "InstanceExpireTime": "string",
        "InstanceExpireTimeUnix": "string",
        "BuyerUserID": "string",
        "BuyerCorpID": "string",
        "AdditionalInfo": "string",
        "AppInfo": "string",
        "IsvUin": "string",
        "CreatedAt": "string",
        "UpdatedAt": "string",
        "SpecUuid": "string",
        "IsTrial": true,
        "SubStatus": "string",
        "InstanceName": "string",
        "HasRefunding": true
      },
      "CustomSpecItems": [
        {
          "ID": 3,
          "InstanceUUID": "string",
          "Name": "string",
          "Value": "string",
          "NameEn": "string",
          "Type": "string",
          "CustomUuid": "string",
          "UnitType": "string",
          "Unit": "string"
        }
      ]
    }
  }
}

错误码

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

错误码 描述