获取对象存储资源包 | 大装置帮助中心
跳到主要内容

获取对象存储资源包

接口描述​

GET /storage/aoss/v1/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/aossPack/{aoss_pack_name}

请求头（Request Header）​

参考认证（authentication）

请求参数（Request Parameters）​

名称类型必须位置默认值取值范围描述
subscription_namestring是path--订阅标识
resource_group_namestring是path--资源组标识
zonestring是path--可用区
aoss_pack_namestring是path-^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$对象存储资源包名称

请求体（Request Body）​

无

请求示例（Request Example）​

curl --request GET https://management.sensecoreapi.dev/storage/aoss/v1/subscriptions/8d3b64a4-ba5e-4c37-8a0f-65a416988c72/resourceGroups/default/zones/cn-sh-01a/aossPack/c4f8d9e1-e0f2-44bf-aa86-1d443aa0563a \
  -H 'authority: management.sensecoreapi.dev' \
  -H 'content-type: application/json' \
  -H 'Authorization: xxx'

响应参数（Response Parameters）​

名称类型描述
idstring资源包ID
namestring资源包名称
display_namestring资源包别名
descriptionstring资源包描述信息
uidstring资源包实例UUID
resource_typestring资源包类型
creator_idstring创建者标识
owner_idstring拥有者标识
tenant_idstring租户标识
zonestring可用区
statestring资源包状态
sku_idstring云管sku_id
tagsmap资源包标签map<string, string>
propertiesobject资源包属性
order_infoobject订单信息
deletedbool是否删除资源包
create_timestring资源包创建时间
update_timestring资源包最新更新时间

响应参数中state的值，自定义 State类型，是enum类型，有以下不同含义值:​

状态值状态含义
0CREATING创建中（瞬时状态）
1UPDATING更新中（瞬时状态）
2ACTIVE正常
3DELETING删除中（瞬时状态）
4DELETED已删除
5FAILED操作失败（不保存）
6EXPIREDOWNGRADING进入宽限期变更中（瞬时状态）
7EXPIREDOWNGRADED已进入宽限期
8RENEWUPGRADING宽限期续订恢复中（瞬时状态）
9EXPIRESTOPPING进入保留期变更中（瞬时状态）
10EXPIRESTOPPED已进入保留期
11RENEWSTARTING保留期续费恢复中（瞬时状态）
12DOWNGRADING服务降级变更中（瞬时状态）
13DOWNGRADE服务已经降级
14RESTORING服务降级恢复中（瞬时状态）
15ARREARSTOPPING欠费停服变更中（瞬时状态）
16ARREARSTOPPED已欠费停服
17RECHARGESTARTING充值恢复中（瞬时状态）
18RESIZING资源变更中（瞬时状态）
19RESIZECANCELING取消资源变更中（瞬时状态）

响应参数中,properties的字段如下:​

参数名类型必须默认值取值范围描述
resourcesobject是--资源规格属性
storage_classStorageClassUnit是--对象存储资源类型

以上storage_class的值，自定义 StorageClassUnit类型，是enum类型，有以下不同含义值:​

类型值类型含义
0STANDARD标准存储
1ARCHIVE归档存储
2POWERPC标准(PowerPC)
3ALLFLASHTWOCOPIES全闪(二副本)
4STANDARDTWOCOPIES标准(二副本)

响应参数中properties内的resources 的字段如下:​

参数名类型必须默认值取值范围描述
billing_itemsobject是--对象存储资源计费项

以上billing_items 的参数如下:​

参数名类型必须默认值取值范围描述
capacitynumber是--对象存储资源包容量大小
capacity_unitCapacityUnit是--资源包容量单位
requestsnumber是--对象存储资源包请求次数
get_flownumber是--对象存储资源包流量大小
get_flow_unitCapacityUnit是--资源包流量单位
cdn_flownumber是--回源流量包数大小
cdn_flow_unitCapacityUnit是--回源流量包数单位
global_flownumber是--全球加速流量数
global_flow_unitCapacityUnit是--全球加速流量容量单位

以上capacity的值，自定义 CapacityUnit 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0EBEB
1PBPB
2TBTB
3GB千兆字节
4MB兆字节

请求体中,order_info的参数如下:​

参数名类型必须默认值取值范围描述
billing_cycle_numbernumber是--购买时长
auto_renewbool否--自动续费
currency_codestring是--货币代码
payment_channelPaymentChannel是--支付方式
notestring否--订单备注
order_typeOrderType是--订单类型
order_idstring是--订单id
start_timestring是--订单生效日期
payment_modelPaymentModel是--付费类型
billing_modelBillingModel是--计费类型
original_idstring否--合同包ID(专有云订单使用)
end_timestring是--订单结束时间
auto_convert_postpaidbool否--预付费自动转后付费

以上payment_channel的值，自定义 PaymentChannel 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0PC_UNSPECIFIED未指定
1PC_BALANCE余额支付
2PC_CREDIT信用支付
3PC_FROZENACCOUNT冻结款支付
4PC_REMIT_OFFLINE线下汇款
5PC_ALIPAY支付宝支付
6PC_UNIONPAY银联支付
7PC_REMIT_ONLINE在线转账
8PC_CONTRACT合同包支付

以上order_type的值，自定义 OrderType 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0OT_UNSPECIFIED未指定
1OT_ORIGINAL原始订单
2OT_RENEW续费订单
3OT_UPGRADED升配订单
4OT_DOWNGRADED降配订单
5OT_CONTRACT合同订单
6OT_UNSUBSCRIBE退订订单
7OT_RESIZE扩缩容订单

以上payment_model的值，自定义 PaymentModel 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0PM_UNSPECIFIED未指定
1PM_PREPAID预付费
2PM_POSTPAID后付费

以上billing_model的值，自定义 BillingModel 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0BM_UNSPECIFIED未指定
1BM_USAGE按量计费
2BM_MONTHLY包月
3BM_YEARLY包年

响应示例（Response Example）​

{
    "id": "/subscriptions/8d3b64a4-ba5e-4c37-8a0f-65a416988c72/resourceGroups/default/zones/cn-sh-01a/aossPack/c4f8d9e1-e0f2-44bf-aa86-1d443aa0563a",
    "name": "c4f8d9e1-e0f2-44bf-aa86-1d443aa0563a",
    "display_name": "1030自测0924",
    "description": "",
    "uid": "62026f47-5af2-11ee-99d8-c23c07ebcf15",
    "resource_type": "storage.aoss.v1.pack",
    "creator_id": "ef2a500d-81d1-49ee-ae75-5b3790513ba4",
    "owner_id": "ef2a500d-81d1-49ee-ae75-5b3790513ba4",
    "tenant_id": "8d3b64a4-ba5e-4c37-8a0f-65a416988c72",
    "zone": "cn-sh-01a",
    "state": "ACTIVE",
    "sku_id": "14738bce-c170-4098-a9a6-8b4de94e425d",
    "tags": {},
    "properties": {
        "resources": {
            "billing_items": {
                "capacity": 10,
                "capacity_unit": "GB",
                "requests": "100000",
                "get_flow": 10,
                "get_flow_unit": "GB",
                "cdn_flow": 0,
                "cdn_flow_unit": "EB",
                "global_flow": 0,
                "global_flow_unit": "EB"
            }
        },
        "storage_class": "STANDARD"
    },
    "order_info": {
        "billing_cycle_number": 1,
        "auto_renew": true,
        "currency_code": "CNY",
        "payment_channel": "PC_UNSPECIFIED",
        "note": "",
        "order_type": "OT_ORIGINAL",
        "order_id": "a45d1968020942777573376",
        "start_time": "2023-09-24T15:52:36Z",
        "payment_model": "PM_PREPAID",
        "billing_model": "BM_MONTHLY",
        "original_id": "",
        "end_time": "2023-10-24T23:59:59Z",
        "auto_convert_postpaid": false
    },
    "deleted": false,
    "create_time": "2023-09-24T15:53:11.515766Z",
    "update_time": "2023-09-24T15:53:11.699295Z"
}