You need to enable JavaScript to run this app.
导航
大数据文件存储
  • 文档首页
    • /
  • 大数据文件存储

ListAccess

最近更新时间：2023.07.07 16:47:31

首次发布时间：2023.05.18 14:53:13

我的收藏

调用 ListAccess 接口，查询已开启缓存加速功能文件存储实例所挂载的 VPC 列表。

请求参数

Query

参数

类型

是否必填

示例值

说明

FsName

String

是

doc-test-cfs-1

文件存储实例的名称。

返回参数

参数

类型

示例值

说明

Items

List

[access1, access2]

文件存储实例挂载的 VPC 列表。详情请参见 Access 数据结构。

TotalSize

String

2

已挂载的 VPC 总数。

PageNumber

Integer

0

当前页数。

PageSize

Integer

10

每页展示的 VPC 数量。

Access 数据结构

参数

类型

示例值

说明

FsName

String

doc-test-cfs-2

文件存储实例的名称。

AccessId

String

access-**krdgmedx3fow

VPC 挂载后的唯一标识。

AccessAccountId

Integer

210**0903

VPC 的所有者。

AccessServiceName

String

机器学习平台

VPC 的所属服务。

VpcId

String

vpc-id23

VPC ID。

SubnetId

String

subnet-id23

子网 ID。

SecurityGroupId

String

sg-id23

安全组 ID。

VpcRouteEnabled

Boolean

false

是否开启全 VPC 访问实例。

  • true：允许全 VPC 访问实例。
  • false：不允许全 VPC 访问实例。

IsDefault

Boolean

true

是否是创建文件存储实例时默认挂载的 VPC。

  • true：创建时挂载的 VPC
  • false：创建后挂载的 VPC

CreatedTime

String

2022-09-08T15:37:36

VPC 挂载时间。

Status

String

UP

挂载 VPC 的状态。

  • INIT：挂载中
  • CREATING：挂载中
  • UP: 已挂载
  • TO_ENABLE_VPC_ROUTE：开启全 VPC 访问中
  • ENABLING_VPC_ROUTE: 开启全 VPC 访问中
  • TO_DISABLE_VPC_ROUTE: 关闭全 VPC 访问中
  • DISABLING_VPC_ROUTE: 关闭全 VPC 访问中
  • TO_DELETE：卸载中
  • DELETING：卸载中
  • CREATE_FAILED：挂载失败
  • DELETE_FAILED：卸载失败
  • ENABLE_VPC_ROUTE_FAILED: 开启全 VPC 访问失败
  • DISABLE_VPC_ROUTE_FAILED: 关闭全 VPC 访问失败
  • ERROR 异常
  • DOWN 异常

请求示例

GET https://open.volcengineapi.com?Action=ListAccess&Version=2022-02-02&FsName=doc-test-cfs-1
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs

返回示例

{
    "Result": {
        "Items": [
            {
                "AccessId": "access-**rdgmedx3fow",
                "FsName": "doc-test-cfs-1",
                "AccessAccountId": 210**0903,
                "AccessServiceName": null,
                "VpcId": "vpc-id23",
                "SubnetId": "subnet-id23",
                "SecurityGroupId": "sg-id23",
                "VpcRouteEnabled": false,
                "IsDefault": false,
                "CreatedTime": "2023-04-23T19:45:39",
                "Status": "CREATING"
            },
            {
                "AccessId": "access-**66tpmts3h",
                "FsName": "doc-test-cfs-1",
                "AccessAccountId": 21**734,
                "AccessServiceName": null,
                "VpcId": "vpc-**6g3mus",
                "SubnetId": "subnet-**u4pfdmug",
                "SecurityGroupId": "sg-**nu4ziosq9",
                "VpcRouteEnabled": false,
                "IsDefault": true,
                "CreatedTime": "2023-04-23T17:46:15",
                "Status": "UP"
            }
        ],
        "TotalSize": "2",
        "PageNumber": 0,
        "PageSize": 10
    },
    "ResponseMetadata": {
        "RequestId": "2023042319**E06607F9E9",
        "Action": "ListAccess",
        "Version": "2022-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": null
    }
}

错误码

下表列举了本接口的错误码信息。公共错误码信息，请参考公共错误码。

HttpCode

错误码

错误信息

400

EmptyFsName

FsName 为空。

400

InvalidFsName

输入 FsName 时，文件存储实例名称不合法。

  • 文件存储实例名称仅支持字母、数字、英文，且以字母开头。
  • 文件存储实例名称字符长度在 2-63 内。