获取缓存实例列表 | 大装置帮助中心
跳到主要内容

获取缓存实例列表

GET /storage/acs/v1/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/caches

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters

名称类型必须位置默认值取值范围描述
subscription_namestringpath--订阅名称.
resource_group_namestringpath--资源组.
zonestringpath--可用区.
filterstringquery--过滤条件.
order_bystringquery--排序,例:"create_time desc, name".
page_sizeintegerquery--返回当前页的最大条目数.
page_tokenstringquery--从上一个List请求返回的next_page_token值(如果有的话).

请求示例(Request Example)

curl 'https://management.sensecoreapi.tech/rmh/v1/resources:page?filter=resource_type%3D%22storage.acs.v1.cache%22%20AND%20display_name%3D%22%2A%2A%22&page_size=10&page_token=1' \
-X 'POST' \
-H 'authority: management.sensecoreapi.tech' \
-H 'content-length: 0' \
-H 'sec-ch-ua: " Not;A Brand";v="99", "Google Chrome";v="97", "Chromium";v="97"' \
-H 'authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB1YmxpYzpoeWRyYS5qd3QuYWNjZXNzLXRva2VuIiwidHlwIjoiSldUIn0.eyJhdWQiOltdLCJjbGllbnRfaWQiOiI0ZTQxNDg1NC03MjAwLTUwOWYtYjk2MC1mOGIwZGJiYmYzMzEiLCJleHAiOjE2OTU4MDg1NjMsImV4dCI6eyJpc19kZWRpY2F0ZWRfdGVuYW50IjpmYWxzZSwicHJwX2xpc3QiOlsiY24tc2gtMDFhLXBycDAxIiwiY24tc2gtMDFiLXBycDAxIl0sInRlbmFudF9jZXJ0aWZ5X3N0YXR1cyI6dHJ1ZSwidGVuYW50X2NlcnRpZnlfdHlwZSI6ImVudGVycHJpc2UiLCJ0ZW5hbnRfY29kZSI6ImNvZGUxMDEwIiwidGVuYW50X2lkIjoiYzI4ZjE3M2EtOGYxOC00NzRjLTg2NmItNGNlODlhNjEyOTU4IiwidXNlcl9pZCI6ImE1MWIzNDk1LTNiYTEtNGFkZC1iNzYwLTNkMjU3ZTI5OWYzNyIsInVzZXJfdHlwZSI6ImFkbWluIiwidXNlcm5hbWUiOiJyb290MTAxMCJ9LCJpYXQiOjE2OTU3OTc3NjMsImlzcyI6Imh0dHBzOi8vc2lnbmluLnNlbnNlY29yZS50ZWNoLyIsImp0aSI6IjhmYmVjODA2LTM2OWEtNGY4OC04NDM4LTY5ZTA2MzdkZGU1MyIsIm5iZiI6MTY5NTc5Nzc2Mywic2NwIjpbIm9wZW5pZCIsIm9mZmxpbmUiLCJvZmZsaW5lX2FjY2VzcyJdLCJzdWIiOiJyb290MTAxMDpjMjhmMTczYS04ZjE4LTQ3NGMtODY2Yi00Y2U4OWE2MTI5NTg6YTUxYjM0OTUtM2JhMS00YWRkLWI3NjAtM2QyNTdlMjk5ZjM3In0.r2B4vbJKlWhf-_fHqMABvLRgPswnx0UlxEQPCYb4vFqghqim0zxa8JYufefpu8i75tZP-Svdlh0Dj_rlSGxYMdirleu7ouHPJR6bOpM8WDhOcrQ3FbZEVgvFOAVI5NYGuRuvv1zQTFZIE3wvoqcfcL7U540MmB1oh4wbxTuCWkiK4o8S3BlSBme-gEZUcia7sYeQobqweAhUkp3fw3c8l5Fy5u0A98EvfYuQxFG3uGYYb2PWfS6Eyf9VAF7TIYo4mPQQDWJ4DIR-3DIx1BiJ1ldk2k68Cz1RGE5Xa4c2IE9OmObkzMpWNx8DygBcekvGWT_vfVFiEW5AcTgDo00tfi71ZQ3Wc2DxxHatfglrtkaHTO-xJpxzEzX-e3vvx7M0ZeGQA5U0DHjaAi603owLZpQSeBytSRvcs3OrgN-4-tZs6mAxNC8-3tFbUCHWQrHLJ9X0_NErxniHGNywaPiWYEjV08wcdpb6nGV6zt8fzMhQxhPtz9HJrvIYa0KlGpPowInCorz-vhCasK2cAxOqXkKL8ObWpQB5tCBIsblqovlswpgXwnBYljyVHn2lK6HoQ5HOs704NHpKQ8VrGTo-NWG4b-o_4qfoqzj9QLNJkuJaut44mXCDTeB2XHYxvEPTYLq9gLqdYLoT0yea3mkvj7Z2cZlZ8-LeVoMKtNum_m8' \
-H 'accept-language: zh-CN' \
-H 'sec-ch-ua-mobile: ?0' \
-H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36' \
-H 'sec-ch-ua-platform: "macOS"' \
-H 'accept: */*' \
-H 'origin: https://console.sensecore.tech' \
-H 'sec-fetch-site: cross-site' \
-H 'sec-fetch-mode: cors' \
-H 'sec-fetch-dest: empty' \
-H 'referer: https://console.sensecore.tech/' \
--compressed

响应(Response)

名称类型描述
resourcesarray[object]缓存实例资源详情列表.
next_page_tokenstring下一页的token.
total_sizeinteger缓存实例资源总数.

其中,resources的参数如下

名称类型描述
idstring缓存实例资源id.
namestring缓存实例资源名称,需符合正则:^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
display_namestring缓存实例资源别名.
descriptionstring缓存实例资源描述.
uidstring缓存实例资源uuid.
resource_typestring缓存实例资源类型, 例子: storage.acs.v1.cache.
creator_idstring缓存实例创建用户id.
owner_idstring缓存实例所有者id.
tenant_idstring租户id.
zonestring可用区.
statestring缓存实例状态.
sku_idstring最小库存单元id.
tagsobject缓存实例资源标签.
propertiesobject缓存实例规格属性.
order_infoobject订单信息.
deletedboolean缓存实例资源是否删除.
create_timestring缓存实例资源创建时间.
update_timestring缓存实例资源更新时间.

其中,state有如下情况

状态含义
CREATING创建中(默认值)
UPDATING更新中
ACTIVE已激活
DELETING删除中
DELETED已删除
FAILED失败
EXPIRESTOPPING到期停服中
EXPIRESTOPPED到期已停服
RENEWSTARTING续订恢复中

其中,properties的参数如下

名称类型必须默认值取值范围描述
resourcesobject--规格属性.
bucket_pathstring--租户内加速桶路径.
other_bucket_pathstring--跨租户加速桶路径.
third_party_bucket_pathstring--其他加速路径.

其中,resources的参数如下

名称类型必须默认值取值范围描述
billing_itemsstring--计费项.

其中,billing_items的参数如下

名称类型必须默认值取值范围描述
capacitystring--资源容量.
capacity_unitstring--资源容量单位.

其中,order_info的参数如下

名称类型描述
billing_cycle_numberinteger购买时长.
auto_renewboolean自动续费.
currency_codestring货币代码.
payment_channelstring支付方式.
notestring订单备注.
order_typestring订单类型.
order_idstring订单id.
start_timestring订单生效日期.
payment_modelstring付费类型.
billing_modelstring计费类型.
original_idstring合同包ID.
end_timestring订单结束时间.

其中,payment_channel有如下情况

状态含义
PC_UNSPECIFIED未指定
PC_BALANCE余额支付
PC_CREDIT信用支付
PC_FROZENACCOUNT冻结款支付
PC_REMIT_OFFLINE线下汇款
PC_ALIPAY支付宝支付
PC_UNIONPAY银联支付
PC_REMIT_ONLINE在线转账
PC_CONTRACT合同包支付

其中,order_type有如下情况

状态含义
OT_UNSPECIFIED未指定
OT_ORIGINAL原始订单
OT_RENEW续费订单
OT_UPGRADED升配订单
OT_DOWNGRADED降配订单
OT_CONTRACT合同订单
OT_UNSUBSCRIBE退订订单
OT_RESIZE扩缩容订单

其中,payment_model有如下情况

状态含义
PM_UNSPECIFIED未指定
PM_PREPAID预付
PM_POSTPAID后付费

其中,billing_model有如下情况

状态含义
BM_UNSPECIFIED未指定
BM_USAGE按量计费
BM_MONTHLY包月
BM_YEARLY包年

响应示例(Response Example)

{
"resources": [
{
"id": "e21fcef0-5d05-11ee-8c64-8a688bd26f60",
"rid": "/subscriptions/c28f173a-8f18-474c-866b-4ce89a612958/resourceGroups/default/zones/cn-sh-01a/caches/cd57714a-2d5a-4f8f-b3e8-316abac1b87b",
"name": "cd57714a-2d5a-4f8f-b3e8-316abac1b87b",
"display_name": "test_create",
"type": "storage.acs.v1.cache",
"state": "ACTIVE",
"zone": "cn-sh-01a",
"properties": "{\"resources\": {\"billing_items\": {\"capacity\": 121, \"capacity_unit\": \"GB\"}}, \"bucket_path\": [\"aoss://aicl\"], \"other_bucket_path\": [], \"third_party_bucket_path\": []}",
"sku_id": "c012f40c-99c2-4cd3-b9a4-92b12472e774",
"subscription_name": "c28f173a-8f18-474c-866b-4ce89a612958",
"resource_group_name": "default",
"resource_group_id": "5598bd4a-4c24-4b13-8182-e79625643cd8",
"resource_group_display_name": "默认资源组",
"resource_group_rid": "/subscriptions/c28f173a-8f18-474c-866b-4ce89a612958/resourceGroups/default",
"creator_id": "",
"owner_id": "a51b3495-3ba1-4add-b760-3d257e299f37",
"order_info": {
"billing_cycle_number": 0,
"auto_renew": true,
"currency_code": "CNY",
"payment_channel": "PC_BALANCE",
"note": "",
"order_type": "OT_ORIGINAL",
"order_id": "37741968978409655455744",
"start_time": "2023-09-27T07:17:15Z",
"payment_model": "PM_POSTPAID",
"billing_model": "BM_USAGE",
"original_id": "",
"end_time": "9999-12-31T23:59:59Z",
"auto_convert_postpaid": false
},
"deleted": false,
"create_time": "2023-09-27T07:17:14.805131Z",
"update_time": "2023-09-27T07:17:14.905746Z"
},
{
"id": "628748df-3ff5-11ee-97b7-8e81a93568bd",
"rid": "/subscriptions/c28f173a-8f18-474c-866b-4ce89a612958/resourceGroups/default/zones/cn-sh-01a/caches/f2069f91-4e06-43f8-b812-5bd3b813443b",
"name": "f2069f91-4e06-43f8-b812-5bd3b813443b",
"display_name": "zhangxy_test821",
"type": "storage.acs.v1.cache",
"state": "FAILED",
"zone": "cn-sh-01a",
"properties": "{\"resources\": {\"billing_items\": {\"capacity\": 123, \"capacity_unit\": \"GB\"}}, \"bucket_path\": [\"aoss://acsan0530ppc\"], \"other_bucket_path\": [], \"third_party_bucket_path\": []}",
"sku_id": "c012f40c-99c2-4cd3-b9a4-92b12472e774",
"subscription_name": "c28f173a-8f18-474c-866b-4ce89a612958",
"resource_group_name": "default",
"resource_group_id": "5598bd4a-4c24-4b13-8182-e79625643cd8",
"resource_group_display_name": "默认资源组",
"resource_group_rid": "/subscriptions/c28f173a-8f18-474c-866b-4ce89a612958/resourceGroups/default",
"creator_id": "",
"owner_id": "a51b3495-3ba1-4add-b760-3d257e299f37",
"order_info": {
"billing_cycle_number": 0,
"auto_renew": true,
"currency_code": "CNY",
"payment_channel": "PC_BALANCE",
"note": "",
"order_type": "OT_ORIGINAL",
"order_id": "37741955574799183745025",
"start_time": "2023-08-21T07:36:04Z",
"payment_model": "PM_POSTPAID",
"billing_model": "BM_USAGE",
"original_id": "",
"end_time": "9999-12-31T23:59:59Z",
"auto_convert_postpaid": false
},
"deleted": false,
"create_time": "2023-08-21T07:36:05.052834Z",
"update_time": "2023-08-29T00:34:58.498040Z"
}
],
"total_size": 7,
"next_page_token": "2"
}