DescribeFrInstances - 查询资源包实例

更新时间:
复制 MD 格式

查询资源包实例

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

bss:DescribeFrInstance

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Group

string

否

查询的资源维度。

枚举值:

  • oss_arc :

    OSS 无地域属性预留空间

  • cu :

    存储容量单位包

  • ecsRi :

    预留实例券

  • oss_rc :

    OSS 预留空间

  • fr :

    资源包

  • polardb :

    PolarDB 计算包

cu

Status

string

否

资源状态。

枚举值:

  • valid :

    有效

  • exhaust :

    用尽

  • invalid :

    无效

valid

PageNum

integer

否

当前页码。

1

PageSize

integer

否

每页大小。

20

StartTime

integer

否

开始时间,使用 Unix 时间戳,单位为毫秒。

1678939035000

EndTime

integer

否

结束时间,使用 Unix 时间戳,单位为毫秒。

1710604800000

InstanceId

string

否

实例名称。

alb_cubag*******

ProductCode

string

否

产品编码。

slb

CommodityCode

string

否

商品编码。

slb_albcubag_dp_cn

TemplateCode

string

否

模板编码。

slb_albcubag*******

Spec

string

否

规格。

*

CapacityType

string

否

容量类型。

枚举值:

  • periodMonthlyShift :

    动态月周期

  • deadlineAcc :

    总量递减型

  • absolute :

    总量恒定型

  • periodMonthlyAcc :

    自然月周期

deadlineAcc

CycleType

string

否

周期类型

dynamicMonth

SortField

string

否

排序字段。

枚举值:

  • startTime :

    开始时间

  • endTime :

    结束时间

startTime

SortRule

string

否

排序规则。

枚举值:

  • asc :

    递增

  • desc :

    递减

asc

EcIdAccountIds

array<object>

否

企业与账号列表,为空表示查询当前账号自身

object

否

企业与账号列表,为空表示查询当前账号自身

EcId

string

是

企业实体 ID

1004064243473974

AccountIds

array

否

访问的账号列表,为空代表全选当前实体 ID 下所有账号

integer

否

成员账号 ID

1990699401005016

Nbid

string

否

一级售卖场 ID,如果为空,默认使用当前用户所属的场 ID 填充。

2684202000018

InstanceTag

string

否

资源包实例标签值。

FR-***

返回参数

名称

类型

描述

示例值

object

BssApiPageResult

RequestId

string

请求 ID。

6000EE23-274B-4E07-A697-FF2E999520A4

CurrentPage

integer

当前页码。

1

PageSize

integer

每页大小。

20

TotalCount

integer

总记录数。

1

Data

array<object>

数据列表。

array<object>

返回数据。

AccountId

integer

账号 ID。

1990699401005016

Product

object

产品。

Code

string

属性编码。

slb

Name

string

属性名称。

负载均衡

ProductName

string

产品名

性能测试

ProductCode

string

产品 code

pts

Commodity

object

商品。

Code

string

属性编码。

slb_albcubag_dp_cn

Name

string

属性名称。

ALB资源包

CommodityCode

string

商品 code

pts

CommodityName

string

商品名

性能测试

InstanceId

string

实例名称。

alb_cubag*******

Spec

string

规格。

*

Status

object

资源状态。

Code

string

属性编码。

valid

Name

string

属性名称。

有效

StatusCode

string

资源状态 code

valid

StatusName

string

资源状态名

有效

CapacityType

object

容量类型。

Code

string

属性编码。

deadlineAcc

Name

string

属性名称。

总量递减型

CapacityTypeCode

string

容量类型 code

deadlineAcc

CapacitiyTypeName

string

容量类型名

总量递减型

CycleType

object

承诺周期

Code

string

承诺周期 Code。

hour

Name

string

承诺周期名。

小时

CycleTypeCode

string

承诺周期 Code

hour

CycleTypeName

string

承诺周期名

小时

InitCapacityViewValue

string

初始容量显示值。

1000.000000

InitCapacityViewUnit

string

初始容量显示单位。

CU

CurrCapacityViewValue

string

当前容量显示值。

1000.000000

CurrCapacityViewUnit

string

当前容量显示单位。

CU

PeriodCapacityViewValue

string

周期容量显示值。

1000.000000

PeriodCapacityViewUnit

string

周期容量显示单位。

CU

PeriodTime

string

周期时间单位,例如 hour 表示小时。

hour

PurchaseTime

integer

购买时间,使用 Unix 时间戳,单位为毫秒。

1678939036000

StartTime

integer

生效时间,使用 Unix 时间戳,单位为毫秒。

1678939035000

EndTime

integer

失效时间,使用 Unix 时间戳,单位为毫秒。

1710604800000

Region

string

地域。

*

Template

object

模板。

Code

string

属性编码。

alb_cubag*******

Name

string

属性名称。

中国内地区域

TemplateCode

string

模板 code

FPT_armsappbag_deadlineAcc_bj

TemplateName

string

模板名

new_test

AccountName

string

账号名。

icloudtest

EnableRenew

boolean

能否续费。

false

EnableUpgrade

boolean

能否升级。

false

EnableExchange

boolean

能否换购。

false

ExchangeCommodityCode

string

换购商品编码。

null

RegionName

string

地域名称

cn-qingdao

DeductRegions

array<object>

可抵扣地域列表。

object

Name

string

可抵扣地域。

北京

Code

string

可抵扣地域 Code。

cn-beijing

InitCapacityBaseValue

string

初始容量基准值。

1000.000000

InitCapacityBaseUnit

string

初始容量基准单位。

CU

CurrCapacityBaseValue

string

当前容量基准值。

1000.000000

CurrCapacityBaseUnit

string

当前容量基准单位。

CU

periodCapacityBaseValue

string

周期容量基准值。

1000.000000

periodCapacityBaseUnit

string

周期容量基准单位。

CU

AutoPurchase

object

自动购买信息。

SupportAutoPurchase

boolean

是否支持自动购买。

SettingAutoPurchase

boolean

是否已设置自动购买。

AlreadyAutoPurchase

boolean

是否已自动购买。

EnableDeductRule

boolean

是否启用抵扣规则。

示例

正常返回示例

JSON格式

{
  "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
  "CurrentPage": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "Data": [
    {
      "AccountId": 1990699401005016,
      "Product": {
        "Code": "slb",
        "Name": "负载均衡"
      },
      "ProductName": "性能测试",
      "ProductCode": "pts",
      "Commodity": {
        "Code": "slb_albcubag_dp_cn",
        "Name": "ALB资源包"
      },
      "CommodityCode": "pts",
      "CommodityName": "性能测试",
      "InstanceId": "alb_cubag*******",
      "Spec": "*",
      "Status": {
        "Code": "valid",
        "Name": "有效"
      },
      "StatusCode": "valid",
      "StatusName": "有效",
      "CapacityType": {
        "Code": "deadlineAcc",
        "Name": "总量递减型"
      },
      "CapacityTypeCode": "deadlineAcc",
      "CapacitiyTypeName": "总量递减型",
      "CycleType": {
        "Code": "hour",
        "Name": "小时"
      },
      "CycleTypeCode": "hour",
      "CycleTypeName": "小时",
      "InitCapacityViewValue": "1000.000000",
      "InitCapacityViewUnit": "CU",
      "CurrCapacityViewValue": "1000.000000",
      "CurrCapacityViewUnit": "CU",
      "PeriodCapacityViewValue": "1000.000000",
      "PeriodCapacityViewUnit": "CU",
      "PeriodTime": "hour",
      "PurchaseTime": 1678939036000,
      "StartTime": 1678939035000,
      "EndTime": 1710604800000,
      "Region": "*",
      "Template": {
        "Code": "alb_cubag*******",
        "Name": "中国内地区域"
      },
      "TemplateCode": "FPT_armsappbag_deadlineAcc_bj",
      "TemplateName": "new_test",
      "AccountName": "icloudtest",
      "EnableRenew": false,
      "EnableUpgrade": false,
      "EnableExchange": false,
      "ExchangeCommodityCode": "null",
      "RegionName": "cn-qingdao",
      "DeductRegions": [
        {
          "Name": "北京",
          "Code": "cn-beijing"
        }
      ],
      "InitCapacityBaseValue": "1000.000000",
      "InitCapacityBaseUnit": "CU",
      "CurrCapacityBaseValue": "1000.000000",
      "CurrCapacityBaseUnit": "CU",
      "periodCapacityBaseValue": "1000.000000",
      "periodCapacityBaseUnit": "CU",
      "AutoPurchase": {
        "SupportAutoPurchase": true,
        "SettingAutoPurchase": true,
        "AlreadyAutoPurchase": true
      },
      "EnableDeductRule": true
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 MissingParameter The specified request lacks essential parameters.
400 NotAuthorized You are not authorized to call the API operation. Please check whether RAM user has the permission or check whether ownerId and callerId have been given the appropriate permission.
500 InternalError The request processing has failed due to some unknown error.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。