检索存储后端的卷
GET /accounts/{account_id}/topology/v1/storageBackends/{storageBackend_id}/volumes/{volume_id}
返回 JSON 响应正文中存储的 Volume API 资源。
参数
| 名称 | Type | 在 | Required | Description |
|---|---|---|---|---|
account_id |
string |
path |
True |
包含帐户资源的 ID
|
storageBackend_id |
string |
path |
True |
包含 storageBackend 资源的 ID |
volume_id |
string |
path |
True |
要列出的卷集合的 ID |
响应
Status: 200, Returns the stored Volume API resource in the JSON response body.
| 名称 | Type | Required | Description |
|---|---|---|---|
type |
string |
True |
资源的媒体类型。定义的值为:
|
version |
string |
True |
资源的版本。定义的值为:
|
id |
string |
True |
资源的全局唯一标识符。定义的值为:
|
name |
string |
True |
包含卷名称的 JSON 字符串。定义的值为:
|
状态 |
string |
False |
JSON 字符串,包含指示卷操作状态的值。 |
大小 |
string |
False |
包含卷大小的 JSON 字符串。 |
已用 |
数字 |
False |
包含已配置卷使用的配额字节数的 JSON 数字。 |
usedPercentage |
数字 |
False |
包含已用卷百分比的 JSON 数字。 |
总计 |
数字 |
False |
包含已配置卷的总字节数的 JSON 编号。 |
creationToken |
string |
False |
包含卷的创建令牌的 JSON 字符串。定义的值为:
|
snapshotPossible |
string |
False |
JSON 字符串,指示驱动程序是否可以执行卷的快照。定义的值为:
|
storageClass |
string |
False |
包含卷的存储类的 JSON 字符串。
|
pvcName |
string |
False |
包含卷的 PersistentVolumeClaim (PVC) 名称的 JSON 字符串。
|
internalName |
string |
False |
包含目标存储群集上卷的内部名称的 JSON 字符串(如果可用)。此名称来自 Kubernetes CSI 驱动程序。
|
appsUsing |
数组[string] |
True |
JSON 字符串的 JSON 数组,每个数组都包含正在使用该卷的应用程序的 ID。定义的值为:
|
storageBackendID |
string |
False |
JSON 字符串,包含提供卷的存储后端的 ID。定义的值为:
|
编排器 |
string |
False |
包含此卷的编排器的 JSON 字符串。这将为 Astra Data Store 卷定义。定义的值为:
|
serviceLevel |
string |
False |
包含在存储后端级别为此卷定义的服务质量 (QoS) 策略的 JSON 字符串。这将为 Astra Data Store 卷定义。 |
exportPolicy |
string |
False |
包含与此卷关联的导出策略的 JSON 字符串。这将为 Astra Data Store 卷定义。 |
nodeId |
string |
False |
包含为卷提供服务的节点 ID 的 JSON 字符串。这将为 Astra Data Store 卷定义。定义的值为:
|
healthState |
string |
False |
JSON 字符串,包含指示卷健康状态的值。这将为 Astra Data Store 卷定义。定义的值为:
|
healthStateDetails |
True |
JSON 对象的 JSON 数组,列出有关当前运行状况的其他详细信息。如果没有可用的详细信息,此数组将为空。
|
|
元数据 |
True |
与资源关联的客户端和服务指定的元数据。定义的值为:
|
响应示例
{
"type": "application/astra-volume",
"version": "1.2",
"id": "ab5c9fb8-ddba-526f-8bd3-8d5b72cf4f7f",
"name": "myVolume",
"state": "ready",
"size": "512 GiB",
"used": 10000000000,
"usedPercentage": 10,
"total": 10000000000,
"creationToken": "ba7d4e0c-6ae3-4b6e-859d-9463e7ca4b4e",
"snapshotPossible": "true",
"storageClass": "gold",
"pvcName": "myVolume",
"internalName": "trident_sd234234_23424_897d_876sd65w",
"appsUsing": [],
"orchestrator": "trident",
"serviceLevel": "gold",
"exportPolicy": "astra-vp-default",
"nodeId": "94d16dd2-9beb-4edb-ab58-1a00e9a90052",
"healthState": "normal",
"healthStateDetails": [],
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
响应
Status: 401, Unauthorized
| 名称 | Type | Required | Description |
|---|---|---|---|
type |
string |
True |
|
标题 |
string |
True |
|
详细信息 |
string |
True |
|
状态 |
string |
True |
|
correlationID |
string |
False |
响应示例
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
响应
Status: 400, Bad request
| 名称 | Type | Required | Description |
|---|---|---|---|
type |
string |
True |
|
标题 |
string |
True |
|
详细信息 |
string |
True |
|
状态 |
string |
True |
|
correlationID |
string |
False |
|
invalidParams |
数组["invalidParams"] |
False |
无效查询参数列表 |
响应示例
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
响应
Status: 403, Forbidden
| 名称 | Type | Required | Description |
|---|---|---|---|
type |
string |
True |
|
标题 |
string |
True |
|
详细信息 |
string |
True |
|
状态 |
string |
True |
|
correlationID |
string |
False |
响应示例
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
错误
Status: 404, Not found
| 名称 | Type | Required | Description |
|---|---|---|---|
type |
string |
True |
|
标题 |
string |
True |
|
详细信息 |
string |
True |
|
状态 |
string |
True |
|
correlationID |
string |
False |
错误响应示例
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
定义
查看定义
additionalDetails
type_astra_stateDetail
| 名称 | Type | Required | Description |
|---|---|---|---|
type |
string |
True |
|
标题 |
string |
True |
|
详细信息 |
string |
True |
|
additionalDetails |
False |
类型 Astra 标签
| 名称 | Type | Required | Description |
|---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_astra_metadata
与资源关联的客户端和服务指定的元数据。定义的值为:
-
符合 Astra 元数据架构
| 名称 | Type | Required | Description |
|---|---|---|---|
labels |
数组["类型 Astra 标签"] |
True |
|
creationTimestamp |
string |
True |
|
modificationTimestamp |
string |
True |
|
已创建 |
string |
True |
|
modifiedBy |
string |
False |
invalidParams
| 名称 | Type | Required | Description |
|---|---|---|---|
name |
string |
True |
无效查询参数的名称 |
原因 |
string |
True |
查询参数无效的原因 |