diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/nas/2017-06-26 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/nas/2017-06-26')
| -rw-r--r-- | data/zh_cn/nas/2017-06-26/api-docs.php | 22995 |
1 files changed, 22995 insertions, 0 deletions
diff --git a/data/zh_cn/nas/2017-06-26/api-docs.php b/data/zh_cn/nas/2017-06-26/api-docs.php new file mode 100644 index 0000000..f051639 --- /dev/null +++ b/data/zh_cn/nas/2017-06-26/api-docs.php @@ -0,0 +1,22995 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'NAS', + 'version' => '2017-06-26', + ], + 'directories' => [ + [ + 'id' => 100612, + 'title' => '服务操作', + 'type' => 'directory', + 'children' => [ + 'OpenNASService', + ], + ], + [ + 'id' => 100610, + 'title' => '地域', + 'type' => 'directory', + 'children' => [ + 'DescribeZones', + 'DescribeRegions', + ], + ], + [ + 'id' => 100636, + 'title' => '文件系统', + 'type' => 'directory', + 'children' => [ + 'CreateFileSystem', + 'DeleteFileSystem', + 'ModifyFileSystem', + 'DescribeFileSystems', + 'UpgradeFileSystem', + 'DescribeFilesystemsAssociatedHpnZones', + ], + ], + [ + 'id' => 100670, + 'title' => '挂载点', + 'type' => 'directory', + 'children' => [ + 'CreateMountTarget', + 'DeleteMountTarget', + 'ModifyMountTarget', + 'DescribeMountTargets', + 'DescribeMountedClients', + ], + ], + [ + 'id' => 190204, + 'title' => '接入点', + 'type' => 'directory', + 'children' => [ + 'CreateAccessPoint', + 'ModifyAccessPoint', + 'DescribeAccessPoints', + 'DescribeAccessPoint', + 'DeleteAccessPoint', + 'CreateDir', + ], + ], + [ + 'id' => 100622, + 'title' => '权限组', + 'type' => 'directory', + 'children' => [ + 'CreateAccessGroup', + 'DeleteAccessGroup', + 'ModifyAccessGroup', + 'DescribeAccessGroups', + 'CreateAccessRule', + 'DeleteAccessRule', + 'ModifyAccessRule', + 'DescribeAccessRules', + ], + ], + [ + 'id' => 100659, + 'title' => '快照', + 'type' => 'directory', + 'children' => [ + 'CreateSnapshot', + 'DeleteSnapshot', + 'DescribeSnapshots', + 'CreateAutoSnapshotPolicy', + 'DeleteAutoSnapshotPolicy', + 'ModifyAutoSnapshotPolicy', + 'ApplyAutoSnapshotPolicy', + 'CancelAutoSnapshotPolicy', + 'DescribeAutoSnapshotPolicies', + 'DescribeAutoSnapshotTasks', + 'ResetFileSystem', + ], + ], + [ + 'id' => 100652, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + ], + ], + [ + 'id' => 168742, + 'title' => '配额', + 'type' => 'directory', + 'children' => [ + 'SetDirQuota', + 'CancelDirQuota', + 'DescribeDirQuotas', + ], + ], + [ + 'id' => 100631, + 'title' => '生命周期管理', + 'type' => 'directory', + 'children' => [ + 'CreateLifecyclePolicy', + 'DeleteLifecyclePolicy', + 'ModifyLifecyclePolicy', + 'GetDirectoryOrFileProperties', + 'DescribeLifecyclePolicies', + 'CreateLifecycleRetrieveJob', + 'CancelLifecycleRetrieveJob', + 'RetryLifecycleRetrieveJob', + 'ListLifecycleRetrieveJobs', + 'ListDirectoriesAndFiles', + ], + ], + [ + 'id' => 168743, + 'title' => '回收站', + 'type' => 'directory', + 'children' => [ + 'EnableRecycleBin', + 'DisableAndCleanRecycleBin', + 'UpdateRecycleBinAttribute', + 'GetRecycleBinAttribute', + 'CreateRecycleBinRestoreJob', + 'CreateRecycleBinDeleteJob', + 'CancelRecycleBinJob', + 'ListRecycleBinJobs', + 'ListRecentlyRecycledDirectories', + 'ListRecycledDirectoriesAndFiles', + ], + ], + [ + 'id' => 168744, + 'title' => 'SMB AD ACL', + 'type' => 'directory', + 'children' => [ + 'EnableSmbAcl', + 'DisableSmbAcl', + 'ModifySmbAcl', + 'DescribeSmbAcl', + 'CreateFile', + ], + ], + [ + 'id' => 180307, + 'title' => 'NFS NAS ACL', + 'type' => 'directory', + 'children' => [ + 'EnableNfsAcl', + 'DisableNfsAcl', + 'DescribeNfsAcl', + ], + ], + [ + 'id' => 180313, + 'title' => '日志管理', + 'type' => 'directory', + 'children' => [ + 'CreateLogAnalysis', + 'DeleteLogAnalysis', + 'DescribeLogAnalysis', + ], + ], + [ + 'id' => 168800, + 'title' => '文件集', + 'type' => 'directory', + 'children' => [ + 'CreateFileset', + 'DeleteFileset', + 'ModifyFileset', + 'GetFileset', + 'DescribeFilesets', + 'SetFilesetQuota', + 'CancelFilesetQuota', + ], + ], + [ + 'id' => 168745, + 'title' => '数据流动', + 'type' => 'directory', + 'children' => [ + 'CreateDataFlow', + 'DeleteDataFlow', + 'ModifyDataFlow', + 'DescribeDataFlows', + 'StopDataFlow', + 'StartDataFlow', + 'CreateDataFlowTask', + 'CreateDataFlowSubTask', + 'CancelDataFlowTask', + 'CancelDataFlowSubTask', + 'DescribeDataFlowTasks', + 'DescribeDataFlowSubTasks', + 'ApplyDataFlowAutoRefresh', + 'CancelDataFlowAutoRefresh', + 'ModifyDataFlowAutoRefresh', + ], + ], + [ + 'id' => 189081, + 'title' => '资源组', + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 168746, + 'title' => '协议服务', + 'type' => 'directory', + 'children' => [ + 'CreateProtocolService', + 'DeleteProtocolService', + 'ModifyProtocolService', + 'DescribeProtocolService', + 'CreateProtocolMountTarget', + 'DeleteProtocolMountTarget', + 'ModifyProtocolMountTarget', + 'DescribeProtocolMountTarget', + 'GetProtocolMountTarget', + ], + ], + [ + 'id' => 243535, + 'title' => '虚拟存储通道', + 'type' => 'directory', + 'children' => [ + 'DetachVscFromFilesystems', + 'AttachVscToFilesystems', + 'DescribeFilesystemsVscAttachInfo', + ], + ], + [ + 'id' => 168697, + 'title' => '其他-不发布文档', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 100648, + 'title' => '黑名单', + 'type' => 'directory', + 'children' => [ + 'AddClientToBlackList', + 'DescribeBlackListClients', + 'RemoveClientFromBlackList', + ], + ], + [ + 'id' => 100617, + 'title' => 'LDAP', + 'type' => 'directory', + 'children' => [ + 'CreateLDAPConfig', + 'DeleteLDAPConfig', + 'ModifyLDAPConfig', + ], + ], + 'DescribeFileSystemStatistics', + 'DescribeStoragePackages', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OpenNASService' => [ + 'summary' => '开通NAS服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13981', + 'abilityTreeNodes' => [ + 'FEATUREnasVB8QSJ', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '开通服务接口', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '427DB0B3-9436-4A3C-B2BC-B961F95E****', + ], + 'OrderId' => [ + 'description' => '开通服务的订单号。', + 'type' => 'string', + 'example' => '20671870151****', + ], + 'AccessDeniedDetail' => [ + 'description' => '权限校验失败详情。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "178321033379****",'."\n" + .' "EncodedDiagnosticMessage": "AJpt/382mjxDSIYIqa/cUIFvOg9tajlLyN+LJA0C78kWfKIl****",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "21794847602038****",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "nas:OpenNASService"'."\n" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ORDER.OPEND', + 'errorMessage' => 'You have already open the service. Go to the console to start using it.', + ], + [ + 'errorCode' => 'InvalidIntlAccount.NotComplete', + 'errorMessage' => 'Intl account is not complete.', + ], + ], + 500 => [ + [ + 'errorCode' => 'OpenNasService.GetCommodityInfoFail', + 'errorMessage' => 'Fail to get commodity info for open nas service.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"427DB0B3-9436-4A3C-B2BC-B961F95E****\\",\\n \\"OrderId\\": \\"20671870151****\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"178321033379****\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AJpt/382mjxDSIYIqa/cUIFvOg9tajlLyN+LJA0C78kWfKIl****\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"21794847602038****\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"nas:OpenNASService\\\\\\"\\\\n }\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenNASServiceResponse>\\n <RequestId>427DB0B3-9436-4A3C-B2BC-B961F95E****</RequestId>\\n <OrderId>20671870151****</OrderId>\\n</OpenNASServiceResponse>","errorExample":""}]', + 'title' => '开通NAS服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeZones' => [ + 'summary' => '查询一个地域下的所有可用区及可用区所支持的文件系统类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13964', + 'abilityTreeNodes' => [ + 'FEATUREnasQG6YBL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区所在的地域ID。'."\n" + ."\n" + .'您可以调用DescribeRegions查看最新地域列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。'."\n" + .'- cpfs：文件存储CPFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A70BEE5D-76D3-49FB-B58F-1F398211****', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Performance' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Protocol' => [ + 'description' => '接口预留参数，暂未生效，您无需关注。', + 'type' => 'array', + 'items' => [ + 'description' => '接口预留参数，暂未生效，您无需关注。', + 'type' => 'string', + 'example' => 'nfs', + ], + ], + ], + ], + 'Capacity' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Protocol' => [ + 'description' => '接口预留参数，暂未生效，您无需关注。', + 'type' => 'array', + 'items' => [ + 'description' => '接口预留参数，暂未生效，您无需关注。', + 'type' => 'string', + 'example' => 'nfs', + ], + ], + ], + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'InstanceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceType' => [ + 'description' => '实例类型信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'description' => '存储类型。'."\n" + ."\n" + .'- 当FileSystemType=standard时，包括：Performance（性能型）、Capacity（容量型）。'."\n" + .'- 当FileSystemType=extreme时，包括：standard（标准型）、advance（高级型）。'."\n" + .'- 当FileSystemType=cpfs时，包括：advance_100（100 MB/s/TiB基线）、advance_200（200 MB/s/TiB基线）。', + 'type' => 'string', + 'example' => 'Capacity', + ], + 'ProtocolType' => [ + 'description' => '文件传输协议类型。'."\n" + ."\n" + .'- 当FileSystemType=standard时，包括：nfs、smb。'."\n" + .'- 当FileSystemType=extreme时，包括：nfs。'."\n" + .'- 当FileSystemType=cpfs时，包括：cpfs。', + 'type' => 'string', + 'example' => 'nfs', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidRegionId.NotFound', + 'errorMessage' => 'The specified Region is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A70BEE5D-76D3-49FB-B58F-1F398211****\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"Performance\\": {\\n \\"Protocol\\": [\\n \\"nfs\\"\\n ]\\n },\\n \\"Capacity\\": {\\n \\"Protocol\\": [\\n \\"nfs\\"\\n ]\\n },\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"InstanceTypes\\": {\\n \\"InstanceType\\": [\\n {\\n \\"StorageType\\": \\"Capacity\\",\\n \\"ProtocolType\\": \\"nfs\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeZonesResponse>\\n <RequestId>A70BEE5D-76D3-49FB-B58F-1F398211****</RequestId>\\n <Zones>\\n <Performance>nfs</Performance>\\n <Capacity>nfs</Capacity>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n <InstanceTypes>\\n <StorageType>Capacity</StorageType>\\n <ProtocolType>nfs</ProtocolType>\\n </InstanceTypes>\\n </Zones>\\n</DescribeZonesResponse>","errorExample":""}]', + 'title' => '查询可用区', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRegions' => [ + 'summary' => '查询可以使用的阿里云地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13959', + 'abilityTreeNodes' => [ + 'FEATUREnasQG6YBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页包含的地域数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值范围：'."\n" + .'取值：'."\n" + .'- all：所有类型。'."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。'."\n" + .'- cpfs：CPFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + 'cpfs', + 'all', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的地域数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A70BEE5D-76D3-49FB-B58F-1F398211****', + ], + 'PageSize' => [ + 'description' => '每页包含的地域数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => 'East China 1', + ], + 'RegionEndpoint' => [ + 'description' => '地域对应的接入地址（Endpoint）。', + 'type' => 'string', + 'example' => 'nas.cn-hangzhou.aliyuncs.com', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"A70BEE5D-76D3-49FB-B58F-1F398211****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"LocalName\\": \\"East China 1\\",\\n \\"RegionEndpoint\\": \\"nas.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>A70BEE5D-76D3-49FB-B58F-1F398211****</RequestId>\\n<PageNumber>1</PageNumber>\\n<Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>nas.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>East China 1</LocalName>\\n </Region>\\n</Regions>","errorExample":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DescribeRegionsResponse>\\n <PageNumber>1</PageNumber>\\n <TotalCount>4</TotalCount>\\n <PageSize>2</PageSize>\\n <RequestId>A70BEE5D-76D3-49FB-B58F-1F398211A5C3</RequestId>\\n <Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>nas.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n\\t <LocalName>华东1</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n\\t <RegionEndpoint>nas.cn-shanghai.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2</LocalName>\\n </Region>\\n </Regions>\\n</DescribeRegionsResponse>\\n"}]', + 'title' => '查询地域', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateFileSystem' => [ + 'summary' => '创建一个文件系统。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13930', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。'."\n" + .'- cpfs：文件存储CPFS（本地冗余版本）。'."\n" + .'- cpfsse: 文件存储CPFS SE（同城冗余版本）。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + 'cpfs', + 'cpfsse', + ], + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '计费类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- PayAsYouGo（默认值）：按量付费。'."\n" + .'- Subscription：包年包月。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + 'default' => 'PayAsYouGo', + 'enum' => [ + 'PayAsYouGo', + 'Subscription', + ], + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '包年包月时长。'."\n" + ."\n" + .'单位：月，当ChargeType=Subscription时必填且有效。'."\n" + ."\n" + .'当包年包月实例到期时未进行续费，实例到期会自动释放。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Capacity', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统容量。单位：GiB。'."\n" + .'当FileSystemType=extreme、cpfs或cpfsse时必填且有效。'."\n" + ."\n" + .'可选值请参考购买页面的实际规格：'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- [极速型NAS按量付费购买页面](https://common-buy.aliyun.com/?commodityCode=nas_extreme_post#/buy)'."\n" + .'- [并行文件系统CPFS按量付费购买页面](https://common-buy.aliyun.com/?commodityCode=nas_cpfs_post#/buy)'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- [极速型NAS按量付费购买页面](https://common-buy-intl.alibabacloud.com/?commodityCode=nas_extpost_public_intl#/buy)'."\n" + ."\n" + .'- [并行文件系统CPFS按量付费购买页面](https://common-buy-intl.alibabacloud.com/?spm=5176.nas_overview.0.0.7ea01dbft0dTui&commodityCode=nas_cpfspost_public_intl#/buy)'."\n" + .'</props>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统吞吐上限。'."\n" + ."\n" + .'单位：MB/s'."\n" + ."\n" + .'具体可选规格值请参考购买页面的实际规格。'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'[并行文件系统CPFS按量付费购买页面](https://common-buy.aliyun.com/?commodityCode=nas_cpfs_post#/buy)'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'[并行文件系统CPFS按量付费购买页面](https://common-buy-intl.alibabacloud.com/?spm=5176.nas_overview.0.0.7ea01dbft0dTui&commodityCode=nas_cpfspost_public_intl#/buy)'."\n" + ."\n" + .'</props>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '150', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型。'."\n" + ."\n" + .'- 当FileSystemType=standard时，取值：Performance（性能型）、Capacity（容量型）、Premium（高级型）。'."\n" + .'- 当FileSystemType=extreme时，取值：standard（标准型）、advance（高级型）。'."\n" + .'- 当FileSystemType=cpfs时，取值：advance_100（100 MB/s/TiB基线）、advance_200（200 MB/s/TiB基线）、economic（经济型）。'."\n" + .'- 当FileSystemType=cpfsse时，取值：advance_100（100 MB/s/TiB基线）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Performance', + 'enum' => [ + 'Premium', + 'Performance', + 'Capacity', + 'standard', + 'advance', + 'NasPlusSmartCache', + 'advance_100', + 'advance_200', + 'economic', + ], + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + ."\n" + .'可用区是指在同一地域内，电力和网络互相独立的物理区域。'."\n" + ."\n" + .'当FileSystemType=standard时，该参数非必选，默认根据ProtocolType及StorageType配置随机选择一个符合条件的可用区。'."\n" + ."\n" + .'当FileSystemType=extreme或FileSystemType=cpfs时，该参数必选。'."\n" + ."\n" + .'> - 同一地域不同可用区之间的文件系统与ECS云服务器互通。'."\n" + .'> - 建议文件系统与云服务器ECS属于同一可用区，避免跨可用区产生的时延。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件传输协议类型。'."\n" + ."\n" + .'- 当FileSystemType=standard时，取值：NFS、SMB。'."\n" + .'- 当FileSystemType=extreme时，取值：NFS。'."\n" + .'- 当FileSystemType=cpfs时，取值：cpfs。'."\n" + .'- 当FileSystemType=cpfsse时，取值：cpfs。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFS', + 'enum' => [ + 'NFS', + 'SMB', + 'NASPLUS', + 'cpfs', + ], + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统是否加密。'."\n" + ."\n" + .'使用KMS服务托管密钥，对文件系统落盘数据进行加密存储。在读写加密数据时，无需解密。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- 0（默认值）：不加密。'."\n" + .'- 1：NAS托管密钥。当FileSystemType=standard或extreme时，支持NAS托管密钥。'."\n" + .'- 2：用户管理密钥。当FileSystemType=standard或extreme时，支持用户管理密钥。'."\n" + ."\n" + .'> - 极速型NAS：除华东1金融云外的所有地域支持用户管理密钥（KMS）功能。'."\n" + .'> - 通用型NAS：所有地域支持用户管理密钥（KMS）功能。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => '快照ID。'."\n" + ."\n" + .'仅支持存储规格为高级型的极速型NAS。'."\n" + .'>通过快照创建文件系统，创建的文件系统版本和快照源文件系统版本一致。例如：快照的源文件系统版本是1，需要创建版本2的文件系统，可以先通过快照创建一个文件系统A，然后再创建一个满足版本2配置的文件系统B，把文件系统A中的数据拷贝至文件系统B，拷贝完成后把业务迁移到文件系统B即可。', + 'type' => 'string', + 'required' => false, + 'example' => 's-extreme-snapsho****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'- 当FileSystemType=cpfs或cpfsse时，必须配置此参数。'."\n" + .'- 当FileSystemType=standard或extreme时，此参数为接口预留参数，暂未生效，您无需配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp18cx9a7zoh0h9b4****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。'."\n" + ."\n" + .'- 当FileSystemType=cpfs时，必须配置此参数。'."\n" + .'- 当 FileSystemType不为cpfs 时，此参数为接口预留参数，暂未生效，您无需配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp131dkqilvw5pnlt****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统描述。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '此文件系统的描述。', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'>若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'KmsKeyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'KMS密钥ID。'."\n" + ."\n" + .'仅当EncryptType=2时该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'fcbd****-62**-4a**-b605-c58cc1d5****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值： '."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。 '."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以通过[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups?)查看资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmwavnfdf****'."\n", + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签数组。'."\n" + ."\n" + .'数组长度：1~20。如果数组中有多个标签对象，标签键Key不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 不允许为空和空字符串。'."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`aliyun`或`acs:`开头。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'nastest', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'限制：'."\n" + .'- 不允许为空和空字符串。'."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'testValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'RedundancyType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '冗余类型', + 'description' => '存储冗余类型。仅CPFS SE生效。'."\n" + .'可选：ZRS', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ZRS' => 'ZRS', + ], + 'example' => 'ZRS', + 'enum' => [ + 'LRS', + 'ZRS', + ], + ], + ], + [ + 'name' => 'RedundancyVSwitchIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '同城冗余虚拟交换机ID列表'."\n" + .'当设置 RedundancyType 为 ZRS 时，必须设置该字段。且必须填入3个交换机ID，且满足来自三个不同的可用区。', + 'type' => 'array', + 'items' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '同城冗余虚拟交换机ID列表', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-123xxx', + ], + 'required' => false, + 'maxItems' => 3, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结构，不参与评审，不显示。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'FileSystemId' => [ + 'description' => '完成创建的文件系统ID。', + 'type' => 'string', + 'example' => '1ca404****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 202 => [ + [ + 'errorCode' => 'RequestAccepted', + 'errorMessage' => 'The request has been accepted by the server.', + ], + ], + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The same client token was passed in to different parameters.', + ], + [ + 'errorCode' => 'InvalidParameter.KmsServiceNotEnabled', + 'errorMessage' => 'Key Management Service is not enabled.', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'The request is validated with DryRun flag set.', + ], + [ + 'errorCode' => 'SubAccount.NoExtremeSLRPermission', + 'errorMessage' => 'The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasExtreme. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.', + ], + [ + 'errorCode' => 'SubAccount.NoStandardSLRPermission', + 'errorMessage' => 'The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasStandard. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.', + ], + [ + 'errorCode' => 'SubAccount.NoEncryptionSLRPermission', + 'errorMessage' => 'The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasEncryption. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.', + ], + [ + 'errorCode' => 'InvalidParam.NotSupportBYOK', + 'errorMessage' => 'The specified file system type does not support the BYOK encryption function.', + ], + [ + 'errorCode' => 'MissingParameter.KmsKeyId', + 'errorMessage' => 'When parameter EncryptType equals 2, the parameter KmsKeyId is mandatory for your request.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidKmsKeyId', + 'errorMessage' => 'The specified KMS key ID is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.KmsKeyIdNotFound', + 'errorMessage' => 'The specified KMS key ID does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'InvalidFileSystem.AlreadyExisted', + 'errorMessage' => 'The specified file system already exists.', + ], + [ + 'errorCode' => 'Resource.OutOfStock', + 'errorMessage' => 'The inventory of the specified zone is insufficient.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"FileSystemId\\": \\"1ca404****\\"\\n}","type":"json"}]', + 'title' => '创建文件系统', + 'description' => '- 请确保在使用该接口前，已充分了解NAS产品的计费说明和价格。更多信息，请参见[计费说明](~~178365~~)和[价格](https://www.aliyun.com/price/product?#/nas/detail)。'."\n" + ."\n" + .'- 创建文件系统实例需要通过实名认证。具体操作，请参见[账号实名认证](~~48263~~)。'."\n" + ."\n" + .'- 调用此接口将自动创建操作所需的NAS服务关联角色。更多信息，请参见[管理NAS服务关联角色](~~208530~~)。', + 'requestParamsDescription' => '**关于API幂等性，您需要注意以下事项：** '."\n" + .'由于CreateFileSystem接口涉及云资源的创建和费用，您在调用该API时，如果发生请求超时或服务端内部错误，客户端可能会尝试重发请求。建议您在请求中设置ClientToken参数以避免因多次重试导致的重复下单的问题。 '."\n" + ."\n" + .'> 当前只有FileSystemType参数为extreme、cpfs时，该API支持幂等；当FileSystemType参数为standard时，该API不支持幂等。'."\n" + ."\n\n" + .'ClientToken参数的详细信息如下所示：'."\n" + .'- ClientToken是一个由客户端生成的唯一的、大小写敏感、不超过64个ASCII字符的字符串。例如：```ClientToken=123e4567-e89b-12d3-a456-42665544****``` '."\n" + .'- 如果您提供了一个已经使用过的ClientToken，但其他请求参数有变化，则NAS会返回IdempotentParameterMismatch的错误代码。'."\n" + .'> 参数SignatureNonce、Timestamp和Signature在重试时是需要变化的。具体原因是NAS使用SignatureNonce防止重放攻击，使用Timestamp标记每次请求时间。所以再次请求必须提供不同的SignatureNonce和Timestamp参数值，同时也会导致Signature值的变化。 '."\n" + ."\n" + .'- 添加了ClientToken参数后： '."\n" + .' + 返回结果是200 HTTPCode时，重试后客户端可以得到与上次相同的结果，但对您的服务端状态没有影响。'."\n" + .' + 返回结果是4xx HTTPCode时，如果错误信息没有表明try it later类似的信息，重试永远不会成功，您需要根据错误信息排查问题后修改请求参数后再重试请求。'."\n" + .' + 返回结果是5xx HTTPCode时，表明请求可能是发生网络超时或服务端内部错误，您可以重新发送同一个请求（必须包含相同ClientToken和业务请求参数）以确认请求结果。'."\n" + ."\n" + .'- ClientToken有效期为30天。', + ], + 'DeleteFileSystem' => [ + 'summary' => '删除一个文件系统。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13939', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的文件系统ID。'."\n" + .'- 通用型NAS：31a8e4\\*\\*\\*\\*。'."\n" + .'- 极速型NAS：必须以`extreme-`开头，例如extreme-0015\\*\\*\\*\\*。'."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-00cb6fa094ca\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E15E394-38A6-457A-A62A-D9797C9A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.LifecyclePolicyAssociated', + 'errorMessage' => 'The specified FileSystem has LifecyclePolicy associated.', + ], + [ + 'errorCode' => 'OperationDenied.LifecycleRecycleBinTieringJobAssociated', + 'errorMessage' => 'The specified FileSystem has LifecycleRecycleBinTieringJob associated.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E15E394-38A6-457A-A62A-D9797C9A****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFileSystemResponse>\\n <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>\\n</DeleteFileSystemResponse>","errorExample":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DeleteFileSystemResponse>\\n <RequestId>9E15E394-38A6-457A-A62A-D9797C9A0262</RequestId>\\n</DeleteFileSystemResponse>\\n"}]', + 'title' => '删除文件系统', + 'description' => '- 仅当文件系统的挂载点数目为0时，支持删除文件系统实例。'."\n" + .'- 当文件系统未创建生命周期策略时，支持删除文件系统实例。'."\n" + .'- 文件系统实例一旦删除，数据将不可恢复，请谨慎操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyFileSystem' => [ + 'summary' => '修改文件系统的描述信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13976', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- 通用型NAS：`31a8e4****`。'."\n" + ."\n" + .'- 极速型NAS：必须以`extreme-`开头，例如`extreme-0015****`。'."\n" + .'- CPFS：必须以`cpfs-`开头，例如`cpfs-125487****`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统描述。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NAS-test-1', + ], + ], + [ + 'name' => 'Options', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '选项。', + 'type' => 'object', + 'properties' => [ + 'EnableOplock' => [ + 'description' => '是否开启OpLock功能。'."\n" + .'取值：'."\n" + .'- true：开启。'."\n" + .'- false：不开启。'."\n" + .'> 仅支持SMB协议类型的文件系统。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'EnableABE' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5BC5CB97-9F28-42FE-84A4-0CD0DF42****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BC5CB97-9F28-42FE-84A4-0CD0DF42****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyFileSystemResponse>\\n <RequestId>5BC5CB97-9F28-42FE-84A4-0CD0DF42****</RequestId>\\n</ModifyFileSystemResponse>","errorExample":""}]', + 'title' => '修改文件系统的描述信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFileSystems' => [ + 'summary' => '查询文件系统信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13951', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + .'- 通用型NAS：31a8e4****。'."\n" + .'- 极速型NAS：必须以extreme-开头，例如extreme-0015****。'."\n" + .'- CPFS（本地冗余版本）：必须以cpfs-开头，例如cpfs-125487****。'."\n" + .'- CPFS SE（同城冗余版本）：必须以cpfsse-开头，例如cpfsse-022c71b134****。', + 'type' => 'string', + 'required' => false, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- all（默认值）：同时查询所有类型。'."\n" + .'- standard：通用型NAS。'."\n" + .'- extreme：极速型NAS。'."\n" + .'- cpfs：文件存储CPFS（本地冗余版本）。'."\n" + .'- cpfsse：文件存储CPFS SE（同城冗余版本）。'."\n" + ."\n" + .'> 如果查询多个类型，使用英文逗号隔开。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'standard', + 'default' => 'all', + 'enum' => [], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'必须与待挂载的云服务器ECS选择相同的VPC网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1sevsgtqvk5gxbl****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每个分页包含的文件系统个数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息集合。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- N的取值范围为1~20。'."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`aliyun`或`acs:`开头。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'testKey', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- N的取值范围为1~20。'."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`aliyun`或`acs:`开头。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'testValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以通过[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups?)查看资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmwavnfef****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileSystem' => [ + 'description' => '文件系统列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '文件系统状态。包括：'."\n" + .'- Pending：当前文件系统正在处理任务中。'."\n" + .'- Running：当前文件系统可用，当状态为Running时才可以进行后续操作（例如：创建挂载点等）。'."\n" + .'- Stopped：当前文件系统不可用。'."\n" + .'- Extending：当前文件系统扩容中。'."\n" + .'- Stopping：当前文件系统停机中。'."\n" + .'- Deleting：当前文件系统删除中。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'MeteredIASize' => [ + 'description' => '低频存储用量。'."\n" + ."\n" + .'单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '362832', + ], + 'Capacity' => [ + 'description' => '文件系统的容量。'."\n" + ."\n" + .'单位：GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CreateTime' => [ + 'description' => '文件系统的创建时间。', + 'type' => 'string', + 'example' => '2020-01-05T16:00:00Z', + ], + 'ChargeType' => [ + 'description' => '计费类型。'."\n" + ."\n" + .'包括：'."\n" + .'- Subscription：包年包月。'."\n" + .'- PayAsYouGo：按量付费。'."\n" + .'- Package：已绑定存储包。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '文件系统标签信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'testKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'testValue', + ], + ], + ], + ], + ], + ], + 'StorageType' => [ + 'description' => '存储类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- 通用型NAS：Capacity（容量型）、Performance（性能型）、Premium（高级型）'."\n" + .'- 极速型NAS：standard（标准型）、advance（高级型）'."\n" + .'- CPFS：advance_100（100 MB/s/TiB基线）、advance_200（200 MB/s/TiB基线）、economic（经济型）'."\n" + .'- CPFS SE：advance_100（100 MB/s/TiB基线）', + 'type' => 'string', + 'example' => 'Performance', + ], + 'MeteredSize' => [ + 'description' => '文件系统的标准存储使用量。'."\n" + ."\n" + .'非实时使用量，为上一小时最大使用量，单位：Byte。'."\n" + .'> 如果您需要查看文件系统总存储容量，请参见[查询文件系统资源使用量](~~250243~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611661312', + ], + 'Description' => [ + 'description' => '文件系统的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'Bandwidth' => [ + 'description' => '文件系统的带宽。'."\n" + ."\n" + .'单位：MB/s。通用型NAS没有该字段。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '150', + ], + 'SupportedFeatures' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedFeature' => [ + 'description' => '文件系统支持的功能集合。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统支持的功能。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Lifecycle：生命周期管理。'."\n" + .'- ACL：访问控制列表。'."\n" + .'- Ipv6：IPv6功能。'."\n" + ."\n" + .'> 当前仅极速型NAS中国内地各地域支持IPv6功能。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Lifecycle', + ], + ], + ], + ], + 'Version' => [ + 'description' => '文件系统版本号。'."\n" + ."\n" + .'该字段适用于极速型NAS和CPFS。', + 'type' => 'string', + 'example' => '2.3.4', + ], + 'ProtocolType' => [ + 'description' => '文件系统协议类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- NFS：NFS文件协议。'."\n" + .'- SMB：SMB文件协议。'."\n" + .'- cpfs：CPFS或CPFS SE文件系统支持的协议类型。', + 'type' => 'string', + 'example' => 'NFS', + ], + 'MountTargets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MountTarget' => [ + 'description' => '挂载点信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1sevsgtqvk5gxbl****', + ], + 'Status' => [ + 'description' => '挂载点状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Active：可用。'."\n" + .'- Inactive：不可用。'."\n" + .'- Pending：任务处理中。'."\n" + .'- Deleting：删除中。'."\n" + .'- Hibernating：休眠中。'."\n" + .'- Hibernated：已休眠。', + 'type' => 'string', + 'example' => 'Active', + ], + 'ClientMasterNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClientMasterNode' => [ + 'description' => '客户端管理节点信息集合。'."\n" + ."\n" + .'仅CPFS文件系统返回该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EcsId' => [ + 'description' => '管理节点ECS实例ID。', + 'type' => 'string', + 'example' => 'i-hp3i3odi5ory1buo****', + ], + 'DefaultPasswd' => [ + 'description' => '管理节点默认登录密码。', + 'type' => 'string', + 'example' => '123456', + ], + 'EcsIp' => [ + 'description' => '管理节点ECS实例IP。', + 'type' => 'string', + 'example' => '192.168.1.0', + ], + ], + ], + ], + ], + ], + 'MountTargetDomain' => [ + 'description' => '挂载点。', + 'type' => 'string', + 'example' => '109c042666-w****.cn-hangzhou.nas.aliyuncs.com', + ], + 'AccessGroupName' => [ + 'description' => '挂载点使用的权限组名称。', + 'type' => 'string', + 'example' => 'test-001', + ], + 'DualStackMountTargetDomain' => [ + 'description' => 'IPv4和IPv6双栈挂载点。'."\n" + ."\n" + .'>仅极速型NAS中国内地各地域支持IPv6功能。', + 'type' => 'string', + 'example' => '174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com', + ], + 'VswId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1omfzsszekkvaxn****', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '挂载点标签信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'testKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'testValue', + ], + ], + ], + ], + ], + ], + 'NetworkType' => [ + 'description' => '网络类型。取值为 vpc，表示专有网络类型。', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + ], + ], + 'KMSKeyId' => [ + 'description' => 'KMS密钥ID。', + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'AutoSnapshotPolicyId' => [ + 'description' => '自动快照策略ID。', + 'type' => 'string', + 'example' => 'sp-extreme-09npwxadu1eqvw****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- standard：通用型NAS。'."\n" + .'- extreme：极速型NAS。'."\n" + .'- cpfs：文件存储CPFS（本地冗余版本）。'."\n" + .'- cpfsse：文件存储CPFS SE（同城冗余版本）。', + 'type' => 'string', + 'example' => 'standard', + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '109c04****', + ], + 'EncryptType' => [ + 'description' => '加密类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- 0：不加密。'."\n" + .'- 1：NAS托管密钥。'."\n" + .'- 2：用户管理密钥。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Ldap' => [ + 'description' => 'LDAP配置信息集合。'."\n" + ."\n" + .'仅CPFS文件系统返回该参数。', + 'type' => 'object', + 'properties' => [ + 'BindDN' => [ + 'description' => '绑定LDAP的指定条目。', + 'type' => 'string', + 'example' => 'cn=alibaba,dc=com', + ], + 'SearchBase' => [ + 'description' => 'LDAP搜索起始点。', + 'type' => 'string', + 'example' => 'dc=example', + ], + 'URI' => [ + 'description' => 'LDAP服务地址。', + 'type' => 'string', + 'example' => 'ldap://ldap.example.example', + ], + ], + ], + 'ExpiredTime' => [ + 'description' => '文件系统到期时间。', + 'type' => 'string', + 'example' => '2020-01-05T16:00:00Z', + ], + 'ZoneId' => [ + 'description' => '文件系统所在的可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1sevsgtqvk5gxbl****'."\n", + ], + 'VswIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VswId' => [ + 'description' => '交换机信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1omfzsszekkvaxn****'."\n", + ], + ], + ], + ], + 'Packages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Package' => [ + 'description' => '存储包信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '存储包起始时间。', + 'type' => 'string', + 'example' => '2019-12-05T01:40:56Z', + ], + 'ExpiredTime' => [ + 'description' => '存储包到期时间。', + 'type' => 'string', + 'example' => '2020-01-05T16:00:00Z', + ], + 'Size' => [ + 'description' => '存储包容量。'."\n" + .'单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107374182400', + ], + 'PackageId' => [ + 'description' => '存储包ID。', + 'type' => 'string', + 'example' => 'naspackage-0be9c4b624-37****', + ], + 'PackageType' => [ + 'description' => '存储包类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- ssd：性能型。'."\n" + .'- hybrid：容量型。', + 'type' => 'string', + 'example' => 'hybrid', + ], + ], + ], + ], + ], + ], + 'AccessPointCount' => [ + 'description' => '接入点数量。', + 'type' => 'string', + 'example' => '1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID', + 'type' => 'string', + 'example' => 'rg-acfmwavnfef****'."\n", + ], + 'MeteredArchiveSize' => [ + 'description' => '归档存储用量。'."\n" + ."\n" + .'单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611661312', + ], + 'Options' => [ + 'description' => '选项。', + 'type' => 'object', + 'properties' => [ + 'EnableOplock' => [ + 'description' => '是否开启OpLock功能。'."\n" + .'取值：'."\n" + .'- true：开启。'."\n" + .'- false：不开启。'."\n" + .'> 仅支持SMB协议类型的文件系统。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableABE' => [ + 'type' => 'boolean', + ], + ], + ], + 'QuorumVswId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1omfzsszekkvaxn****', + ], + 'VscTarget' => [ + 'description' => '> 该参数暂未开放使用。', + 'type' => 'string', + 'example' => 'cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com', + ], + 'RedundancyType' => [ + 'title' => '冗余类型', + 'description' => '存储冗余类型。仅CPFS SE时有值。', + 'type' => 'string', + 'example' => 'LRS', + 'default' => 'LRS', + ], + 'RedundancyVSwitchIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RedundancyVSwitchId' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '同城冗余交换机ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '同城冗余交换机ID列表。'."\n" + .'当设置 RedundancyType 为 ZRS 时，该字段有值。', + 'type' => 'string', + 'example' => 'vsw-123xxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '035B3A3A-E514-4B41-B906-5D906CFB****', + ], + 'TotalCount' => [ + 'description' => '文件系统的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每个分页包含的文件系统个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '文件系统列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Region.NotSupported', + 'errorMessage' => 'The specified Region is not supported for this API now.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FileSystems\\": {\\n \\"FileSystem\\": [\\n {\\n \\"Status\\": \\"Pending\\",\\n \\"MeteredIASize\\": 362832,\\n \\"Capacity\\": 100,\\n \\"CreateTime\\": \\"2020-01-05T16:00:00Z\\",\\n \\"ChargeType\\": \\"PayAsYouGo\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n },\\n \\"StorageType\\": \\"Performance\\",\\n \\"MeteredSize\\": 1611661312,\\n \\"Description\\": \\"test\\",\\n \\"Bandwidth\\": 150,\\n \\"SupportedFeatures\\": {\\n \\"SupportedFeature\\": [\\n \\"Lifecycle\\"\\n ]\\n },\\n \\"Version\\": \\"2.3.4\\",\\n \\"ProtocolType\\": \\"NFS\\",\\n \\"MountTargets\\": {\\n \\"MountTarget\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1sevsgtqvk5gxbl****\\",\\n \\"Status\\": \\"Active\\",\\n \\"ClientMasterNodes\\": {\\n \\"ClientMasterNode\\": [\\n {\\n \\"EcsId\\": \\"i-hp3i3odi5ory1buo****\\",\\n \\"DefaultPasswd\\": \\"123456\\",\\n \\"EcsIp\\": \\"192.168.1.0\\"\\n }\\n ]\\n },\\n \\"MountTargetDomain\\": \\"109c042666-w****.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"AccessGroupName\\": \\"test-001\\",\\n \\"DualStackMountTargetDomain\\": \\"174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"VswId\\": \\"vsw-bp1omfzsszekkvaxn****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n },\\n \\"NetworkType\\": \\"vpc\\"\\n }\\n ]\\n },\\n \\"KMSKeyId\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40****\\",\\n \\"AutoSnapshotPolicyId\\": \\"sp-extreme-09npwxadu1eqvw****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSystemType\\": \\"standard\\",\\n \\"FileSystemId\\": \\"109c04****\\",\\n \\"EncryptType\\": 1,\\n \\"Ldap\\": {\\n \\"BindDN\\": \\"cn=alibaba,dc=com\\",\\n \\"SearchBase\\": \\"dc=example\\",\\n \\"URI\\": \\"ldap://ldap.example.example\\"\\n },\\n \\"ExpiredTime\\": \\"2020-01-05T16:00:00Z\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"VpcId\\": \\"vpc-bp1sevsgtqvk5gxbl****\\\\n\\",\\n \\"VswIds\\": {\\n \\"VswId\\": [\\n \\"vsw-bp1omfzsszekkvaxn****\\\\n\\"\\n ]\\n },\\n \\"Packages\\": {\\n \\"Package\\": [\\n {\\n \\"StartTime\\": \\"2019-12-05T01:40:56Z\\",\\n \\"ExpiredTime\\": \\"2020-01-05T16:00:00Z\\",\\n \\"Size\\": 107374182400,\\n \\"PackageId\\": \\"naspackage-0be9c4b624-37****\\",\\n \\"PackageType\\": \\"hybrid\\"\\n }\\n ]\\n },\\n \\"AccessPointCount\\": \\"1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmwavnfef****\\\\n\\",\\n \\"MeteredArchiveSize\\": 1611661312,\\n \\"Options\\": {\\n \\"EnableOplock\\": true,\\n \\"EnableABE\\": true\\n },\\n \\"QuorumVswId\\": \\"vsw-bp1omfzsszekkvaxn****\\",\\n \\"VscTarget\\": \\"cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com\\",\\n \\"RedundancyType\\": \\"LRS\\",\\n \\"RedundancyVSwitchIds\\": {\\n \\"RedundancyVSwitchId\\": [\\n \\"vsw-123xxx\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"035B3A3A-E514-4B41-B906-5D906CFB****\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeFileSystemsResponse>\\n <FileSystems>\\n <Status>Pending</Status>\\n <MeteredIASize>362832</MeteredIASize>\\n <Capacity>1</Capacity>\\n <CreateTime>2020-01-05T16:00:00Z</CreateTime>\\n <ChargeType>PayAsYouGo</ChargeType>\\n <Tags>\\n <Key>sdf</Key>\\n <Value>asd123</Value>\\n </Tags>\\n <StorageType>Performance</StorageType>\\n <MeteredSize>1611661312</MeteredSize>\\n <Description>31a8e48eda</Description>\\n <Bandwidth>150</Bandwidth>\\n <SupportedFeatures>Lifecycle</SupportedFeatures>\\n <Version>1</Version>\\n <ProtocolType>NFS</ProtocolType>\\n <MountTargets>\\n <VpcId>vpc-bp1sevsgtqvk5gxbl****</VpcId>\\n <Status>active</Status>\\n <ClientMasterNodes>\\n <EcsId>i-hp3i3odi5ory1buo****</EcsId>\\n <DefaultPasswd>123456</DefaultPasswd>\\n <EcsIp>192.168.1.0</EcsIp>\\n </ClientMasterNodes>\\n <MountTargetDomain>109c042666-w****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>\\n <AccessGroupName>test-001</AccessGroupName>\\n <DualStackMountTargetDomain>174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com</DualStackMountTargetDomain>\\n <VswId>vsw-bp1omfzsszekkvaxn****</VswId>\\n <Tags>\\n <Key>adasfsdfd</Key>\\n <Value>afsa</Value>\\n </Tags>\\n <NetworkType>vpc</NetworkType>\\n </MountTargets>\\n <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>\\n <RegionId>cn-hangzhou</RegionId>\\n <FileSystemType>standard</FileSystemType>\\n <FileSystemId>109c04****</FileSystemId>\\n <EncryptType>1</EncryptType>\\n <Ldap>\\n <BindDN>cn=alibaba,dc=com</BindDN>\\n <SearchBase>dc=example</SearchBase>\\n <URI>ldap://ldap.example.example</URI>\\n </Ldap>\\n <ExpiredTime>2020-01-05T16:00:00Z</ExpiredTime>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n <Packages>\\n <StartTime>2019-12-05T01:40:56Z</StartTime>\\n <ExpiredTime>2020-01-05T16:00:00Z</ExpiredTime>\\n <Size>107374182400</Size>\\n <PackageId>naspackage-0be9c4b624-37****</PackageId>\\n <PackageType>hybrid</PackageType>\\n </Packages>\\n </FileSystems>\\n <TotalCount>1</TotalCount>\\n <RequestId>035B3A3A-E514-4B41-B906-5D906CFB****</RequestId>\\n <PageSize>1</PageSize>\\n <PageNumber>1</PageNumber>\\n</DescribeFileSystemsResponse>","errorExample":""}]', + 'title' => '查询文件系统信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpgradeFileSystem' => [ + 'summary' => '扩容极速型NAS文件系统或CPFS文件系统的存储容量。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13988', + 'abilityTreeNodes' => [ + 'FEATUREnasCF11NZ', + 'FEATUREnasQ7YV89', + 'FEATUREnas6KFX9N', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- 极速型NAS：必须以`extreme-`开头，例如extreme-0015\\*\\*\\*\\*。'."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'extreme-0015****', + ], + ], + [ + 'name' => 'Capacity', + 'in' => 'query', + 'schema' => [ + 'description' => '扩容后的文件系统的容量。'."\n" + ."\n" + .'扩容后容量需大于文件系统原容量，单位：GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值： '."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。 '."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'>若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeFileSystemResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</UpgradeFileSystemResponse>","errorExample":""}]', + 'title' => '扩容文件系统存储容量', + 'description' => '- 仅支持极速型NAS文件系统和CPFS文件系统扩容。'."\n" + .'- 通用型NAS按需自动扩容，无须使用本API。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFilesystemsAssociatedHpnZones' => [ + 'summary' => '查询文件系统关联的 HpnZone 列表，当计算节点位于关联的 HpnZone 中时，访问文件系统的性能最优。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191084', + 'abilityTreeNodes' => [ + 'FEATUREnasOIBEFL', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '特殊客户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Filesystems', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '文件系统ID集合。'."\n" + .'> 集合中最大元素数量需小于或等于20.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => 'CPFS智算版文件系统ID。必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'required' => false, + 'example' => 'bmcpfs-290t15yn4uo8lid****'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'Filesystems' => [ + 'description' => '文件系统关联的HpnZone列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统关联的HpnZone 。', + 'type' => 'object', + 'properties' => [ + 'AssociatedHpnZones' => [ + 'description' => '文件系统支持的HpnZone列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统支持的HpnZone。', + 'type' => 'string', + 'example' => 'A2', + ], + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'FileSystemId' => [ + 'description' => 'CPFS智算版文件系统ID。', + 'type' => 'string', + 'example' => 'bmcpfs-290t15yn4uo8lid****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem type.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"Filesystems\\": [\\n {\\n \\"AssociatedHpnZones\\": [\\n \\"A2\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"FileSystemId\\": \\"bmcpfs-290t15yn4uo8lid****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询文件系统关联的HpnZone列表', + 'description' => '- 仅支持CPFS智算版文件系统。'."\n" + .'- 此接口为批量接口，每次最多允许查询 20 个文件系统。', + ], + 'CreateMountTarget' => [ + 'summary' => '创建挂载点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13934', + 'abilityTreeNodes' => [ + 'FEATUREnasOIBEFL', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- 通用型NAS：31a8e4\\*\\*\\*\\*。'."\n" + ."\n" + .'- 极速型NAS：必须以`extreme-`开头，例如extreme-0015\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174494****', + ], + ], + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'当目标文件系统为通用型NAS或极速型NAS时，此参数必填。'."\n" + ."\n" + .'默认权限组：DEFAULT_VPC_GROUP_NAME（专有网络默认权限组）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载点网络类型。取值为**Vpc**，表示专有网络。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Vpc', + 'enum' => [ + 'Vpc', + 'vpc', + 'VPC', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'当网络类型是专有网络，此字段必填且有意义。'."\n" + .'例如：'."\n" + .'NetworkType=VPC时，VpcId为必填项。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zesj9afh3y518k9o****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。'."\n" + ."\n" + .'当网络类型是专有网络，此字段必填且有意义。'."\n" + .'例如：'."\n" + .'NetworkType=VPC时，VSwitchId为必填项。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2zevmwkwyztjuoffg****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp1fg655nh68xyz9****', + ], + ], + [ + 'name' => 'EnableIpv6', + 'in' => 'query', + 'schema' => [ + 'description' => '是否创建IPv6挂载点。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：创建'."\n" + .'- false（默认值）：不创建'."\n" + ."\n" + .'> 当前仅极速型NAS中国内地各地域支持IPv6功能，且该文件系统需要开启IPv6功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '校验是否有存量挂载点。仅支持校验CPFS文件系统。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建挂载点，也不会产生费用。'."\n" + ."\n" + .'- true：发送校验请求，不会创建挂载点。检查项包括是否填写了必需参数、请求格式、业务限制和CPFS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回`200 HttpCode`，但`MountTargetDomain`为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建挂载点。'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70EACC9C-D07A-4A34-ADA4-77506C42****', + ], + 'MountTargetDomain' => [ + 'description' => 'IPv4挂载点。', + 'type' => 'string', + 'example' => '174494b666-x****.cn-hangzhou.nas.aliyuncs.com', + ], + 'MountTargetExtra' => [ + 'description' => '挂载点信息集合。', + 'type' => 'object', + 'properties' => [ + 'DualStackMountTargetDomain' => [ + 'description' => 'IPv4和IPv6双栈挂载点。', + 'type' => 'string', + 'example' => '174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 202 => [ + [ + 'errorCode' => 'RequestAccepted', + 'errorMessage' => 'The request has been accepted by the server.', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotsupportedIPv6', + 'errorMessage' => 'The file system does not support IPv6.', + ], + [ + 'errorCode' => 'InvalidVSwitch.Ipv6NotTurnOn', + 'errorMessage' => 'The VSwitch you are currently using has not enabled the IPv6 function. Please enable this function first and try again.', + ], + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The same client token was passed in to different parameters.', + ], + [ + 'errorCode' => 'MissingParameter.AccessGroupName', + 'errorMessage' => 'You must specify AccessGroupName when you create a standard or extreme file system mount target.', + ], + [ + 'errorCode' => 'InvalidVSwitchId.IpNotEnough', + 'errorMessage' => 'The number of the specified VSwitch IP address is insufficient.', + ], + [ + 'errorCode' => 'InvalidParameter.ConflictVpcCidr', + 'errorMessage' => 'The specified VPC CIDR conflicts with the server.', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'The request is validated with DryRun flag set.', + ], + [ + 'errorCode' => 'SubAccount.NoStandardSLRPermission', + 'errorMessage' => 'The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasStandard. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'InvalidRamRole.NotExist', + 'errorMessage' => 'The specified RAM role does not exist.', + ], + [ + 'errorCode' => 'InvalidRamRole.NoPermission', + 'errorMessage' => 'The specified RAM role does not have sufficient permission.', + ], + [ + 'errorCode' => 'InvalidMountTarget.AlreadyExisted', + 'errorMessage' => 'The specified mount target already exists.', + ], + [ + 'errorCode' => 'Resource.OutOfStock', + 'errorMessage' => 'The inventory of the specified zone is insufficient.', + ], + [ + 'errorCode' => 'OperationDenied.MountTargetExceedLimit', + 'errorMessage' => 'The maximum number of mount target in the specified file system is exceeded.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.VswNotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.VpcNotFound', + 'errorMessage' => 'The specified VPC does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70EACC9C-D07A-4A34-ADA4-77506C42****\\",\\n \\"MountTargetDomain\\": \\"174494b666-x****.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"MountTargetExtra\\": {\\n \\"DualStackMountTargetDomain\\": \\"174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateMountTargetResponse>\\n <RequestId>70EACC9C-D07A-4A34-ADA4-77506C42****</RequestId>\\n <MountTargetDomain>174494b666-x****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>\\n <MountTargetExtra>\\n <DualStackMountTargetDomain>174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com</DualStackMountTargetDomain>\\n </MountTargetExtra>\\n</CreateMountTargetResponse>","errorExample":""}]', + 'title' => '创建挂载点', + 'description' => '- 在使用CreateMountTarget接口创建挂载点时部分资源的生成是异步完成的。因此在执行CreateMountTarget接口成功后，请先调用DescribeMountTargets接口查询挂载点状态，当挂载点状态为**Active**后再执行挂载文件系统操作，否则可能会挂载失败。'."\n" + .'- 调用此接口将自动创建操作所需的NAS服务关联角色。更多信息，请参见[管理NAS服务关联角色](~~208530~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMountTarget' => [ + 'summary' => '删除已存在挂载点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13943', + 'abilityTreeNodes' => [ + 'FEATUREnas5IJRRZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + .'- 通用型NAS：31a8e4\\*\\*\\*\\*。'."\n" + ."\n" + .'- 极速型NAS：必须以`extreme-`开头，例如extreme-0015\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174494****', + ], + ], + [ + 'name' => 'MountTargetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174494b666-x****.cn-hangzhou.nas.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5BC5CB97-9F28-42FE-84A4-0CD0DF42****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BC5CB97-9F28-42FE-84A4-0CD0DF42****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMountTargetResponse>\\n <RequestId>5BC5CB97-9F28-42FE-84A4-0CD0DF42****</RequestId>\\n</DeleteMountTargetResponse>","errorExample":""}]', + 'title' => '删除挂载点', + 'description' => '删除挂载点后，无法恢复，请谨慎操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyMountTarget' => [ + 'summary' => '修改挂载点信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13979', + 'abilityTreeNodes' => [ + 'FEATUREnasOIBEFL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + .'- 通用型NAS：`31a8e4****`。'."\n" + .'- 极速型NAS：必须以`extreme-`开头，例如`extreme-0015****`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'MountTargetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPv4挂载点。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1ca404a666-w****.cn-hangzhou.nas.aliyuncs.com', + ], + ], + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载点绑定的权限组。', + 'type' => 'string', + 'required' => false, + 'example' => 'classic-test', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载点状态。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- Active：可用'."\n" + .'- Inactive：不可用'."\n" + ."\n" + .'> 当前仅通用型NAS支持更改挂载点状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'Inactive', + 'enum' => [ + 'Active', + 'Inactive', + ], + ], + ], + [ + 'name' => 'DualStackMountTargetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPv4和IPv6双栈挂载点。'."\n" + ."\n" + .'> 当前仅极速型NAS中国内地各地域支持IPv6功能。', + 'type' => 'string', + 'required' => false, + 'example' => '174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FF387D95-34C4-4879-B65A-99D1FA1B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotsupportedIPv6', + 'errorMessage' => 'The file system does not support IPv6.', + ], + [ + 'errorCode' => 'InvalidParam.MountTargetDomain', + 'errorMessage' => 'The specified mount target domain does not exist.', + ], + [ + 'errorCode' => 'InvalidParam.DualStackMountTargetDomain', + 'errorMessage' => 'The specified dual stack mount target domain does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF387D95-34C4-4879-B65A-99D1FA1B****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FF387D95-34C4-4879-B65A-99D1FA1B****</RequestId>","errorExample":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<ModifyMountTargetResponse>\\n <RequestId>FF387D95-34C4-4879-B65A-99D1FA1B65CD</RequestId>\\n</ModifyMountTargetResponse>\\n"}]', + 'title' => '修改挂载点信息', + 'description' => '仅支持修改通用型NAS或极速型NAS文件系统的挂载点信息。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMountTargets' => [ + 'summary' => '查询挂载点信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13957', + 'abilityTreeNodes' => [ + 'FEATUREnasOIBEFL', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- 通用型NAS：31a8e4\\*\\*\\*\\*。'."\n" + ."\n" + .'- 极速型NAS：必须以`extreme-`开头，例如extreme-0015\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'MountTargetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载点地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1ca404****-x****.cn-hangzhou.nas.aliyuncs.com', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每个分页包含的挂载点个数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'DualStackMountTargetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPv4和IPv6双栈挂载点。'."\n" + ."\n" + .'> 当前仅极速型NAS中国内地各地域支持IPv6功能。', + 'type' => 'string', + 'required' => false, + 'example' => '1ca404****-x****.dualstack.cn-hangzhou.nas.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '挂载点总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3BAB90FD-B4A0-48DA-9F09-2B963510****', + ], + 'PageSize' => [ + 'description' => '分页查询时，每个分页包含的挂载点个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '文件系统列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MountTargets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MountTarget' => [ + 'description' => '挂载点信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-2zesj9afh3y518k9o****', + ], + 'Status' => [ + 'description' => '当前挂载点状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Active：可用'."\n" + .'- Inactive：不可用'."\n" + .'- Pending：任务排队中'."\n" + .'- Deleting：删除中'."\n" + .'- Hibernating：休眠中'."\n" + .'- Hibernated：已休眠'."\n" + ."\n" + .'> 当状态为Active时才可以挂载文件系统。', + 'type' => 'string', + 'example' => 'Active', + ], + 'ClientMasterNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClientMasterNode' => [ + 'description' => '客户端管理节点信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EcsId' => [ + 'description' => '管理节点ECS实例ID。', + 'type' => 'string', + 'example' => 'i-hp3i3odi5ory1buo****', + ], + 'DefaultPasswd' => [ + 'description' => '默认登录密码。', + 'type' => 'string', + 'example' => '12****', + ], + 'EcsIp' => [ + 'description' => '管理节点ECS实例IP。', + 'type' => 'string', + 'example' => '192.168.1.0', + ], + ], + ], + ], + ], + ], + 'MountTargetDomain' => [ + 'description' => 'IPv4挂载点。', + 'type' => 'string', + 'example' => '1ca404****-w****.cn-hangzhou.nas.aliyuncs.com', + ], + 'AccessGroup' => [ + 'description' => '挂载点所应用的权限组名称。', + 'type' => 'string', + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + 'DualStackMountTargetDomain' => [ + 'description' => 'IPv4和IPv6双栈挂载点。', + 'type' => 'string', + 'example' => '1ca404****-x****.dualstack.cn-hangzhou.nas.aliyuncs.com', + ], + 'VswId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2zevmwkwyztjuoffg****', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签数组。数组长度：1~20。如果数组中有多个标签对象，标签键 Key 不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'限制：'."\n" + ."\n" + .'- 不允许为空和空字符串。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', + 'type' => 'string', + 'example' => 'nastest', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能包含http://和https://。', + 'type' => 'string', + 'example' => 'mounttargettest', + ], + ], + ], + ], + ], + ], + 'NetworkType' => [ + 'description' => '网络类型。取值为**Vpc**，表示专有网络。', + 'type' => 'string', + 'example' => 'Vpc', + ], + 'IPVersion' => [ + 'description' => '挂载点类型。'."\n" + .'- IPv4：IPv4挂载点。'."\n" + .'- DualStack：双栈挂载点。', + 'type' => 'string', + 'example' => 'IPv4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotsupportedIPv6', + 'errorMessage' => 'The file system does not support IPv6.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidMountTarget.NotFound', + 'errorMessage' => 'The specified mount target does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"3BAB90FD-B4A0-48DA-9F09-2B963510****\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"MountTargets\\": {\\n \\"MountTarget\\": [\\n {\\n \\"VpcId\\": \\"vpc-2zesj9afh3y518k9o****\\",\\n \\"Status\\": \\"Active\\",\\n \\"ClientMasterNodes\\": {\\n \\"ClientMasterNode\\": [\\n {\\n \\"EcsId\\": \\"i-hp3i3odi5ory1buo****\\",\\n \\"DefaultPasswd\\": \\"12****\\",\\n \\"EcsIp\\": \\"192.168.1.0\\"\\n }\\n ]\\n },\\n \\"MountTargetDomain\\": \\"1ca404****-w****.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"AccessGroup\\": \\"DEFAULT_VPC_GROUP_NAME\\",\\n \\"DualStackMountTargetDomain\\": \\"1ca404****-x****.dualstack.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"VswId\\": \\"vsw-2zevmwkwyztjuoffg****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"nastest\\",\\n \\"Value\\": \\"mounttargettest\\"\\n }\\n ]\\n },\\n \\"NetworkType\\": \\"Vpc\\",\\n \\"IPVersion\\": \\"IPv4\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMountTargetsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>3BAB90FD-B4A0-48DA-9F09-2B963510****</RequestId>\\n <PageSize>1</PageSize>\\n <PageNumber>1</PageNumber>\\n <MountTargets>\\n <MountTarget>\\n <VpcId>vpc-2zesj9afh3y518k9o****</VpcId>\\n <Status>Active</Status>\\n <ClientMasterNodes>\\n <ClientMasterNode>\\n <EcsId>i-hp3i3odi5ory1buo****</EcsId>\\n <DefaultPasswd>12****</DefaultPasswd>\\n <EcsIp>192.168.1.0</EcsIp>\\n </ClientMasterNode>\\n </ClientMasterNodes>\\n <MountTargetDomain>1ca404a666-w****.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>\\n <AccessGroup>DEFAULT_VPC_GROUP_NAME</AccessGroup>\\n <DualStackMountTargetDomain>174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com</DualStackMountTargetDomain>\\n <VswId>vsw-2zevmwkwyztjuoffg****</VswId>\\n <NetworkType>Vpc</NetworkType>\\n <IPVersion>IPv4</IPVersion>\\n </MountTarget>\\n </MountTargets>\\n</DescribeMountTargetsResponse>","errorExample":""}]', + 'title' => '查询挂载点信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMountedClients' => [ + 'summary' => '查询已挂载的客户端列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13956', + 'abilityTreeNodes' => [ + 'FEATUREnasOIBEFL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每个分页包含的客户端IP的个数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'ClientIP', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端IP地址。'."\n" + ."\n" + .'- 当您指定客户端IP时，调用接口会判断客户端列表是否包含该客户端IP。若包含，则返回该客户端IP；若不包含，则返回空列表。'."\n" + .'- 当您未指定客户端IP时，调用接口会返回近1分钟使用NAS文件系统的所有客户端IP列表。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10.10.10.1', + ], + ], + [ + 'name' => 'MountTargetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1111222****95.cn-hangzhou.nas.aliyuncs.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的客户端IP的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A70BEE5D-76D3-49FB-B58F-1F398211****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的客户端IP个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '客户端列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Clients' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Client' => [ + 'description' => '客户端信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClientIP' => [ + 'description' => '客户端IP地址。', + 'type' => 'string', + 'example' => '10.10.10.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"A70BEE5D-76D3-49FB-B58F-1F398211****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Clients\\": {\\n \\"Client\\": [\\n {\\n \\"ClientIP\\": \\"10.10.10.1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMountedClientsResponse>\\n <TotalCount>10</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>A70BEE5D-76D3-49FB-B58F-1F398211****</RequestId>\\n <PageNumber>1</PageNumber>\\n <Clients>\\n <Client>\\n <ClientIP>10.10.10.1</ClientIP>\\n </Client>\\n </Clients>\\n</DescribeMountedClientsResponse>","errorExample":""}]', + 'title' => '查询已挂载的客户端列表', + 'description' => '- 仅通用型NAS支持该接口。'."\n" + .'- 客户端列表显示近一分钟对文件系统有读写访问的客户端IP，部分已挂载而没有访问文件系统的客户端IP可能不在此列表中显示。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAccessPoint' => [ + 'summary' => '创建接入点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '189584', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'AccessGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'当目标文件系统为通用型NAS，此参数必填。'."\n" + ."\n" + .'默认权限组：DEFAULT_VPC_GROUP_NAME（专有网络默认权限组）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + ], + [ + 'name' => 'VswId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-2zevmwkwyztjuoffg****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-2zesj9afh3y518k9o****', + ], + ], + [ + 'name' => 'AccessPointName', + 'in' => 'query', + 'schema' => [ + 'description' => '接入点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RootDirectory', + 'in' => 'query', + 'schema' => [ + 'description' => '接入点根目录。'."\n" + .'默认值为“/”， 如果接入点目录不存在，则还需要填写OwnerUserId和OwnerGroupId参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/', + 'pattern' => '^(/|(/\\.{3,}|/\\.*[-\\w]+[-.\\w]*)+/?)$', + 'default' => '/', + ], + ], + [ + 'name' => 'EnabledRam', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用RAM策略。'."\n" + .'取值：'."\n" + ."\n" + .'- true：开启'."\n" + .'- false（默认值）：不开启'."\n" + ."\n" + .'> 启用接入点RAM策略以后，缺省禁止所有RAM账号使用接入点挂载和访问数据，您需要为账号进行授权开放对应访问权限，并通过接入点进行挂载访问。禁用后，接入点允许匿名挂载。关于如何配置接入点权限，关于如何配置接入点权限，请参见[配置接入点策略](~~2545998~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'OwnerUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '属主用户ID。'."\n" + ."\n" + .'当RootDirectory目录不存在时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OwnerGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '属主用户组ID。'."\n" + ."\n" + .'当RootDirectory目录不存在时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Permission', + 'in' => 'query', + 'schema' => [ + 'description' => 'POSIX权限。默认值为“0755”。限制：必须以0开头的四位八进制数字。'."\n" + ."\n" + .'当填写OwnerUserId和OwnerGroupId参数后，此字段生效。', + 'type' => 'string', + 'required' => false, + 'example' => '0755', + ], + ], + [ + 'name' => 'PosixUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Posix用户ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'PosixGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Posix用户组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'PosixSecondaryGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '第二用户组。多个用户组ID时，使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '123,345', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。'."\n" + .'限制：'."\n" + ."\n" + .'- 不允许为空和空字符串。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。'."\n" + .'限制：'."\n" + ."\n" + .'- 不允许为空和空字符串。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能包含http://和https://。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****'."\n", + ], + 'AccessPoint' => [ + 'description' => '接入点。', + 'type' => 'object', + 'properties' => [ + 'AccessPointDomain' => [ + 'description' => '接入点域名。', + 'type' => 'string', + 'example' => 'ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com', + ], + 'AccessPointId' => [ + 'description' => '接入点ID。', + 'type' => 'string', + 'example' => 'ap-ie15yd****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest', + 'errorMessage' => 'The request is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidProtocolType.NotSupported', + 'errorMessage' => 'The specified protocol type does not supported.', + ], + [ + 'errorCode' => 'InvalidRamRole.NotExist', + 'errorMessage' => 'The specified RAM role does not exist.', + ], + [ + 'errorCode' => 'InvalidRamRole.NoPermission', + 'errorMessage' => 'The specified RAM role does not have sufficient permission.', + ], + [ + 'errorCode' => 'OperationDenied.AccessPointCountsExceeded', + 'errorMessage' => 'The maxium number of access point has reached its limits.', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccessGroup.NotFound', + 'errorMessage' => 'The specified AccessGroup does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidVpc.NotFound', + 'errorMessage' => 'The specified Vpc is not found.', + ], + [ + 'errorCode' => 'InvalidVswitch.NotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\\\n\\",\\n \\"AccessPoint\\": {\\n \\"AccessPointDomain\\": \\"ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"AccessPointId\\": \\"ap-ie15yd****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建接入点', + 'description' => '- 在使用CreateAccessPoint接口创建接入点时部分资源的生成是异步完成的。因此在执行CreateAccessPoint接口成功后，请先调用[DescribeAccessPoints](~~2712239~~)或者[DescribeAccessPoint](~~2712240~~)接口查询接入点状态，当接入点状态为**Active**后再执行挂载文件系统操作，否则可能会挂载失败。'."\n" + .'- 仅通用型NAS NFS协议文件系统支持该功能。'."\n" + .'- 如果开启RAM策略（EnabledRam），需要配置对应的RAM权限，具体请参考[管理接入点](~~2545998~~)。', + ], + 'ModifyAccessPoint' => [ + 'summary' => '修改接入点信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '189621', + 'abilityTreeNodes' => [ + 'FEATUREnas5IJRRZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'AccessPointId', + 'in' => 'query', + 'schema' => [ + 'description' => '接入点ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ap-ie15yd****', + ], + ], + [ + 'name' => 'AccessPointName', + 'in' => 'query', + 'schema' => [ + 'description' => '接入点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccessGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'当目标文件系统为通用型NAS，此参数必填。'."\n" + ."\n" + .'默认权限组：DEFAULT_VPC_GROUP_NAME（专有网络默认权限组）。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + ], + [ + 'name' => 'EnabledRam', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用RAM策略。'."\n" + .'取值：'."\n" + ."\n" + .'- true：开启'."\n" + .'- false（默认值）：不开启'."\n" + ."\n" + .'> 启用接入点RAM策略以后，缺省禁止所有RAM账号使用接入点挂载和访问数据，您需要为账号进行授权开放对应访问权限，并通过接入点进行挂载访问。禁用后，接入点允许匿名挂载。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'required' => true, + 'example' => '70EACC9C-D07A-4A34-ADA4-77506C42****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidAccessPointId.NotFound', + 'errorMessage' => 'The access point id does not exist.', + ], + [ + 'errorCode' => 'InvalidAccessGroup.NotFound', + 'errorMessage' => 'The specified AccessGroup does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70EACC9C-D07A-4A34-ADA4-77506C42****\\\\n\\"\\n}","type":"json"}]', + 'title' => '修改接入点信息', + 'description' => '仅通用型NAS NFS协议文件系统支持该功能。', + ], + 'DescribeAccessPoints' => [ + 'summary' => '查询接入点信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189598', + 'abilityTreeNodes' => [ + 'FEATUREnas0MLWQI', + 'FEATUREnas3DACY7', + 'FEATUREnas71NBOZ', + 'FEATUREnas5IJRRZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => '174494****', + ], + ], + [ + 'name' => 'AccessGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'当目标文件系统为通用型NAS，此参数必填。'."\n" + ."\n" + .'默认权限组：DEFAULT_VPC_GROUP_NAME（专有网络默认权限组）。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询结果的个数。'."\n" + ."\n" + .'取值范围：10~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- N 的取值范围为 1~20。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- N 的取值范围为 1~20。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'required' => true, + 'example' => '6299428C-3861-435D-AE54-9B330A00****', + ], + 'AccessPoints' => [ + 'description' => '接入点信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ARN' => [ + 'description' => '接入点ARN。', + 'type' => 'string', + 'example' => 'acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****', + ], + 'AccessGroup' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AccessPointId' => [ + 'description' => '接入点ID。', + 'type' => 'string', + 'example' => 'ap-ie15y*****'."\n", + ], + 'AccessPointName' => [ + 'description' => '接入点名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '接入点的创建时间。', + 'type' => 'string', + 'example' => '1709619668276167', + ], + 'DomainName' => [ + 'description' => '接入点域名名称。', + 'type' => 'string', + 'example' => 'ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com', + ], + 'EnabledRam' => [ + 'description' => '是否启用RAM策略。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '31a8e4****'."\n", + ], + 'ModifyTime' => [ + 'description' => '接入点的修改时间 。', + 'type' => 'string', + 'example' => '1709619668276167', + ], + 'PosixUser' => [ + 'description' => 'Posix用户。', + 'type' => 'object', + 'properties' => [ + 'PosixGroupId' => [ + 'description' => 'Posix用户组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PosixUserId' => [ + 'description' => 'Posix用户ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'PosixSecondaryGroupIds' => [ + 'description' => '第二用户组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '第二用户组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[123,123]', + ], + ], + ], + ], + 'RootPath' => [ + 'description' => '根目录。', + 'type' => 'string', + 'example' => '/', + ], + 'RootPathPermission' => [ + 'description' => '根目录权限。', + 'type' => 'object', + 'properties' => [ + 'OwnerGroupId' => [ + 'description' => '属主用户组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'OwnerUserId' => [ + 'description' => '属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Permission' => [ + 'description' => 'POSIX权限。', + 'type' => 'string', + 'example' => '0755', + ], + ], + ], + 'RootPathStatus' => [ + 'description' => '当前根目录状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- 0：rootpath状态未知'."\n" + .'- 1：rootpath不存在（可能被用户删除了）'."\n" + .'- 2：rootpath状态正常', + 'type' => 'string', + 'example' => '2', + ], + 'Status' => [ + 'description' => '当前接入点状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Active：可用'."\n" + .'- Inactive：不可用'."\n" + .'- Pending：创建中'."\n" + .'- Deleting：删除中'."\n" + ."\n" + .'> 当状态为Active时才可以挂载文件系统。', + 'type' => 'string', + 'example' => 'Active', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2zevmwkwyztjuoffg****'."\n", + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-2zesj9afh3y518k9o****'."\n", + ], + 'Tags' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。', + 'type' => 'string', + 'example' => 'MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****'."\n", + ], + 'TotalCount' => [ + 'description' => '接入点总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'The API operation does not support the file system type.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidProtocolType.NotSupported', + 'errorMessage' => 'The specified protocol type does not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidAccessGroup.NotFound', + 'errorMessage' => 'The specified AccessGroup does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6299428C-3861-435D-AE54-9B330A00****\\",\\n \\"AccessPoints\\": [\\n {\\n \\"ARN\\": \\"acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****\\",\\n \\"AccessGroup\\": \\"test\\",\\n \\"AccessPointId\\": \\"ap-ie15y*****\\\\n\\",\\n \\"AccessPointName\\": \\"test\\",\\n \\"CreateTime\\": \\"1709619668276167\\",\\n \\"DomainName\\": \\"ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"EnabledRam\\": false,\\n \\"FileSystemId\\": \\"31a8e4****\\\\n\\",\\n \\"ModifyTime\\": \\"1709619668276167\\",\\n \\"PosixUser\\": {\\n \\"PosixGroupId\\": 12,\\n \\"PosixUserId\\": 123,\\n \\"PosixSecondaryGroupIds\\": [\\n 0\\n ]\\n },\\n \\"RootPath\\": \\"/\\",\\n \\"RootPathPermission\\": {\\n \\"OwnerGroupId\\": 12,\\n \\"OwnerUserId\\": 1,\\n \\"Permission\\": \\"0755\\"\\n },\\n \\"RootPathStatus\\": \\"2\\",\\n \\"Status\\": \\"Active\\",\\n \\"VSwitchId\\": \\"vsw-2zevmwkwyztjuoffg****\\\\n\\",\\n \\"VpcId\\": \\"vpc-2zesj9afh3y518k9o****\\\\n\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****\\\\n\\",\\n \\"TotalCount\\": 20\\n}","type":"json"}]', + 'title' => '查询接入点信息', + 'description' => '仅通用型NAS NFS协议文件系统支持该功能。', + ], + 'DescribeAccessPoint' => [ + 'summary' => '查询接入点详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192492', + 'abilityTreeNodes' => [ + 'FEATUREnas5IJRRZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'AccessPointId', + 'in' => 'query', + 'schema' => [ + 'description' => '接入点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ap-ie15yd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'required' => true, + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'AccessPoint' => [ + 'description' => '接入点信息。', + 'type' => 'object', + 'properties' => [ + 'ARN' => [ + 'description' => '接入点ARN。', + 'type' => 'string', + 'example' => 'acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****', + ], + 'AccessGroup' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'example' => 'test'."\n", + ], + 'AccessPointId' => [ + 'description' => '接入点ID。', + 'type' => 'string', + 'example' => 'ap-ie15yd****'."\n", + ], + 'AccessPointName' => [ + 'description' => '接入点名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '接入点的创建时间。', + 'type' => 'string', + 'example' => '1709619668276167', + ], + 'DomainName' => [ + 'description' => '接入点域名。', + 'type' => 'string', + 'example' => 'ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com', + ], + 'EnabledRam' => [ + 'description' => '是否启用RAM策略。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '31a8e4****', + ], + 'ModifyTime' => [ + 'description' => '接入点修改时间 。', + 'type' => 'string', + 'example' => '1709619668276167', + ], + 'RootPathPermission' => [ + 'description' => '根目录创建权限。', + 'type' => 'object', + 'properties' => [ + 'OwnerGroupId' => [ + 'description' => '属主用户组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'OwnerUserId' => [ + 'description' => '属主用户ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Permission' => [ + 'description' => 'POSIX权限。', + 'type' => 'string', + 'example' => '0755', + ], + ], + ], + 'PosixUser' => [ + 'description' => 'Posix用户。', + 'type' => 'object', + 'properties' => [ + 'PosixGroupId' => [ + 'description' => 'Posix用户组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PosixUserId' => [ + 'description' => 'Posix用户ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'PosixSecondaryGroupIds' => [ + 'description' => '第二用户组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '第二用户组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[123,123]', + ], + ], + ], + ], + 'RootPath' => [ + 'description' => '根目录。', + 'type' => 'string', + 'example' => '/', + ], + 'RootPathStatus' => [ + 'description' => '当前根目录状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- 0：rootpath状态未知'."\n" + .'- 1：rootpath不存在（可能被用户删除了）'."\n" + .'- 2：rootpath状态正常', + 'type' => 'string', + 'example' => '2', + ], + 'Status' => [ + 'description' => '当前接入点状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Active：可用'."\n" + .'- Inactive：不可用'."\n" + .'- Pending：创建中'."\n" + .'- Deleting：删除中', + 'type' => 'string', + 'example' => 'Active', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2zevmwkwyztjuoffg****', + ], + 'VpcId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'必须与待挂载的云服务器ECS选择相同的VPC网络。', + 'type' => 'string', + 'example' => 'vpc-2zesj9afh3y518k9o****', + ], + 'Tags' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '接入点标签列表', + 'description' => '接入点标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidAccessPointId.NotFound', + 'errorMessage' => 'The access point id does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"AccessPoint\\": {\\n \\"ARN\\": \\"acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****\\",\\n \\"AccessGroup\\": \\"test\\\\n\\",\\n \\"AccessPointId\\": \\"ap-ie15yd****\\\\n\\",\\n \\"AccessPointName\\": \\"test\\",\\n \\"CreateTime\\": \\"1709619668276167\\",\\n \\"DomainName\\": \\"ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"EnabledRam\\": false,\\n \\"FileSystemId\\": \\"31a8e4****\\",\\n \\"ModifyTime\\": \\"1709619668276167\\",\\n \\"RootPathPermission\\": {\\n \\"OwnerGroupId\\": 123,\\n \\"OwnerUserId\\": 1,\\n \\"Permission\\": \\"0755\\"\\n },\\n \\"PosixUser\\": {\\n \\"PosixGroupId\\": 12,\\n \\"PosixUserId\\": 123,\\n \\"PosixSecondaryGroupIds\\": [\\n 0\\n ]\\n },\\n \\"RootPath\\": \\"/\\",\\n \\"RootPathStatus\\": \\"2\\",\\n \\"Status\\": \\"Active\\",\\n \\"VSwitchId\\": \\"vsw-2zevmwkwyztjuoffg****\\",\\n \\"VpcId\\": \\"vpc-2zesj9afh3y518k9o****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n}","type":"json"}]', + 'title' => '查询接入点详情', + 'description' => '仅通用型NAS NFS协议文件系统支持该功能。', + ], + 'DeleteAccessPoint' => [ + 'summary' => '删除接入点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '189632', + 'abilityTreeNodes' => [ + 'FEATUREnas5IJRRZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1ca404****', + 'maxLength' => 64, + 'minLength' => 3, + ], + ], + [ + 'name' => 'AccessPointId', + 'in' => 'query', + 'schema' => [ + 'description' => '接入点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ap-ie15yd****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidAccessPointId.NotFound', + 'errorMessage' => 'The access point id does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","type":"json"}]', + 'title' => '删除接入点', + 'description' => '- 仅通用型NAS NFS协议文件系统支持该功能。'."\n" + .'- 删除接入点后，会立即中断当前正在通过接入点访问此目录的所有I/O，请谨慎操作。', + ], + 'CreateDir' => [ + 'summary' => '在文件系统中创建目录。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '189884', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'RootDirectory', + 'in' => 'query', + 'schema' => [ + 'description' => '目录名称。'."\n" + ."\n" + .'- 必须以正斜线（/）开头。'."\n" + .'- 支持数字、大小写字母。'."\n" + .'- 可以包含下划线（_）、短划线（-）或半角句号（.）。'."\n" + .'- 路径中不能包含软链接，如本层目录（.）、上层目录（..）或其他软链接。'."\n" + .'> - 如果根目录不存在，则需要配置目录创建信息，系统将根据设置自动创建指定的根目录。'."\n" + .' > - 如果根目录已存在，则不需要配置目录创建信息，如果进行配置，目录创建信息中的配置也会被忽略。', + 'type' => 'string', + 'required' => true, + 'example' => '/test', + ], + ], + [ + 'name' => 'OwnerUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '目录的拥有者用户ID。'."\n" + .'支持从0至4294967295的值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'OwnerGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '目录的拥有者用户组ID。支持从0至4294967295的值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Permission', + 'in' => 'query', + 'schema' => [ + 'description' => '指定应用到根目录路径的POSIX权限。'."\n" + .'格式为合法的八进制数，如0755。', + 'type' => 'string', + 'required' => true, + 'example' => '0755', + ], + ], + [ + 'name' => 'Recursion', + 'in' => 'query', + 'schema' => [ + 'description' => '是否创建多级目录。'."\n" + .'取值：'."\n" + ."\n" + .'- true（默认值）：如果多级目录不存在，逐级创建。'."\n" + .'- false：只创建最后一级目录，父目录不存在返回错误信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidProtocolType.NotSupported', + 'errorMessage' => 'The specified protocol type does not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\"\\n}","type":"json"}]', + 'title' => '创建目录', + 'description' => '仅通用型NAS NFS协议文件系统支持该功能。', + ], + 'CreateAccessGroup' => [ + 'summary' => '创建权限组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13927', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为3~64个字符。'."\n" + .'- 必须以大小写字母开头，可以包含英文字母、数字、下划线（_）或者短划线（-）。'."\n" + .'- 新创建的权限组名称不能与默认权限组的名称相同。'."\n" + ."\n" + .'默认权限组：DEFAULT_VPC_GROUP_NAME（专有网络默认权限组）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'AccessGroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组类型。取值为**Vpc**，表示专有网络。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Vpc', + 'enum' => [ + 'Vpc', + 'VPC', + 'vpc', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组描述。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 默认和名称相同，长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划号（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpctestaccessgroup', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '55C5FFD6-BF99-41BD-9C66-FFF39189F4F8', + ], + 'AccessGroupName' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'example' => 'vpc-test', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"55C5FFD6-BF99-41BD-9C66-FFF39189F4F8\\",\\n \\"AccessGroupName\\": \\"vpc-test\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccessGroupResponse>\\n <RequestId>55C5FFD6-BF99-41BD-9C66-FFF39189F4F8</RequestId>\\n <AccessGroupName>vpc-test</AccessGroupName>\\n</CreateAccessGroupResponse>","errorExample":""}]', + 'title' => '创建权限组', + 'description' => '- 一个阿里云账号在单个地域内最多可以创建20个权限组。'."\n" + .'- 一个权限组最多支持添加300个规则。'."\n" + .'- 仅支持创建专有网络类型的权限组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAccessGroup' => [ + 'summary' => '删除已有的权限组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13936', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的权限组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + .'- standard（默认值）：通用型NAS'."\n" + .'- extreme：极速型NAS', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E15E394-38A6-457A-A62A-D9797C9A****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E15E394-38A6-457A-A62A-D9797C9A****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>","errorExample":""}]', + 'title' => '删除权限组', + 'description' => '默认权限组（DEFAULT\\_VPC\\_GROUP\\_NAME）不支持删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccessGroup' => [ + 'summary' => '修改权限组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13973', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为3~64个字符。'."\n" + .'- 必须以大小写字母开头，可以包含英文字母、数字、下划线（_）或者短划号（-）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组描述。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 默认和权限组名称相同，长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划号（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + .'- standard（默认值）：通用型NAS'."\n" + .'- extreme：极速型NAS', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ED2AE737-9D50-4CA4-B0DA-31BD610C****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ED2AE737-9D50-4CA4-B0DA-31BD610C****\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"ED2AE737-9D50-4CA4-B0DA-31BD610C2363\\"\\n}\\n"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<ModifyAccessGroupResponse>\\n <RequestId>ED2AE737-9D50-4CA4-B0DA-31BD610C****</RequestId>\\n</ModifyAccessGroupResponse>\\n","errorExample":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<ModifyAccessGroupResponse>\\n <RequestId>ED2AE737-9D50-4CA4-B0DA-31BD610C2363</RequestId>\\n</ModifyAccessGroupResponse>\\n"}]', + 'title' => '修改权限组', + 'description' => '默认权限组（DEFAULT_VPC_GROUP_NAME）不支持修改。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccessGroups' => [ + 'summary' => '查询权限组信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13945', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为3~64个字符。'."\n" + ."\n" + .'- 必须以大小写字母开头，可以包含英文字母、数字、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每个分页包含的权限组个数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '2', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'UseUTCDateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回的时间是否按照UTC标准格式表示。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true（默认值）：返回的时间为UTC标准格式。'."\n" + .'- false：返回的时间为非UTC标准格式。', + 'type' => 'boolean', + 'required' => false, + 'minimum' => '1', + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。'."\n" + .'- cpfs：CPFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + 'cpfs', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccessGroup' => [ + 'description' => '权限组信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccessGroupName' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + 'Description' => [ + 'description' => '权限组描述信息。', + 'type' => 'string', + 'example' => 'This is a test access group.', + ], + 'CreateTime' => [ + 'description' => '权限组的创建时间。', + 'type' => 'string', + 'example' => '2020-01-05T16:00:00Z', + ], + 'AccessGroupType' => [ + 'description' => '权限组类型。取值为**Vpc**，表示专有网络。', + 'type' => 'string', + 'example' => 'Vpc', + ], + 'RuleCount' => [ + 'description' => '此权限组中包含的权限组规则数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MountTargetCount' => [ + 'description' => '应用此权限组的挂载点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。'."\n" + .'- cpfs：CPFS。', + 'type' => 'string', + 'example' => 'standard', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '权限组的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2514F97E-FFF0-4A1F-BF04-729CEAC6****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的权限组个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageNumber' => [ + 'description' => '列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessGroups\\": {\\n \\"AccessGroup\\": [\\n {\\n \\"AccessGroupName\\": \\"DEFAULT_VPC_GROUP_NAME\\",\\n \\"Description\\": \\"This is a test access group.\\",\\n \\"CreateTime\\": \\"2020-01-05T16:00:00Z\\",\\n \\"AccessGroupType\\": \\"Vpc\\",\\n \\"RuleCount\\": 0,\\n \\"MountTargetCount\\": 0,\\n \\"FileSystemType\\": \\"standard\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"2514F97E-FFF0-4A1F-BF04-729CEAC6****\\",\\n \\"PageSize\\": 2,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccessGroupsResponse>\\n <AccessGroups>\\n <AccessGroupName>DEFAULT_VPC_GROUP_NAME</AccessGroupName>\\n <Description>This is a test access group.</Description>\\n <CreateTime>2020-01-05T16:00:00Z</CreateTime>\\n <AccessGroupType>Vpc</AccessGroupType>\\n <RuleCount>0</RuleCount>\\n <MountTargetCount>0</MountTargetCount>\\n </AccessGroups>\\n <TotalCount>1</TotalCount>\\n <RequestId>2514F97E-FFF0-4A1F-BF04-729CEAC6****</RequestId>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n</DescribeAccessGroupsResponse>","errorExample":""}]', + 'title' => '查询权限组信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAccessRule' => [ + 'summary' => '创建权限组规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13928', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'SourceCidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => '授权对象的IP地址或网段。'."\n" + ."\n" + .'格式必须为单一的IP地址或者CIDR网段。'."\n" + .'> 经典网络类型的权限组只支持IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '192.0.2.0/16', + ], + ], + [ + 'name' => 'RWAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '授权对象对文件系统的读写权限。'."\n" + ."\n" + .'取值：'."\n" + .'- RDWR（默认值）：读写。'."\n" + .'- RDONLY：只读。', + 'type' => 'string', + 'required' => false, + 'example' => 'RDWR', + 'default' => 'RDWR', + 'enum' => [ + 'RDWR', + 'RDONLY', + ], + ], + ], + [ + 'name' => 'UserAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '授权对象的系统用户对文件系统的访问权限。'."\n" + ."\n" + .'取值：'."\n" + .'- no_squash（默认值）：允许使用root用户访问文件系统。'."\n" + .'- root_squash：以root用户身份访问时，映射nobody用户。'."\n" + .'- all_squash：无论以何种用户身份访问，均映射为nobody用户。'."\n" + ."\n" + .'nobody用户是Linux系统的默认用户，只能访问服务器上的公共内容，具有低权限、高安全性的特点。', + 'type' => 'string', + 'required' => false, + 'example' => 'no_squash', + 'default' => 'no_squash', + 'enum' => [ + 'no_squash', + 'root_squash', + 'all_squash', + ], + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组规则优先级。'."\n" + ."\n" + .'当同一个授权对象匹配到多条规则时，高优先级规则生效。'."\n" + ."\n" + .'取值范围：1~100，1为最高优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + ], + ], + ], + [ + 'name' => 'Ipv6SourceCidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => '源端IPv6 CIDR地址段。'."\n" + ."\n" + .'支持CIDR格式和IPv6格式的IP地址范围。'."\n" + ."\n" + .'> - 当前仅极速型NAS中国内地各地域支持IPv6功能，且该文件系统需要开启IPv6功能。'."\n" + .'>- 只支持VPC网络。'."\n" + .'>- IPv4和IPv6互斥。', + 'type' => 'string', + 'required' => false, + 'example' => '2001:250:6000::***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A323836B-5BC6-45A6-8048-60675C23****', + ], + 'AccessRuleId' => [ + 'description' => '权限组规则ID。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.Ipv6SourceCidrIp', + 'errorMessage' => 'IPv6 address verification failed.', + ], + [ + 'errorCode' => 'InvalidParam.SourceCidrIp', + 'errorMessage' => 'IPv4 address verification failed.', + ], + [ + 'errorCode' => 'InvalidParam.IPv4AndIPv6MutuallyExclusive', + 'errorMessage' => 'You cannot configure IPv4 and IPv6 at the same time.', + ], + [ + 'errorCode' => 'InvalidAccessGroup.NotsupportedIPv6', + 'errorMessage' => 'The access group does not support IPv6.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A323836B-5BC6-45A6-8048-60675C23****\\",\\n \\"AccessRuleId\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccessRuleResponse>\\n <RequestId>A323836B-5BC6-45A6-8048-60675C23****</RequestId>\\n <AccessRuleId>1</AccessRuleId>\\n</CreateAccessRuleResponse>","errorExample":""}]', + 'title' => '创建权限组规则', + 'description' => '一个权限组最多支持添加300个规则。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAccessRule' => [ + 'summary' => '删除已创建的权限组规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13937', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'AccessRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组规则ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5B4511A7-C99E-4071-AA8C-32E2529D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B4511A7-C99E-4071-AA8C-32E2529D****\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"5B4511A7-C99E-4071-AA8C-32E2529DA963\\",\\n}\\n"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DeleteAccessRuleResponse>\\n <RequestId>5B4511A7-C99E-4071-AA8C-32E2529D****</RequestId>\\n</DeleteAccessRuleResponse>\\n","errorExample":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DeleteAccessRuleResponse>\\n <RequestId>5B4511A7-C99E-4071-AA8C-32E2529DA963</RequestId>\\n</DeleteAccessRuleResponse>\\n"}]', + 'title' => '删除权限组规则', + 'description' => '默认权限组（DEFAULT_VPC_GROUP_NAME）中的规则不支持删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccessRule' => [ + 'summary' => '修改一个权限组规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13974', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-test', + ], + ], + [ + 'name' => 'AccessRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组规则ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SourceCidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP地址或网段。'."\n" + ."\n" + .'格式必须为单一的IP地址或者CIDR网段。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '192.0.**.**', + ], + ], + [ + 'name' => 'RWAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '授权对象对文件系统的读写权限。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- RDWR（默认值）：读写。'."\n" + .'- RDONLY：只读。', + 'type' => 'string', + 'required' => false, + 'example' => 'RDWR', + 'default' => 'RDWR', + 'enum' => [ + 'RDWR', + 'RDONLY', + ], + ], + ], + [ + 'name' => 'UserAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '授权对象的系统用户对文件系统的访问权限。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- no_squash：允许使用root用户访问文件系统。'."\n" + .'- root_squash：以root用户身份访问时，映射nobody用户。'."\n" + .'- all_squash：无论以何种用户身份访问，均映射为nobody用户。'."\n" + ."\n" + .'nobody用户是Linux系统的默认用户，只能访问服务器上的公共内容，具有低权限，高安全性的特点。', + 'type' => 'string', + 'required' => false, + 'example' => 'all_squash', + 'default' => 'no_squash', + 'enum' => [ + 'no_squash', + 'root_squash', + 'all_squash', + ], + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组规则优先级。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：1（最高优先级）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + ], + ], + ], + [ + 'name' => 'Ipv6SourceCidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => '源端IPv6 CIDR地址段。'."\n" + ."\n" + .'支持CIDR格式和IPv6格式的IP地址。'."\n" + ."\n" + .'> - 仅华北5（呼和浩特）地域的极速型NAS支持CIDR地址段。'."\n" + .'> - 仅支持VPC专有网络。'."\n" + .'> - IPv4和IPv6互斥，类型不能转换。', + 'type' => 'string', + 'required' => false, + 'example' => 'fe80::3d4a:80fd:f05d:****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6299428C-3861-435D-AE54-9B330A00****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.Ipv6SourceCidrIp', + 'errorMessage' => 'IPv6 address verification failed.', + ], + [ + 'errorCode' => 'InvalidParam.SourceCidrIp', + 'errorMessage' => 'IPv4 address verification failed.', + ], + [ + 'errorCode' => 'InvalidParam.IPv4AndIPv6MutuallyExclusive', + 'errorMessage' => 'You cannot configure IPv4 and IPv6 at the same time.', + ], + [ + 'errorCode' => 'InvalidAccessGroup.NotsupportedIPv6', + 'errorMessage' => 'The access group does not support IPv6.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6299428C-3861-435D-AE54-9B330A00****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccessRuleResponse>\\n <RequestId>6299428C-3861-435D-AE54-9B330A00****</RequestId>\\n</ModifyAccessRuleResponse>","errorExample":""}]', + 'title' => '修改权限组规则', + 'description' => '默认权限组（DEFAULT_VPC_GROUP_NAME）中的规则不支持修改。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccessRules' => [ + 'summary' => '查询权限规则描述。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13946', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'classic-test', + ], + ], + [ + 'name' => 'AccessRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '权限规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每个分页包含的文件系统个数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + 'default' => 'standard', + 'enum' => [ + 'standard', + 'extreme', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '权限规则的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '86D89E82-4297-4343-8E1E-A2495B35****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的权限规则个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '文件系统列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccessRules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccessRule' => [ + 'description' => '权限规则信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccessRuleId' => [ + 'description' => '权限规则ID。', + 'type' => 'string', + 'example' => '1', + ], + 'SourceCidrIp' => [ + 'description' => '地址或地址段。', + 'type' => 'string', + 'example' => '10.0.*.*/**', + ], + 'Ipv6SourceCidrIp' => [ + 'description' => '源端IPv6 CIDR地址段。', + 'type' => 'string', + 'example' => '2001:250:6000::***', + ], + 'RWAccess' => [ + 'description' => '授权对象对文件系统的读写权限。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- RDWR（默认值）：读写。'."\n" + .'- RDONLY：只读。', + 'type' => 'string', + 'example' => 'RDWR', + ], + 'UserAccess' => [ + 'description' => '授权对象的系统用户对文件系统的访问权限。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- no_squash：允许使用root用户访问文件系统。'."\n" + .'- root_squash：以root用户身份访问时，映射nobody用户。'."\n" + .'- all_squash：无论以何种用户身份访问，均映射为nobody用户。'."\n" + ."\n" + .'nobody用户是Linux系统的默认用户，只能访问服务器上的公共内容，具有低权限，高安全性的特点。', + 'type' => 'string', + 'example' => 'no_squash', + ], + 'Priority' => [ + 'description' => '优先级。'."\n" + ."\n" + .'当同一个授权对象匹配到多条规则时，高优先级规则生效。'."\n" + ."\n" + .'取值范围：1~100，1为最高优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard（默认值）：通用型NAS。'."\n" + .'- extreme：极速型NAS。', + 'type' => 'string', + 'example' => 'standard', + ], + 'AccessGroupName' => [ + 'description' => '权限组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"86D89E82-4297-4343-8E1E-A2495B35****\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"AccessRules\\": {\\n \\"AccessRule\\": [\\n {\\n \\"AccessRuleId\\": \\"1\\",\\n \\"SourceCidrIp\\": \\"10.0.*.*/**\\",\\n \\"Ipv6SourceCidrIp\\": \\"2001:250:6000::***\\",\\n \\"RWAccess\\": \\"RDWR\\",\\n \\"UserAccess\\": \\"no_squash\\",\\n \\"Priority\\": 1,\\n \\"FileSystemType\\": \\"standard\\",\\n \\"AccessGroupName\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccessRulesResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>1</PageSize>\\n <RequestId>86D89E82-4297-4343-8E1E-A2495B35****</RequestId>\\n <PageNumber>1</PageNumber>\\n <AccessRules>\\n <AccessRule>\\n <RWAccess>RDWR</RWAccess>\\n <UserAccess>no_squash</UserAccess>\\n <Priority>1</Priority>\\n <SourceCidrIp>10.0.*.*/**</SourceCidrIp>\\n <Ipv6SourceCidrIp>2001:250:6000::***</Ipv6SourceCidrIp>\\n <AccessRuleId>1</AccessRuleId>\\n </AccessRule>\\n </AccessRules>\\n</DescribeAccessRulesResponse>","errorExample":""}]', + 'title' => '查询权限规则描述', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateSnapshot' => [ + 'summary' => '创建一个快照。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13935', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '极速型NAS高级型文件系统ID。必须以`extreme-`开头，例如`extreme-01dd****`', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'extreme-01dd****', + ], + ], + [ + 'name' => 'SnapshotName', + 'in' => 'query', + 'schema' => [ + 'description' => '快照名称。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n" + .'- 为防止和自动快照的名称冲突，不能以auto开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '快照说明。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~256个英文或中文字符。'."\n" + .'- 不能以`http://`和`https://`开头。'."\n" + .'- 默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDepet', + ], + ], + [ + 'name' => 'RetentionDays', + 'in' => 'query', + 'schema' => [ + 'description' => '快照的保留时间。'."\n" + ."\n" + .'单位：天'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- -1（默认值）：永久保存，当快照数量达到额度上限后被自动删除。'."\n" + .'- 1~65536：指定保存天数，保留时间到期后快照会被自动释放。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '65536', + 'minimum' => '-1', + 'example' => '30', + 'default' => '-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SnapshotId' => [ + 'description' => '快照ID。', + 'type' => 'string', + 'example' => 's-extreme-snapsho****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotId\\": \\"s-extreme-snapsho****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<SnapshotId>s-extreme-snapsho****</SnapshotId>\\n<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>","errorExample":""}]', + 'title' => '创建快照', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.40a34bbe4vbvKY)。'."\n" + .'- 仅极速型NAS高级型支持创建快照。'."\n" + .'- 一个文件系统最多支持创建128份快照。'."\n" + .'- 文件系统挂载的实例必须处于正常状态，否则无法创建快照。'."\n" + .'- 如果创建快照还未完成，您无法为该文件系统再次创建快照。'."\n" + .'- 如果创建快照时文件系统正好达到过期释放时间，文件系统会被释放的同时也会删除创建中（Creating）的快照。'."\n" + .'- 创建快照可能会轻微降低文件系统的性能，I/O性能短暂变慢，建议您避开业务高峰。'."\n" + .'- 快照只会备份某一时刻的数据，创建快照期间，操作文件系统产生的增量数据不会同步到快照中。'."\n" + .'- 您手动创建的快照会一直保留，直至账户欠费停止服务15天后被删除。请定期删除不再需要的快照，避免快照容量持续扣费。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持创建快照。'."\n" + .'- 一个文件系统最多支持创建128份快照。'."\n" + .'- 文件系统挂载的实例必须处于正常状态，否则无法创建快照。'."\n" + .'- 如果创建快照还未完成，您无法为该文件系统再次创建快照。'."\n" + .'- 如果创建快照时文件系统正好达到过期释放时间，文件系统会被释放的同时也会删除创建中（Creating）的快照。'."\n" + .'- 创建快照可能会轻微降低文件系统的性能，I/O性能短暂变慢，建议您避开业务高峰。'."\n" + .'- 快照只会备份某一时刻的数据，创建快照期间，操作文件系统产生的增量数据不会同步到快照中。'."\n" + .'- 您手动创建的快照会一直保留，直至账户欠费停止服务15天后被删除。请定期删除不再需要的快照，避免快照容量持续扣费。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSnapshot' => [ + 'summary' => '删除指定的快照或取消正在创建的快照任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13944', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => '快照ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 's-extreme-snapsho****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n" + .'无论调用接口成功与否，都会返回请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>","errorExample":""}]', + 'title' => '删除快照或取消正在创建的快照任务', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSnapshots' => [ + 'summary' => '查询指定文件系统一个或多个快照的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13961', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：extreme（极速型NAS）', + 'type' => 'string', + 'required' => false, + 'example' => 'extreme', + 'enum' => [ + 'extreme', + ], + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'extreme-22f****', + ], + ], + [ + 'name' => 'SnapshotIds', + 'in' => 'query', + 'schema' => [ + 'description' => '快照标识编码。'."\n" + ."\n" + .'可以由多个快照ID组成，多个ID用半角逗号（,）隔开，最多支持100个ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh****', + ], + ], + [ + 'name' => 'SnapshotName', + 'in' => 'query', + 'schema' => [ + 'description' => '快照名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + [ + 'name' => 'SnapshotType', + 'in' => 'query', + 'schema' => [ + 'description' => '快照类型。'."\n" + ."\n" + .'取值：'."\n" + .'- auto：自动快照'."\n" + .'- user：手动创建的快照'."\n" + .'- all（默认值）：所有快照类型', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'default' => 'all', + 'enum' => [ + 'auto', + 'user', + 'all', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '快照状态。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- progressing：正在创建的快照'."\n" + .'- accomplished：创建成功的快照'."\n" + .'- failed：创建失败的快照'."\n" + .'- all（默认）：所有快照状态', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'default' => 'all', + 'enum' => [ + 'progressing', + 'accomplished', + 'failed', + 'all', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '快照列表的页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '快照总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'PageSize' => [ + 'description' => '查询结果每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '快照列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Snapshots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => '快照详情集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '快照状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- progressing：正在创建的快照'."\n" + .'- accomplished：创建成功的快照'."\n" + .'- failed：创建失败的快照', + 'type' => 'string', + 'example' => 'accomplished', + ], + 'Progress' => [ + 'description' => '创建快照的进度。以百分比表示。', + 'type' => 'string', + 'example' => '100', + ], + 'CreateTime' => [ + 'description' => '创建时间。'."\n" + ."\n" + .'按照[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)标准表示，并使用UTC时间。格式为：`yyyy-MM-ddThh:mmZ`。'."\n", + 'type' => 'string', + 'example' => '2014-07-24T13:00:52Z', + ], + 'SourceFileSystemId' => [ + 'description' => '源文件系统ID。'."\n" + ."\n" + .'如果快照的源文件系统已经被删除，该字段仍旧保留。', + 'type' => 'string', + 'example' => 'extreme-012****', + ], + 'RetentionDays' => [ + 'description' => '自动快照保留天数。'."\n" + ."\n" + .'单位：天。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- -1：永久保存，当快照数量达到额度上限后被自动删除。'."\n" + .'- 1~65536：指定保存天数，保留时间到期后快照会被自动释放。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RemainTime' => [ + 'description' => '正在创建的快照任务剩余完成时间。'."\n" + ."\n" + .'单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '38', + ], + 'SourceFileSystemSize' => [ + 'description' => '源文件系统容量。'."\n" + ."\n" + .'单位：GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + 'SourceFileSystemVersion' => [ + 'description' => '源文件系统版本号。', + 'type' => 'string', + 'example' => '1', + ], + 'SnapshotName' => [ + 'description' => '快照名称。'."\n" + ."\n" + .'创建快照时指定了快照名称，则返回快照名称。创建快照时未指定快照名称，则不返回此参数。', + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + 'EncryptType' => [ + 'description' => '加密类型。'."\n" + ."\n" + .'包括：'."\n" + .'- 0：不加密'."\n" + .'- 1：加密', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Description' => [ + 'description' => '接口说明信息。', + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'SnapshotId' => [ + 'description' => '快照ID。', + 'type' => 'string', + 'example' => 's-extreme-snapsho****', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型。', + 'type' => 'string', + 'example' => 'extreme', + ], + 'SnapshotType' => [ + 'description' => '快照创建类型。'."\n" + .'枚举值：'."\n" + .'- auto: 自动创建快照'."\n" + .'- user: 手动创建快照', + 'type' => 'string', + 'example' => 'user', + ], + 'CompletedTime' => [ + 'description' => '完成时间。'."\n" + ."\n" + .'按照[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)标准表示，并使用UTC时间。格式为：`yyyy-MM-ddThh:mmZ`。'."\n" + ."\n" + .'> 这个字段仅在快照状态完成时有效，在快照创建过程中，这个字段的值和CreateTime一致。', + 'type' => 'string', + 'example' => '2014-07-24T13:10:52Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 36,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Snapshots\\": {\\n \\"Snapshot\\": [\\n {\\n \\"Status\\": \\"accomplished\\",\\n \\"Progress\\": \\"100\\",\\n \\"CreateTime\\": \\"2014-07-24T13:00:52Z\\",\\n \\"SourceFileSystemId\\": \\"extreme-012****\\",\\n \\"RetentionDays\\": 30,\\n \\"RemainTime\\": 38,\\n \\"SourceFileSystemSize\\": 2000,\\n \\"SourceFileSystemVersion\\": \\"1\\",\\n \\"SnapshotName\\": \\"FinanceJoshua\\",\\n \\"EncryptType\\": 1,\\n \\"Description\\": \\"FinanceDept\\",\\n \\"SnapshotId\\": \\"s-extreme-snapsho****\\",\\n \\"FileSystemType\\": \\"extreme\\",\\n \\"SnapshotType\\": \\"user\\",\\n \\"CompletedTime\\": \\"2014-07-24T13:10:52Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSnapshotsResponse>\\n <TotalCount>36</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <PageNumber>1</PageNumber>\\n <Snapshots>\\n <Snapshot>\\n <Status>accomplished</Status>\\n <Progress>100</Progress>\\n <Description>FinanceDept</Description>\\n <SourceFileSystemVersion>1</SourceFileSystemVersion>\\n <CreateTime>2014-07-24T13:00:52Z</CreateTime>\\n <SourceFileSystemId>extreme-012****</SourceFileSystemId>\\n <RetentionDays>30</RetentionDays>\\n <SnapshotName>FinanceJoshua</SnapshotName>\\n <SnapshotId>s-extreme-snapsho****</SnapshotId>\\n <SourceFileSystemSize>2000</SourceFileSystemSize>\\n <EncryptType>1</EncryptType>\\n <RemainTime>38</RemainTime>\\n </Snapshot>\\n </Snapshots>\\n</DescribeSnapshotsResponse>","errorExample":""}]', + 'title' => '查询快照列表', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + ."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + ."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAutoSnapshotPolicy' => [ + 'summary' => '创建一条自动快照策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13929', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RepeatWeekdays', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照的重复日期。'."\n" + ."\n" + .'周期：星期'."\n" + ."\n" + .'取值：1~7，依次表示周一至周日。'."\n" + ."\n" + .'如果一星期内需要创建多次自动快照时，可设置多个时间点，多个时间点用半角逗号（,）隔开，最多设置7个时间点。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'TimePoints', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照的创建时间点。'."\n" + ."\n" + .'单位：小时'."\n" + ."\n" + .'取值：0~23，代表00:00至23:00共24个时间点，例如：1表示01:00。'."\n" + ."\n" + .'当一天内需要创建多次自动快照时，可以设置多个时间点，多个时间点用半角逗号（,）隔开，最多支持设置24个时间点。', + 'type' => 'string', + 'required' => true, + 'example' => '0,1,…,23', + ], + ], + [ + 'name' => 'RetentionDays', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照的保留时间。'."\n" + ."\n" + .'单位：天'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- -1（默认值）：永久保存，当快照数量达到额度上限后被自动删除。'."\n" + .'- 1~65536：指定保存天数，保留时间到期后快照会被自动释放。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '65536', + 'minimum' => '-1', + 'example' => '30', + 'default' => '-1', + ], + ], + [ + 'name' => 'AutoSnapshotPolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照策略的名称。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头。'."\n" + .'- 可包含数字、半角冒号（:）、下划线（_）或短划线（-），不能以`http://`和`https://`开头。'."\n" + .'- 默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：extreme（极速型NAS）', + 'type' => 'string', + 'required' => true, + 'example' => 'extreme', + 'enum' => [ + 'extreme', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'AutoSnapshotPolicyId' => [ + 'description' => '自动快照策略ID。', + 'type' => 'string', + 'example' => 'sp-extreme-233e6****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"AutoSnapshotPolicyId\\": \\"sp-extreme-233e6****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n<AutoSnapshotPolicyId>sp-extreme-233e6****</AutoSnapshotPolicyId>","errorExample":""}]', + 'title' => '创建一条自动快照策略', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + .'- 一个阿里云账号在一个地域最多能创建100条自动快照策略。'."\n" + .'- 如果文件系统数据较多，单次创建自动快照的时长超过两个时间点间隔，则自动跳过下一时间点。例如：您设置了09:00、10:00、11:00 和12:00为自动快照时间点。由于文件系统数据较多，09:00开始创建快照，10:20完成创建快照，实际耗时80分钟。系统会跳过10:00时间点，待11:00继续为您创建自动快照。'."\n" + .'- 每个文件系统最多支持创建自动快照128个，达到快照额度上限后，系统会自动删除最早创建的自动快照，手动快照不受影响。'."\n" + .'- 修改自动快照策略的保留时间时，仅对新增快照生效，存量快照沿用历史保留时间。'."\n" + .'- 正在对某一个文件系统执行自动快照时，您需要等待自动快照完成后，才能手动创建快照。'."\n" + .'- 非正常状态的文件系统无法执行自动快照策略。'."\n" + .'- 创建的自动快照具有统一命名格式：`auto_yyyyMMdd_X`。其中，`auto`：表示自动快照，与手动快照区分；`yyyyMMdd`：表示创建快照的日期，`y` 表示年、`M` 表示月、`d `表示天；`X`：当日创建的第几份自动快照。例如：`auto_20201018_1`表示2020年10月18日创建的第一份自动快照。'."\n" + .'- 已创建的自动快照策略可以应用于任一文件系统ApplyAutoSnapshotPolicy，且支持修改策略内容ModifyAutoSnapshotPolicy。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + .'- 一个阿里云账号在一个地域最多能创建100条自动快照策略。'."\n" + .'- 如果文件系统数据较多，单次创建自动快照的时长超过两个时间点间隔，则自动跳过下一时间点。例如：您设置了09:00、10:00、11:00 和12:00为自动快照时间点。由于文件系统数据较多，09:00开始创建快照，10:20完成创建快照，实际耗时80分钟。系统会跳过10:00时间点，待11:00继续为您创建自动快照。'."\n" + .'- 每个文件系统最多支持创建自动快照128个，达到快照额度上限后，系统会自动删除最早创建的自动快照，手动快照不受影响。'."\n" + .'- 修改自动快照策略的保留时间时，仅对新增快照生效，存量快照沿用历史保留时间。'."\n" + .'- 正在对某一个文件系统执行自动快照时，您需要等待自动快照完成后，才能手动创建快照。'."\n" + .'- 非正常状态的文件系统无法执行自动快照策略。'."\n" + .'- 创建的自动快照具有统一命名格式：`auto_yyyyMMdd_X`。其中，`auto`：表示自动快照，与手动快照区分；`yyyyMMdd`：表示创建快照的日期，`y` 表示年、`M` 表示月、`d `表示天；`X`：当日创建的第几份自动快照。例如：`auto_20201018_1`表示2020年10月18日创建的第一份自动快照。'."\n" + .'- 已创建的自动快照策略可以应用于任一文件系统ApplyAutoSnapshotPolicy，且支持修改策略内容ModifyAutoSnapshotPolicy。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAutoSnapshotPolicy' => [ + 'summary' => '删除一条自动快照策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13938', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AutoSnapshotPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照策略ID。'."\n" + ."\n" + .'您可以调用[DescribeAutoSnapshotPolicies](~~126583~~)查看您可用的自动快照策略。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sp-extreme-233e6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n" + .'无论调用接口成功与否，都会返回请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>","errorExample":""}]', + 'title' => '删除自动快照策略', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'- 如果目标自动快照策略已经被应用到文件系统上，删除自动快照策略后，相应文件系统不再执行该策略。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'- 如果目标自动快照策略已经被应用到文件系统上，删除自动快照策略后，相应文件系统不再执行该策略。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAutoSnapshotPolicy' => [ + 'summary' => '修改一条自动快照策略。修改自动快照策略后，之前已应用该策略的文件系统随即执行修改后的自动快照策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13975', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AutoSnapshotPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标自动快照策略ID。'."\n" + ."\n" + .'您可以调用DescribeAutoSnapshotPolicies查看您可用的自动快照策略。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sp-extreme-233e6****', + ], + ], + [ + 'name' => 'AutoSnapshotPolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照策略的名称。如果该参数为空则代表不修改策略名称。'."\n" + ."\n" + .'限制：'."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小字母或中文开头。'."\n" + .'- 可包含数字、半角冒号（:）、下划线（_）或短划线（-），不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + [ + 'name' => 'RepeatWeekdays', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照的重复日期。'."\n" + ."\n" + .'周期：星期。'."\n" + ."\n\n" + .'取值：1~7，例如：1表示周一。当一星期内需要创建多次自动快照时，可以传入多个时间点，多个时间点用半角逗号（,）隔开，最多支持传入7个时间点。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,7', + ], + ], + [ + 'name' => 'RetentionDays', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照的保留时间。'."\n" + ."\n" + .'单位：天'."\n" + ."\n" + .'取值：'."\n" + .'- -1（默认）：永久保存。'."\n" + .'- 1~65536：指定保存天数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '65536', + 'minimum' => '-1', + 'example' => '30', + 'default' => '-1', + ], + ], + [ + 'name' => 'TimePoints', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照的创建时间点。'."\n" + ."\n" + .'单位：小时。'."\n" + ."\n\n" + .'取值：0~23，代表00:00至23:00共24个时间点，例如：1表示01:00。当一天内需要创建多次自动快照时，可以传入多个时间点，多个时间点半角逗号（,）隔开，最多支持传入24个时间点。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0,1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n" + .'无论调用接口成功与否，都会返回请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAutoSnapshotPolicyResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyAutoSnapshotPolicyResponse>","errorExample":""}]', + 'title' => '修改自动快照策略', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ApplyAutoSnapshotPolicy' => [ + 'summary' => '为一个或者多个文件系统应用自动快照策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13918', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AutoSnapshotPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标自动快照策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sp-extreme-233e6****', + ], + ], + [ + 'name' => 'FileSystemIds', + 'in' => 'query', + 'schema' => [ + 'description' => '目标极速型NAS高级型文件系统ID。'."\n" + ."\n" + .'一次调用最多指定100个文件系统ID，当您需要将自动快照策略应用于多个文件系统时，文件系统ID之间用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'extreme-233e6****,extreme -23vbp****,extreme -23vas****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>","errorExample":""}]', + 'title' => '为文件系统应用自动快照策略', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + .'- 一个文件系统只能应用一条自动快照策略。'."\n" + .'- 一条自动快照策略能应用到多个文件系统。'."\n" + .'- 目标文件系统已经应用了自动快照策略时，调用ApplyAutoSnapshotPolicy接口可以更换文件系统当前应用的自动快照策略。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + .'- 一个文件系统只能应用一条自动快照策略。'."\n" + .'- 一条自动快照策略能应用到多个文件系统。'."\n" + .'- 目标文件系统已经应用了自动快照策略时，调用ApplyAutoSnapshotPolicy接口可以更换文件系统当前应用的自动快照策略。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelAutoSnapshotPolicy' => [ + 'summary' => '取消一个或者多个文件系统的自动快照策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13920', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemIds', + 'in' => 'query', + 'schema' => [ + 'description' => '目标文件系统ID。'."\n" + ."\n" + .'一次调用最多指定100个文件系统，当您需要取消多个文件系统的自动快照策略时，多个文件系统ID之间用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'extreme-233e6****,extreme-23vbp****,extreme-23vas****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n" + .'无论调用接口成功与否，都会返回请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DED****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DED****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DED****</RequestId>","errorExample":""}]', + 'title' => '取消一个或者多个文件系统的自动快照策略', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + ."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + ."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAutoSnapshotPolicies' => [ + 'summary' => '查询已创建的自动快照策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13947', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AutoSnapshotPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-extreme-233e6****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每个分页包含的自动快照策略的个数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照策略列表的页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：extreme（极速型NAS）', + 'type' => 'string', + 'required' => false, + 'example' => 'extreme', + 'enum' => [ + 'extreme', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '自动快照策略的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'PageSize' => [ + 'description' => '分页展示返回的自动快照策略时的每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '自动快照策略列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AutoSnapshotPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoSnapshotPolicy' => [ + 'description' => '自动快照策略详情集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoints' => [ + 'description' => '自动快照的创建时间点。'."\n" + ."\n" + .'单位：小时'."\n" + ."\n" + .'包括：`0~23`，表示从`00:00~23:00`共24个时间点。1代表在01:00时间点。最多24个时间点，用半角逗号（,）隔开。', + 'type' => 'string', + 'example' => '4,19', + ], + 'Status' => [ + 'description' => '自动快照策略状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Creating：创建中'."\n" + .'- Available：正常可用', + 'type' => 'string', + 'example' => 'Available', + ], + 'RepeatWeekdays' => [ + 'description' => '自动快照的重复日期。'."\n" + ."\n" + .'重复周期：星期'."\n" + ."\n" + .'取值范围：1~7，例如：1表示周一。', + 'type' => 'string', + 'example' => '1,5', + ], + 'AutoSnapshotPolicyName' => [ + 'description' => '自动快照策略的名称。', + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + 'CreateTime' => [ + 'description' => '创建时间。'."\n" + ."\n" + .'按照[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)标准表示，并使用UTC时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。'."\n", + 'type' => 'string', + 'example' => '2014-04-21T12:08:52Z', + ], + 'AutoSnapshotPolicyId' => [ + 'description' => '自动快照策略ID。', + 'type' => 'string', + 'example' => 'sp-extreme-233e6****', + ], + 'RetentionDays' => [ + 'description' => '自动快照的保留时间。'."\n" + ."\n" + .'单位：天'."\n" + ."\n" + .'包括：'."\n" + .'- -1：永久保存，当快照数量达到额度上限后被自动删除。'."\n" + .'- 1~65536：指定保存天数，保留时间到期后快照会被自动释放。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'FileSystemNums' => [ + 'description' => '启用该策略的文件系统数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RegionId' => [ + 'description' => '自动快照策略所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型。', + 'type' => 'string', + 'example' => 'extreme', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AutoSnapshotPolicies\\": {\\n \\"AutoSnapshotPolicy\\": [\\n {\\n \\"TimePoints\\": \\"4,19\\",\\n \\"Status\\": \\"Available\\",\\n \\"RepeatWeekdays\\": \\"1,5\\",\\n \\"AutoSnapshotPolicyName\\": \\"FinanceJoshua\\",\\n \\"CreateTime\\": \\"2014-04-21T12:08:52Z\\",\\n \\"AutoSnapshotPolicyId\\": \\"sp-extreme-233e6****\\",\\n \\"RetentionDays\\": 30,\\n \\"FileSystemNums\\": 2,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSystemType\\": \\"extreme\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAutoSnapshotPoliciesResponse>\\n <TotalCount>2</TotalCount>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <AutoSnapshotPolicies>\\n <TimePoints>4,19</TimePoints>\\n <Status>Available</Status>\\n <RepeatWeekdays>1,5</RepeatWeekdays>\\n <AutoSnapshotPolicyName>FinanceJoshua</AutoSnapshotPolicyName>\\n <CreateTime>2014-04-21T12:08:52Z</CreateTime>\\n <AutoSnapshotPolicyId>sp-extreme-233e6****</AutoSnapshotPolicyId>\\n <RetentionDays>30</RetentionDays>\\n <FileSystemNums>2</FileSystemNums>\\n <RegionId>cn-hangzhou</RegionId>\\n </AutoSnapshotPolicies>\\n</DescribeAutoSnapshotPoliciesResponse>","errorExample":""}]', + 'title' => '查询已创建的自动快照策略', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAutoSnapshotTasks' => [ + 'summary' => '查询自动快照的任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13948', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemIds', + 'in' => 'query', + 'schema' => [ + 'description' => '目标文件系统ID。'."\n" + ."\n" + .'一次调用最多指定100个文件系统ID，当您需要查询多个文件系统的快照时，多个文件系统ID之间用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'extreme-233e6****,extreme -23vbp****,extreme -23vas****', + ], + ], + [ + 'name' => 'AutoSnapshotPolicyIds', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照策略ID。'."\n" + ."\n" + .'最多指定100个自动快照策略ID，当您需要查询多个自动快照策略的任务时，多个自动快照策略ID之间用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-extreme-233e6****,sp-extreme-233e6****, sp-extreme-233e6****', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：extreme（极速型NAS）', + 'type' => 'string', + 'required' => true, + 'example' => 'extreme', + 'enum' => [ + 'extreme', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '自动快照任务列表的页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '每个分页包含的快照任务数量。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '自动快照任务的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'PageSize' => [ + 'description' => '分页查询时设置的每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '自动快照任务列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AutoSnapshotTasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoSnapshotTask' => [ + 'description' => '自动快照任务信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceFileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => 'extreme-233e6****', + ], + 'AutoSnapshotPolicyId' => [ + 'description' => '自动快照策略的ID。', + 'type' => 'string', + 'example' => 'sp-extreme-233e6****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AutoSnapshotTasks\\": {\\n \\"AutoSnapshotTask\\": [\\n {\\n \\"SourceFileSystemId\\": \\"extreme-233e6****\\",\\n \\"AutoSnapshotPolicyId\\": \\"sp-extreme-233e6****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAutoSnapshotTasksResponse>\\n <TotalCount>9</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <PageNumber>1</PageNumber>\\n <AutoSnapshotTasks>\\n <AutoSnapshotTask>\\n <SourceFileSystemId>extreme-233e6****</SourceFileSystemId>\\n <AutoSnapshotPolicyId>sp-extreme-233e6****</AutoSnapshotPolicyId>\\n </AutoSnapshotTask>\\n </AutoSnapshotTasks>\\n</DescribeAutoSnapshotTasksResponse>","errorExample":""}]', + 'title' => '查询自动快照的任务列表', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResetFileSystem' => [ + 'summary' => '使文件系统回滚至某一历史快照的文件系统状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13984', + 'abilityTreeNodes' => [ + 'FEATUREnas5QOAQE', + 'FEATUREnas6KFX9N', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定的极速型NAS高级型文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'extreme-012dd****', + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要恢复到指定文件系统某一阶段的历史快照ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's-extreme-snapsho****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>","errorExample":""}]', + 'title' => '使文件系统回滚至某一阶段', + 'description' => '<props="china">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud201803061139_99860.html?spm=a2c4g.11186623.0.0.5c895ff2YPLrwe)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + .'- 文件系统的状态必须为正常的状态。'."\n" + .'- 指定的参数SnapshotId必须是由同文件系统FileSystemId创建的历史快照。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 该功能免费公测中，公测期间不保障[文件存储NAS服务等级协议（SLA）](https://www.alibabacloud.com/help/legal/latest/network-attached-storage-service-level-agreement)。'."\n" + .'- 仅极速型NAS高级型支持该功能。'."\n" + .'- 文件系统的状态必须为正常的状态。'."\n" + .'- 指定的参数SnapshotId必须是由同文件系统FileSystemId创建的历史快照。'."\n" + ."\n" + .'</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => '为指定资源创建并绑定标签。支持文件系统和接入点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13986', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + .'取值：'."\n" + .'- filesystem，表示文件系统。'."\n" + .'- accesspoint，表示为接入点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'filesystem', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。取值范围：1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + .'- 通用型NAS：31a8e4****。'."\n" + .'- 极速型NAS：必须以extreme-开头，例如extreme-0015****。'."\n" + .'- CPFS：必须以cpfs-开头，例如cpfs-125487****。'."\n" + .'- 接入点：通用型NAS下创建的接入点，接入点归属于入参的文件系统ID，例如‘31a8e4****/ap-896m22****’。', + 'type' => 'string', + 'required' => false, + 'example' => '31a8e4****', + ], + 'required' => true, + 'example' => '03e08484f0', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签数组。数组长度：1~20。如果数组中有多个标签对象，标签键Key不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 不允许为空和空字符串。 '."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`aliyun`或`acs:`开头。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => true, + 'example' => 'nastest', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => true, + 'example' => 'filetest', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'Duplicate.ResourceId', + 'errorMessage' => 'The request contains duplicated ResourceId.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The ResourceId does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The specified Tag.n.Key is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The specified Tag.n.Value is invalid.', + ], + [ + 'errorCode' => 'CustomTag.NumberExceed', + 'errorMessage' => 'The maximum number of system tags for each resource is 20.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.KeyValueNotNull', + 'errorMessage' => 'The key value cannot be null.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResorucesResponse>\\r\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\r\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => '为资源创建并绑定标签', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => '删除指定资源标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13987', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'取值：'."\n" + .'- filesystem，表示为文件系统。'."\n" + .'- accesspoint，表示为接入点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'filesystem', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑目标文件系统的所有标签。'."\n" + ."\n" + .'当TagKey.N为空时，该参数有效。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：解绑目标文件系统的所有标签。没有标签的文件系统则不处理，直接返回成功。'."\n" + .'- false（默认值）：不执行该接口，直接返回成功。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。'."\n" + ."\n" + .'目标资源ID，N的取值范围：1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + .'- 通用型NAS：31a8e4****。'."\n" + .'- 极速型NAS：必须以extreme-开头，例如extreme-0015****。'."\n" + .'- CPFS：必须以cpfs-开头，例如cpfs-125487****。'."\n" + .'- 接入点：通用型NAS下创建的接入点，接入点归属于入参的文件系统ID，例如‘31a8e4****/ap-896m22****’。', + 'type' => 'string', + 'required' => false, + 'example' => '31a8e4****', + ], + 'required' => true, + 'example' => '03e08484f0', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源的标签键列表。可输入最多 20 个标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '目标文件系统的标签键。'."\n" + .'限制：'."\n" + ."\n" + .'- 不允许为空和空字符串。 '."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`aliyun`或`acs:`开头。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => false, + 'example' => 'nastest', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', + ], + [ + 'errorCode' => 'Duplicate.ResourceId', + 'errorMessage' => 'The request contains duplicated ResourceId.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The specified Tag.n.Key is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The specified Tag.n.Value is invalid.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\r\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\r\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => '解绑并删除标签', + ], + 'ListTagResources' => [ + 'summary' => '查询标签列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13971', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + .'- filesystem，表示文件系统。'."\n" + .'- accesspoint，表示接入点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'filesystem', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。'."\n" + ."\n" + .'目标资源ID，N的取值范围：1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + .'- 通用型NAS：31a8e4****。'."\n" + .'- 极速型NAS：必须以extreme-开头，例如extreme-0015****。'."\n" + .'- CPFS：必须以cpfs-开头，例如cpfs-125487****。'."\n" + .'- 接入点：通用型NAS下创建的接入点，接入点归属于入参的文件系统ID，例如‘31a8e4****/ap-896m22****’。', + 'type' => 'string', + 'required' => false, + 'example' => '03e08484f0', + ], + 'required' => false, + 'example' => '03e08484f0', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签数组。数组长度：1~20。如果数组中有多个标签对象，标签键Key不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 不允许为空和空字符串。 '."\n" + .'- 最多支持128个字符。'."\n" + .'- 不能以`aliyun`或`acs:`开头。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'nastest', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'限制：'."\n" + ."\n\n" + .'- 最多支持128个字符。'."\n" + .'- 不能包含`http://`和`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'filetest', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。NextToken为空说明为最后一个。', + 'type' => 'string', + 'example' => ' 无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '资源列表信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'filesystem', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i-2zebd226fxed6h4iadhe', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceIdOrTag', + 'errorMessage' => 'Either ResourceId or Tag must be specified.', + ], + [ + 'errorCode' => 'InvalidNextToken', + 'errorMessage' => 'The NextToken is invalid.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'Duplicate.ResourceId', + 'errorMessage' => 'The request contains duplicated ResourceId.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The ResourceId does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The specified Tag.n.Key is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The specified Tag.n.Value is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\" 无\\",\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"filesystem\\",\\n \\"TagValue\\": \\"test\\",\\n \\"ResourceId\\": \\"i-2zebd226fxed6h4iadhe\\",\\n \\"TagKey\\": \\"test1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken> 无</NextToken>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n <TagResources>\\n <ResourceType>filesystem</ResourceType>\\n <TagValue>test</TagValue>\\n <ResourceId>i-2zebd226fxed6h4iadhe</ResourceId>\\n <TagKey>test1</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => '查询标签的资源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetDirQuota' => [ + 'summary' => '设置文件系统的目录配额。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13985', + 'abilityTreeNodes' => [ + 'FEATUREnasXEQXVN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '目录在文件系统中的绝对路径。'."\n" + .' > - 仅支持为NAS文件系统中已创建的目录设置配额。配额的目录路径就是目录在NAS文件系统的绝对路径，而不是计算节点（例如，ECS，容器）上的本地路径。'."\n" + .' > - 不支持路径名中包含中文字符的目录。', + 'type' => 'string', + 'required' => true, + 'example' => '/data/sub1', + ], + ], + [ + 'name' => 'QuotaType', + 'in' => 'query', + 'schema' => [ + 'description' => '配额类型。'."\n" + ."\n" + .'取值：'."\n" + .'- Accounting：统计型配额，只统计使用量。'."\n" + .'- Enforcement：限制型配额，当使用量超过限制后，会导致创建文件或目录、追加写入等操作失败。', + 'type' => 'string', + 'required' => true, + 'example' => 'Accounting', + 'enum' => [ + 'Accounting', + 'Enforcement', + ], + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '用户类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- Uid：用户ID'."\n" + .'- Gid：用户所属组ID'."\n" + .'- AllUsers：所有用户', + 'type' => 'string', + 'required' => true, + 'example' => 'Uid', + 'enum' => [ + 'Uid', + 'Gid', + 'AllUsers', + ], + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '要限制的Uid或Gid。'."\n" + ."\n" + .'当UserType=Uid或Gid时必填且有意义。'."\n" + ."\n" + .'例如：'."\n" + ."\n" + .'- 要限制Uid=500的用户，则UserType填Uid，UserId填500。'."\n" + .'- 要限制Gid=100的用户组，则UserType填Gid，UserId填100。', + 'type' => 'string', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'SizeLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '限制目录下文件总容量。'."\n" + ."\n" + .'单位：GiB'."\n" + ."\n\n" + .'当QuotaType=Enforcement时，SizeLimit和FileCountLimit至少填写其中一项。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '10000000', + 'minimum' => '0', + 'example' => '1024', + ], + ], + [ + 'name' => 'FileCountLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '限制目录下文件数目。'."\n" + ."\n" + .'包括文件、目录和特殊文件。'."\n" + ."\n\n" + .'当QuotaType=Enforcement时，SizeLimit和FileCountLimit至少填写其中一项。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1000000000', + 'minimum' => '0', + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5BC5CB97-9F28-42FE-84A4-0CD0DF42****', + ], + 'Success' => [ + 'description' => '请求状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：请求成功'."\n" + .'- false：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidParameter.DirPathNotExist', + 'errorMessage' => 'The Dir Path does not exist', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BC5CB97-9F28-42FE-84A4-0CD0DF42****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>94CA5264-2C30-4D83-865D-B1CF2BE2****</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '设置文件系统的目录配额', + 'description' => '仅通用型NAS 文件系统支持目录配额功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelDirQuota' => [ + 'summary' => '取消文件系统的目录配额。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13921', + 'abilityTreeNodes' => [ + 'FEATUREnasM1TG05', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '目录在文件系统中的绝对路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/data/sub1', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '用户类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- Uid：用户ID'."\n" + .'- Gid：用户所属组ID'."\n" + .'- AllUsers：所有用户', + 'type' => 'string', + 'required' => true, + 'example' => 'Uid', + 'enum' => [ + 'Uid', + 'Gid', + 'AllUsers', + ], + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '要取消的Uid或Gid。'."\n" + ."\n" + .'当UserType=Uid或Gid时必填且有意义。'."\n" + ."\n" + .'例如：'."\n" + ."\n" + .'- 要取消Uid=500的用户，则UserType填Uid，UserId填500。'."\n" + .'- 要取消Gid=100的用户组，则UserType填Gid，UserId填100。', + 'type' => 'string', + 'required' => false, + 'example' => '500', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5BC5CB97-9F28-42FE-84A4-0CD0DF42****', + ], + 'Success' => [ + 'description' => '请求状态。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：请求成功'."\n" + .'- false：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BC5CB97-9F28-42FE-84A4-0CD0DF42****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>5BC5CB97-9F28-42FE-84A4-0CD0DF42****</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '取消文件系统的目录配额', + 'description' => '仅通用型NAS NFS文件系统支持目录配额功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDirQuotas' => [ + 'summary' => '获取文件系统每个目录配额的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13950', + 'abilityTreeNodes' => [ + 'FEATUREnasXEQXVN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '目录在文件系统中的绝对路径。'."\n" + ."\n" + .'此项为空时会返回文件系统中全部已设置了配额的目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/data/sub1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每个分页包含的目录个数。默认值为10。'."\n" + ."\n" + .'取值范围：1~100。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。'."\n" + ."\n" + .'起始值（默认值）：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '目录总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DirQuotaInfos' => [ + 'description' => '每个目录的配额信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '目录的统计状态。'."\n" + .'初始化时为Initializing；正常时为Normal。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Path' => [ + 'description' => '目录在文件系统中的绝对路径。', + 'type' => 'string', + 'example' => '/data/sub1', + ], + 'DirInode' => [ + 'description' => '目录的inode号。', + 'type' => 'string', + 'example' => '1123', + ], + 'UserQuotaInfos' => [ + 'description' => '每个用户的配额信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileCountReal' => [ + 'description' => '目录下用户的实际文件数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5100', + ], + 'UserType' => [ + 'description' => '指定UserId的类型，包括Uid、Gid、AllUsers三种。'."\n" + .'- 当返回为Uid或Gid时，UserId会存在返回值。'."\n" + .'- 当返回为AllUsers时，UserId返回为空。', + 'type' => 'string', + 'example' => 'Uid', + ], + 'FileCountLimit' => [ + 'description' => '目录下用户的文件数目限制。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'UserId' => [ + 'description' => '要限制的Uid或Gid，取决于UserType的值。', + 'type' => 'string', + 'example' => '500', + ], + 'SizeLimit' => [ + 'description' => '目录下用户的文件总容量限制，单位为GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'QuotaType' => [ + 'description' => '配额类型，包括统计型（Accounting）和限制型（Enforcement）。', + 'type' => 'string', + 'example' => 'Accounting', + ], + 'SizeReal' => [ + 'description' => '目录下用户的实际文件总容量，单位为GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '800', + ], + 'SizeRealInByte' => [ + 'description' => '目录下用户的实际文件总容量，单位为 Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '858995833870', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5BC5CB97-9F28-42FE-84A4-0CD0DF42****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的目录个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"DirQuotaInfos\\": [\\n {\\n \\"Status\\": \\"Normal\\",\\n \\"Path\\": \\"/data/sub1\\",\\n \\"DirInode\\": \\"1123\\",\\n \\"UserQuotaInfos\\": [\\n {\\n \\"FileCountReal\\": 5100,\\n \\"UserType\\": \\"Uid\\",\\n \\"FileCountLimit\\": 10000,\\n \\"UserId\\": \\"500\\",\\n \\"SizeLimit\\": 1024,\\n \\"QuotaType\\": \\"Accounting\\",\\n \\"SizeReal\\": 800,\\n \\"SizeRealInByte\\": 858995833870\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"5BC5CB97-9F28-42FE-84A4-0CD0DF42****\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeDirQuotasResponse>\\n <TotalCount>1</TotalCount>\\n <DirQuotaInfos>\\n <Status>Normal</Status>\\n <Path>/data/sub1</Path>\\n <DirInode>1123</DirInode>\\n <UserQuotaInfos>\\n <FileCountReal>5100</FileCountReal>\\n <UserType>Uid</UserType>\\n <FileCountLimit>10000</FileCountLimit>\\n <UserId>500</UserId>\\n <SizeLimit>1024</SizeLimit>\\n <QuotaType>Accounting</QuotaType>\\n <SizeReal>800</SizeReal>\\n </UserQuotaInfos>\\n </DirQuotaInfos>\\n <RequestId>5BC5CB97-9F28-42FE-84A4-0CD0DF42****</RequestId>\\n <PageSize>1</PageSize>\\n <PageNumber>1</PageNumber>\\n</DescribeDirQuotasResponse>","errorExample":""}]', + 'title' => '查询文件系统的目录配额', + 'description' => '仅通用型NAS NFS文件系统支持目录配额功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateLifecyclePolicy' => [ + 'summary' => '创建一个生命周期管理策略。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13932', + 'abilityTreeNodes' => [ + 'FEATUREnasZ6WBFV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'LifecyclePolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期管理策略名称。 长度为 3~64 个字符，必须以大写字母或小写字母开头，可以包含英文字母、数字、下划线（_）或者短划线（-）。'."\n" + ."\n" + .'>通用型 NAS 必须传入，CPFS 智算版无需填入。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'lifecyclepolicy_01', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期管理策略关联目录的绝对路径。仅支持通用型NAS。'."\n" + ."\n" + .'- 通用型NAS仅支持关联单个目录。必须以正斜线（/）开头，并且是挂载点中真实存在的路径。'."\n" + ."\n" + .'> 仅支持通用型NAS。通用型NAS建议您配置Paths.N，可以同时关联多个目录。'."\n" + .'>- Path和Paths 有且只能存在一个入参。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '/pathway/to/folder', + ], + ], + [ + 'name' => 'LifecycleRuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期管理策略关联的管理规则。仅通用型 NAS 支持。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- DEFAULT_ATIME_14：距今14天未访问的文件。'."\n" + .'- DEFAULT_ATIME_30：距今30天未访问的文件。'."\n" + .'- DEFAULT_ATIME_60：距今60天未访问的文件 。'."\n" + .'- DEFAULT_ATIME_90：距今90天未访问的文件。'."\n" + .'- DEFAULT_ATIME_180：距今180天未访问的文件。仅当StorageType=Archive时，支持DEFAULT_ATIME_180。'."\n" + .'>- 如果该目录已经设置了低频策略，再次设置归档策略的时候，归档策略的时间要比低频策略设置的长。'."\n" + .'> - 仅通用型NAS支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_ATIME_14', + 'enum' => [ + 'DEFAULT_ATIME_14', + 'DEFAULT_ATIME_30', + 'DEFAULT_ATIME_60', + 'DEFAULT_ATIME_90', + 'DEFAULT_ATIME_180', + ], + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。'."\n" + ."\n" + .'>通用型 NAS支持 InfrequentAccess和Archive； CPFS 智算版仅支持 InfrequentAccess。', + 'type' => 'string', + 'required' => true, + 'example' => 'InfrequentAccess', + 'enum' => [ + 'InfrequentAccess', + 'Archive', + 'Capacity', + 'Performance', + ], + ], + ], + [ + 'name' => 'Paths', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '生命周期管理策略关联目录的绝对路径。', + 'type' => 'array', + 'items' => [ + 'description' => '生命周期管理策略关联目录的绝对路径。'."\n" + ."\n" + .'支持关联多个目录。必须以正斜线（/）开头，并且是挂载点中真实存在的路径，N的取值范围为1~10。'."\n" + .'>- Path和Paths 有且只能存在一个入参。', + 'type' => 'string', + 'required' => false, + 'example' => '“/path1"', + ], + 'required' => false, + 'example' => '"/path1", "/path2"', + 'maxItems' => 11, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '生命周期策略描述', + 'description' => '生命周期策略描述。'."\n" + ."\n" + .'格式：'."\n" + .'长度为3-64个字符，必须以字母开头，可以包含英文字母、数字、下划线（_）或者短划线（-）。'."\n" + .'>仅 CPFS 智算版支持。', + 'type' => 'string', + 'required' => false, + 'example' => '描述', + ], + ], + [ + 'name' => 'LifecyclePolicyType', + 'in' => 'query', + 'schema' => [ + 'title' => '策略类型', + 'description' => '策略类型'."\n" + .'- Auto（默认）：自动执行。'."\n" + .'- OnDemand：按需执行。', + 'type' => 'string', + 'required' => false, + 'example' => 'Auto', + 'default' => 'Auto', + 'enum' => [ + 'Auto', + 'OnDemand', + ], + ], + ], + [ + 'name' => 'TransitRules', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'title' => '文件数据转储规则', + 'description' => '文件数据转储规则，最多配置 1 个。'."\n" + ."\n" + .'>仅 CPFS 智算版文件系统的 LifecyclePolicyType=Auto 时支持', + 'type' => 'array', + 'items' => [ + 'title' => '文件数据转储规则', + 'description' => '文件数据转储规则，最多配置 1 个。'."\n" + .'>仅 CPFS 智算版文件系统的 LifecyclePolicyType=Auto 时支持', + 'type' => 'object', + 'properties' => [ + 'Attribute' => [ + 'title' => '规则的属性', + 'description' => '规则的属性。'."\n" + ."\n" + .'取值：'."\n" + .'- Atime: 文件的访问时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'Atime', + 'enum' => [ + 'Atime', + ], + ], + 'Threshold' => [ + 'title' => '规则的阈值', + 'description' => '规则的阈值。'."\n" + ."\n" + .'取值：'."\n" + .'- 当 Attribute 为 Atime 时，表示多少天未访问的文件，取值范围[1,365]', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'RetrieveRules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '文件数据取回规则', + 'description' => '文件数据取回规则，最多配置 1 个。'."\n" + .'>仅 CPFS 智算版文件系统支持。', + 'type' => 'array', + 'items' => [ + 'title' => '文件数据取回规则', + 'description' => '文件数据取回规则，最多配置 1 个。', + 'type' => 'object', + 'properties' => [ + 'Attribute' => [ + 'title' => '规则的属性', + 'description' => '规则的属性，取值：'."\n" + .'- RetrieveType: 取回方式', + 'type' => 'string', + 'required' => false, + 'example' => 'RetrieveType', + 'enum' => [ + 'RetrieveType', + ], + ], + 'Threshold' => [ + 'title' => '规则的阈值', + 'description' => '规则的阈值，取值：'."\n" + .'- RetrieveType'."\n" + .' - AfterVisit： LifecyclePolicyType=Auto 支持，代表尽力 recall on visit'."\n" + .' - All: LifecyclePolicyType=OnDemand 支持，代表取回所有', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + 'enum' => [ + 'AfterVisit', + 'All', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'Success' => [ + 'description' => '请求状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LifecyclePolicyId' => [ + 'title' => '生命周期策略的 ID', + 'description' => '生命周期策略的 ID', + 'type' => 'string', + 'example' => 'lsp-bp1234567890ab****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.FileSystemNotSupportedForLifecycle', + 'errorMessage' => 'The file system does not support lifecycle.', + ], + [ + 'errorCode' => 'OperationDenied.EncryptedFileSystemNotSupportedForLifecycle', + 'errorMessage' => 'The encrypted file system does not support lifecycle.', + ], + [ + 'errorCode' => 'OperationDenied.LifecyclePolicyCountLimitExceeded', + 'errorMessage' => 'The maximum number of LifecyclePolicies is exceeded.', + ], + [ + 'errorCode' => 'InvalidLifecyclePolicy.AlreadyExist', + 'errorMessage' => 'The specified LifecyclePolicy already exists.', + ], + [ + 'errorCode' => 'InvalidParameter.PathsNumberExceed', + 'errorMessage' => 'The maximum number of Path.N for this operation is 10.', + ], + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'The API operation does not support the file system type.', + ], + [ + 'errorCode' => 'InvalidParameter.PathOrPaths', + 'errorMessage' => 'Either Path or Paths.N must be specified.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'Lifecycle.Count.Exceeded', + 'errorMessage' => 'The lifecycle policy count exceeds the max limit per type per filesystem.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.NotSupportPaths.N', + 'errorMessage' => 'Your request does not meet the gray condition. The Paths.N parameter is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.PathNotExist', + 'errorMessage' => 'The specified path does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"Success\\": true,\\n \\"LifecyclePolicyId\\": \\"lsp-bp1234567890ab****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '创建生命周期管理策略', + 'description' => '- 仅通用型NAS文件系统和CPFS智算版支持创建生命周期管理策略。'."\n" + .'- 每个 CPFS 智算版文件系统最多创建 10 个 Auto 类型 和 100 个 OnDemand 类型的生命周期管理策略。'."\n" + .'- 每个地域可以创建 20 个通用型 NAS 的生命周期管理策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLifecyclePolicy' => [ + 'summary' => '删除一个生命周期管理策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13941', + 'abilityTreeNodes' => [ + 'FEATUREnasZ6WBFV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'LifecyclePolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期管理策略名称。 长度为 3~64 个字符，必须以大写字母或小写字母开头，可以包含英文字母、数字、下划线（_）或者短划线（-）。'."\n" + ."\n" + .'>通用型 NAS 文件系统选填，如果传入则以此为准，没有传入则以 LifecyclePolicyId 为准。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'lifecyclepolicy1', + ], + ], + [ + 'name' => 'LifecyclePolicyId', + 'in' => 'query', + 'schema' => [ + 'title' => '生命周期策略的 ID', + 'description' => '生命周期策略的 ID。'."\n" + .'CPFS 智算版 文件系统必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'lc-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'Success' => [ + 'description' => '请求状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：请求成功'."\n" + .'- false：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '删除生命周期管理策略', + 'description' => '仅通用型NAS文件系统和CPFS智算版支持该功能。', + ], + 'ModifyLifecyclePolicy' => [ + 'summary' => '修改一个生命周期管理策略。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnasZ6WBFV', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'LifecyclePolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期管理策略名称。'."\n" + ."\n" + .'长度为3~64个字符，必须以大写字母或小写字母开头，可以包含英文字母、数字、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'lifecyclepolicy_01', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期管理策略配置的单个目录的绝对路径。'."\n" + ."\n" + .'必须以正斜线（/）开头，并且是挂载点中真实存在的路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/pathway/to/folder', + ], + ], + [ + 'name' => 'LifecycleRuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期管理策略关联的管理规则。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- DEFAULT_ATIME_14：距今14天未访问的文件。'."\n" + .'- DEFAULT_ATIME_30：距今30天未访问的文件。'."\n" + .'- DEFAULT_ATIME_60：距今60天未访问的文件 。'."\n" + .'- DEFAULT_ATIME_90：距今90天未访问的文件。'."\n" + .'- DEFAULT_ATIME_180：距今180天未访问的文件。仅当StorageType=Archive时，支持DEFAULT_ATIME_180。'."\n" + .'> 如果该目录已经设置了低频策略，再次设置归档策略的时候，归档策略的时间要比低频策略设置的长。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_ATIME_14', + 'enum' => [ + 'DEFAULT_ATIME_14', + 'DEFAULT_ATIME_30', + 'DEFAULT_ATIME_60', + 'DEFAULT_ATIME_90', + 'DEFAULT_ATIME_180', + ], + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。', + 'type' => 'string', + 'required' => false, + 'example' => 'InfrequentAccess', + 'default' => 'InfrequentAccess', + 'enum' => [ + 'InfrequentAccess', + 'Archive', + 'Capacity', + 'Performance', + ], + ], + ], + [ + 'name' => 'LifecyclePolicyId', + 'in' => 'query', + 'schema' => [ + 'title' => '生命周期策略的 ID', + 'description' => '生命周期策略的 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'lc-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'Success' => [ + 'description' => '请求状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：请求成功'."\n" + .'- false：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidLifecyclePolicy.NotFound', + 'errorMessage' => 'The specified LifecyclePolicy does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidLifecycleRule.NotFound', + 'errorMessage' => 'The specified LifecycleRule does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyLifecyclePolicyResponse>\\n <RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>\\n <Success>true</Success>\\n</ModifyLifecyclePolicyResponse>","errorExample":""}]', + 'title' => '修改生命周期管理策略', + 'description' => '仅通用型NAS文件系统支持该功能。', + ], + 'GetDirectoryOrFileProperties' => [ + 'summary' => '查询指定目录下是否包含低频存储和归档存储文件，或者查询指定文件是否为低频存储或归档存储文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19614', + 'abilityTreeNodes' => [ + 'FEATUREnasZ6WBFV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '指定目录的绝对路径。'."\n" + ."\n" + .'必须以正斜线（/）开头，并且是挂载点中真实存在的路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/pathway/to/folder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Entry' => [ + 'description' => '目录或文件信息集合。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '返回结果的类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- File：文件'."\n" + .'- Directory：目录', + 'type' => 'string', + 'example' => 'File', + ], + 'HasInfrequentAccessFile' => [ + 'description' => '是否包含低频存储文件。'."\n" + ."\n" + .'仅当Type为Directory时，返回该参数。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：包含'."\n" + .'- false：不包含', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MTime' => [ + 'description' => '文件修改时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'仅当Type为File时，返回该参数。', + 'type' => 'string', + 'example' => '2021-02-11T10:08:08Z', + ], + 'ATime' => [ + 'description' => '查询时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'仅当Type为File时，返回该参数。', + 'type' => 'string', + 'example' => '2021-02-01T10:08:08Z', + ], + 'Size' => [ + 'description' => '文件的大小。'."\n" + ."\n" + .'单位：字节'."\n" + ."\n" + .'仅当Type为File时，返回该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'CTime' => [ + 'description' => '元数据修改时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'仅当Type为File时，返回该值参数。', + 'type' => 'string', + 'example' => '2021-02-11T10:08:10Z', + ], + 'StorageType' => [ + 'description' => '返回文件的数据存储类型。'."\n" + ."\n" + .'仅当Type为File时，返回该参数。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Standard：通用型NAS存储。'."\n" + .'- InfrequentAccess：低频存储。', + 'type' => 'string', + 'example' => 'InfrequentAccess', + ], + 'Name' => [ + 'description' => '文件名或目录名。', + 'type' => 'string', + 'example' => 'file.txt', + ], + 'RetrieveTime' => [ + 'description' => '距现在最近一次数据取回任务执行的时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'仅当Type为File时，返回该参数。', + 'type' => 'string', + 'example' => '2021-02-11T10:08:08Z', + ], + 'Inode' => [ + 'description' => '文件或目录inode。', + 'type' => 'string', + 'example' => '40', + ], + 'HasArchiveFile' => [ + 'description' => '是否包含归档存储文件。'."\n" + ."\n" + .'仅当Type为Directory时，返回该参数。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：包含'."\n" + .'- false：不包含', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OfflineDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'OfflineUnchangedDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.PathNotExist', + 'errorMessage' => 'The specified path does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Entry\\": {\\n \\"Type\\": \\"File\\",\\n \\"HasInfrequentAccessFile\\": true,\\n \\"MTime\\": \\"2021-02-11T10:08:08Z\\",\\n \\"ATime\\": \\"2021-02-01T10:08:08Z\\",\\n \\"Size\\": 1024,\\n \\"CTime\\": \\"2021-02-11T10:08:10Z\\",\\n \\"StorageType\\": \\"InfrequentAccess\\",\\n \\"Name\\": \\"file.txt\\",\\n \\"RetrieveTime\\": \\"2021-02-11T10:08:08Z\\",\\n \\"Inode\\": \\"40\\",\\n \\"HasArchiveFile\\": false,\\n \\"OfflineDuration\\": 0,\\n \\"OfflineUnchangedDuration\\": 0\\n },\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDirectoryOrFilePropertiesResponse>\\n <Entry>\\n <Type>File</Type>\\n <HasInfrequentAccessFile>true</HasInfrequentAccessFile>\\n <MTime>2021-02-11T10:08:08Z</MTime>\\n <ATime>2021-02-01T10:08:08Z</ATime>\\n <Size>1024</Size>\\n <CTime>2021-02-11T10:08:10Z</CTime>\\n <StorageType>InfrequentAccess</StorageType>\\n <Name>file.txt</Name>\\n <RetrieveTime>2021-02-11T10:08:08Z</RetrieveTime>\\n <Inode>Inode</Inode>\\n </Entry>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n</GetDirectoryOrFilePropertiesResponse>","errorExample":""}]', + 'title' => '查询低频/归档的文件信息', + 'description' => '仅通用型NAS文件系统支持该功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLifecyclePolicies' => [ + 'summary' => '获取生命周期管理策略列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13954', + 'abilityTreeNodes' => [ + 'FEATUREnas7AL8PW', + 'FEATUREnasEER7AI', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'LifecyclePolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '生命周期策略名称。命名规则如下：'."\n" + ."\n\n" + .'长度为3-64个字符，必须以大小字母开头，可以包含英文字母、数字、下划线（_）或者短划线（-）。'."\n" + ."\n" + .'>通用型 NAS 文件系统选填，如果传入则以此为准，没有传入则以 LifecyclePolicyId 为准。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'lifecyclepolicy_01', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每个分页包含的生命周期管理策略个数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。'."\n" + .'> 如未指定 StorageType，则返回所有生命周期策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'InfrequentAccess', + 'enum' => [ + 'InfrequentAccess', + 'Archive', + 'Capacity', + 'Performance', + ], + ], + ], + [ + 'name' => 'LifecyclePolicyId', + 'in' => 'query', + 'schema' => [ + 'title' => '生命周期策略的 ID', + 'description' => '生命周期策略的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lc-xxx', + ], + ], + [ + 'name' => 'LifecyclePolicyType', + 'in' => 'query', + 'schema' => [ + 'title' => '策略类型', + 'description' => '策略类型。'."\n" + ."\n" + .'取值：'."\n" + .'- Auto：自动执行'."\n" + .'- OnDemand：按需执行'."\n" + .'>仅CPFS 智算版支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'Auto', + 'enum' => [ + 'Auto', + 'OnDemand', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '策略的描述', + 'description' => '策略的描述。'."\n" + .'>仅CPFS 智算版支持。', + 'type' => 'string', + 'required' => false, + 'example' => '描述', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'title' => '根据路径筛选', + 'description' => '根据路径筛选。'."\n" + .'>仅CPFS 智算版支持。', + 'type' => 'string', + 'required' => false, + 'example' => '/abc/', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '生命周期管理策略总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的生命周期管理策略个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LifecyclePolicies' => [ + 'description' => '生命周期管理策略信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '31a8e4****', + ], + 'LifecycleRuleName' => [ + 'description' => '生命周期管理策略关联的管理规则。'."\n" + ."\n" + .'包括：'."\n" + .'- DEFAULT_ATIME_14：距今14天未访问的文件'."\n" + .'- DEFAULT_ATIME_30：距今30天未访问的文件'."\n" + .'- DEFAULT_ATIME_60：距今60天未访问的文件'."\n" + .'- DEFAULT_ATIME_90：距今90天未访问的文件', + 'type' => 'string', + 'example' => 'DEFAULT_ATIME_14', + ], + 'CreateTime' => [ + 'description' => '生命周期管理策略创建的时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'example' => '2019-10-30T10:08:08Z', + ], + 'Path' => [ + 'description' => '生命周期管理策略配置的单个目录的绝对路径。', + 'type' => 'string', + 'example' => '/pathway/to/folder', + ], + 'StorageType' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。', + 'type' => 'string', + 'example' => 'InfrequentAccess', + ], + 'LifecyclePolicyName' => [ + 'description' => '生命周期管理策略名称。', + 'type' => 'string', + 'example' => 'lifecyclepolicy_01', + ], + 'Paths' => [ + 'description' => '生命周期管理策略配置的多个目录的绝对路径列表。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '生命周期管理策略配置的多个目录的绝对路径列表。'."\n" + ."\n", + 'type' => 'string', + 'example' => '["/path1","/path2"]', + ], + ], + 'LifecyclePolicyId' => [ + 'title' => '生命周期策略的 ID', + 'description' => '生命周期策略的 ID', + 'type' => 'string', + 'example' => 'lc-xxx', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => '描述', + ], + 'LifecyclePolicyType' => [ + 'title' => '策略类型', + 'description' => '策略类型', + 'type' => 'string', + 'example' => 'Auto', + ], + 'TransitRules' => [ + 'title' => '文件数据转储规则', + 'description' => '文件数据转储规则', + 'type' => 'array', + 'items' => [ + 'title' => '文件数据转储规则', + 'description' => '文件数据转储规则', + 'type' => 'object', + 'properties' => [ + 'Attribute' => [ + 'title' => '转储规则的属性', + 'description' => '转储规则的属性', + 'type' => 'string', + 'example' => 'Atime', + ], + 'Threshold' => [ + 'title' => '转储规则的阈值', + 'description' => '转储规则的阈值', + 'type' => 'string', + 'example' => '3', + ], + ], + ], + ], + 'RetrieveRules' => [ + 'title' => '文件数据取回规则', + 'description' => '文件数据取回规则', + 'type' => 'array', + 'items' => [ + 'title' => '文件数据取回规则', + 'description' => '文件数据取回规则', + 'type' => 'object', + 'properties' => [ + 'Attribute' => [ + 'title' => '取回规则的属性', + 'description' => '取回规则的属性', + 'type' => 'string', + 'example' => 'RetrieveType', + ], + 'Threshold' => [ + 'title' => '取回规则的阈值', + 'description' => '取回规则的阈值', + 'type' => 'string', + 'example' => 'All', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"LifecyclePolicies\\": [\\n {\\n \\"FileSystemId\\": \\"31a8e4****\\",\\n \\"LifecycleRuleName\\": \\"DEFAULT_ATIME_14\\",\\n \\"CreateTime\\": \\"2019-10-30T10:08:08Z\\",\\n \\"Path\\": \\"/pathway/to/folder\\",\\n \\"StorageType\\": \\"InfrequentAccess\\",\\n \\"LifecyclePolicyName\\": \\"lifecyclepolicy_01\\",\\n \\"Paths\\": [\\n \\"[\\\\\\"/path1\\\\\\",\\\\\\"/path2\\\\\\"]\\"\\n ],\\n \\"LifecyclePolicyId\\": \\"lc-xxx\\",\\n \\"Description\\": \\"描述\\",\\n \\"LifecyclePolicyType\\": \\"Auto\\",\\n \\"TransitRules\\": [\\n {\\n \\"Attribute\\": \\"Atime\\",\\n \\"Threshold\\": \\"3\\"\\n }\\n ],\\n \\"RetrieveRules\\": [\\n {\\n \\"Attribute\\": \\"RetrieveType\\",\\n \\"Threshold\\": \\"All\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLifecyclePoliciesResponse>\\n <TotalCount>10</TotalCount>\\n <RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <LifecyclePolicies>\\n <FileSystemId>31a8e4****</FileSystemId>\\n <LifecycleRuleName>DEFAULT_ATIME_14</LifecycleRuleName>\\n <CreateTime>2019-10-30T10:08:08Z</CreateTime>\\n <Path>/pathway/to/folder</Path>\\n <StorageType>InfrequentAccess</StorageType>\\n <LifecyclePolicyName>lifecyclepolicy_01</LifecyclePolicyName>\\n <Paths>\\n <0>/path1</0>\\n <1>/path2</1>\\n </Paths>\\n </LifecyclePolicies>\\n</DescribeLifecyclePoliciesResponse>","errorExample":""}]', + 'title' => '查询生命周期管理策略列表', + 'description' => '仅通用型NAS文件系统和 CPFS 智算版支持该功能。', + ], + 'CreateLifecycleRetrieveJob' => [ + 'summary' => '创建一个数据取回任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19616', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'Paths', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定取回的目录或文件路径列表。最多10个路径。', + 'type' => 'array', + 'items' => [ + 'description' => '指定取回的目录或文件。'."\n" + ."\n" + .'必须以正斜线（/）开头，并且是挂载点中真实存在的路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/pathway/doc1', + ], + 'required' => true, + 'example' => 'Paths.1=/pathway/doc1,Paths.2=/pathway/doc2', + 'maxItems' => 11, + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess（默认值）：低频存储。'."\n" + .'- Archive：归档存储。', + 'type' => 'string', + 'required' => false, + 'example' => 'InfrequentAccess', + 'default' => 'InfrequentAccess', + 'enum' => [ + 'InfrequentAccess', + 'Archive', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'JobId' => [ + 'description' => '数据取回任务ID。', + 'type' => 'string', + 'example' => 'lrj-nfstest-ia-160****853-hshvw', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.FileSystemNotSupportedForLifecycle', + 'errorMessage' => 'The file system does not support lifecycle.', + ], + [ + 'errorCode' => 'OperationDenied.EncryptedFileSystemNotSupportedForLifecycle', + 'errorMessage' => 'The encrypted file system does not support lifecycle.', + ], + [ + 'errorCode' => 'OperationDenied.LifecycleRetrieveJobCountLimitExceeded', + 'errorMessage' => 'The maximum number of LifecycleRetrieveJobs is exceeded.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.PathNotExist', + 'errorMessage' => 'The specified path does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"JobId\\": \\"lrj-nfstest-ia-160****853-hshvw\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLifecycleRetrieveJobResponse>\\n <RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>\\n <JobId>lrj-nfstest-ia-160****853-hshvw</JobId>\\n</CreateLifecycleRetrieveJobResponse>","errorExample":""}]', + 'title' => '创建数据取回任务', + 'description' => '- 仅通用型NAS文件系统支持该功能。'."\n" + .'- 每个阿里云账号在同一地域最多允许存在20个运行中状态的数据取回任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelLifecycleRetrieveJob' => [ + 'summary' => '取消任务状态为运行中（active）的一个数据取回任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19615', + 'abilityTreeNodes' => [ + 'FEATUREnas7AL8PW', + 'FEATUREnasEER7AI', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据取回任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lrj-nfstest-ia-160****853-hshvw', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.LifecycleRetrieveJobEnded', + 'errorMessage' => 'The specified LifecycleRetrieveJob has already ended.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidLifecycleRetrieveJob.NotFound', + 'errorMessage' => 'The specified LifecycleRetrieveJob does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>","errorExample":""}]', + 'title' => '取消数据取回任务', + 'description' => '仅通用型NAS文件系统支持该功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RetryLifecycleRetrieveJob' => [ + 'summary' => '重试任务状态为已失败（failed）的数据取回任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19611', + 'abilityTreeNodes' => [ + 'FEATUREnasZ6WBFV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据取回任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lrj-nfstest-ia-160****853-hshvw', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.LifecycleRetrieveJobNotFailed', + 'errorMessage' => 'The specified LifecycleRetrieveJob has not failed.', + ], + [ + 'errorCode' => 'OperationDenied.LifecycleRetrieveJobCountLimitExceeded', + 'errorMessage' => 'The maximum number of LifecycleRetrieveJobs is exceeded.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidLifecycleRetrieveJob.NotFound', + 'errorMessage' => 'The specified LifecycleRetrieveJob does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>","errorExample":""}]', + 'title' => '重试数据取回任务', + 'description' => '仅通用型NAS文件系统支持该功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListLifecycleRetrieveJobs' => [ + 'summary' => '获取已创建的数据取回任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19612', + 'abilityTreeNodes' => [ + 'FEATUREnas7AL8PW', + 'FEATUREnasEER7AI', + 'FEATUREnasZ6WBFV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每个分页包含的数据取回任务个数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '数据取回任务的状态。取值：'."\n" + .'- active：运行中。'."\n" + .'- canceled ：已取消。'."\n" + .'- completed：已完成。'."\n" + .'- failed：已失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'completed', + 'default' => '', + 'enum' => [ + 'active', + 'canceled', + 'completed', + 'failed', + ], + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。'."\n" + .'> 如未指定 StorageType，则返回所有类型的数据取回任务信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'InfrequentAccess', + 'enum' => [ + 'InfrequentAccess', + 'Archive', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据取回任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的数据取回任务个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LifecycleRetrieveJobs' => [ + 'description' => '数据取回任务信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '数据取回任务信息集合。', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '31a8e4****', + ], + 'Status' => [ + 'description' => '数据取回任务的状态。包括：'."\n" + .'- active：运行中。'."\n" + .'- canceled ：已取消。'."\n" + .'- completed：已完成。'."\n" + .'- failed：已失败。', + 'type' => 'string', + 'example' => 'completed', + ], + 'DiscoveredFileCount' => [ + 'description' => '执行数据取回任务读取文件的总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UpdateTime' => [ + 'description' => '任务更新时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'example' => '2021-02-30T11:08:08Z', + ], + 'Paths' => [ + 'description' => '指定取回任务的执行路径。', + 'type' => 'array', + 'items' => [ + 'description' => '指定取回的目录或文件。'."\n" + ."\n" + .'必须以正斜线（/）开头，并且是挂载点中真实存在的路径。', + 'type' => 'string', + 'example' => '["/pathway/to/folder","/pathway/to/folder","/pathway/to/folder"]', + ], + ], + 'RetrievedFileCount' => [ + 'description' => '执行数据取回任务成功取回的文件个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'JobId' => [ + 'description' => '数据取回任务ID。', + 'type' => 'string', + 'example' => 'lrj-nfstest-ia-160****853-hshvw', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'example' => '2021-02-30T10:08:08Z', + ], + 'StorageType' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。', + 'type' => 'string', + 'example' => 'InfrequentAccess', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"LifecycleRetrieveJobs\\": [\\n {\\n \\"FileSystemId\\": \\"31a8e4****\\",\\n \\"Status\\": \\"completed\\",\\n \\"DiscoveredFileCount\\": 100,\\n \\"UpdateTime\\": \\"2021-02-30T11:08:08Z\\",\\n \\"Paths\\": [\\n \\"[\\\\\\"/pathway/to/folder\\\\\\",\\\\\\"/pathway/to/folder\\\\\\",\\\\\\"/pathway/to/folder\\\\\\"]\\"\\n ],\\n \\"RetrievedFileCount\\": 80,\\n \\"JobId\\": \\"lrj-nfstest-ia-160****853-hshvw\\",\\n \\"CreateTime\\": \\"2021-02-30T10:08:08Z\\",\\n \\"StorageType\\": \\"InfrequentAccess\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListLifecycleRetrieveJobsResponse>\\n <TotalCount>10</TotalCount>\\n <RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <LifecycleRetrieveJobs>\\n <FileSystemId>31a8e4****</FileSystemId>\\n <Status>completed</Status>\\n <DiscoveredFileCount>100</DiscoveredFileCount>\\n <UpdateTime>2021-02-30T11:08:08Z</UpdateTime>\\n <Paths>[\\"/pathway/to/folder\\",\\"/pathway/to/folder\\",\\"/pathway/to/folder\\"]</Paths>\\n <RetrievedFileCount>80</RetrievedFileCount>\\n <JobId>lrj-nfstest-ia-160****853-hshvw</JobId>\\n <CreateTime>2021-02-30T10:08:08Z</CreateTime>\\n </LifecycleRetrieveJobs>\\n</ListLifecycleRetrieveJobsResponse>","errorExample":""}]', + 'title' => '查询数据取回任务列表', + 'description' => '仅通用型NAS文件系统支持该功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDirectoriesAndFiles' => [ + 'summary' => '获取通用型NAS指定目录下的低频存储文件和包含低频存储文件的子目录列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19613', + 'abilityTreeNodes' => [ + 'FEATUREnas0A1PB1', + 'FEATUREnasZ6WBFV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '指定目录的绝对路径。'."\n" + ."\n" + .'必须以正斜线（/）开头，并且是挂载点中真实存在的路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/pathway/to/folder', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0= ', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '分级存储类型。'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。'."\n" + .'- All：查询所有存储数据。'."\n" + .'> 当StorageType取值为ALL时，必须配置DirectoryOnly参数，且值为true.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'InfrequentAccess', + 'enum' => [ + 'InfrequentAccess', + 'All', + 'Archive', + ], + ], + ], + [ + 'name' => 'DirectoryOnly', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只查询目录。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- false（默认值）：否，可以查询目录或文件'."\n" + .'- true：是，只查询目录'."\n" + .'> 当StorageType取值为All时，DirectoryOnly取值为true，不能为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询结果中包含的目录或文件的个数。'."\n" + ."\n" + .'取值范围：10~128'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '128', + 'minimum' => '10', + 'example' => '100', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + 'Entries' => [ + 'description' => '目录或文件信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '目录或文件信息集合。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '返回结果的类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- File：文件'."\n" + .'- Directory：目录', + 'type' => 'string', + 'example' => 'File', + ], + 'HasInfrequentAccessFile' => [ + 'description' => '是否包含低频存储文件。'."\n" + ."\n" + .'仅当Type为Directory时，返回该值且有意义。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：包含'."\n" + .'- false：不包含', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Ctime' => [ + 'description' => '元数据修改时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。'."\n" + ."\n" + .'仅当Type为File时，返回该值且有意义。', + 'type' => 'string', + 'example' => '2021-02-11T10:08:10Z', + ], + 'Mtime' => [ + 'description' => '文件修改时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。'."\n" + ."\n" + .'仅当Type为File时，返回该值且有意义。', + 'type' => 'string', + 'example' => '2021-02-11T10:08:08Z', + ], + 'Size' => [ + 'description' => '文件的大小。'."\n" + ."\n" + .'单位：Byte（字节）'."\n" + ."\n" + .'仅当Type为File时，返回该值且有意义。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'StorageType' => [ + 'description' => '返回文件的分级存储类型。'."\n" + ."\n" + .'仅当Type为File时，返回该值且有意义。'."\n" + ."\n" + .'包括：'."\n" + .'- InfrequentAccess：低频存储。'."\n" + .'- Archive：归档存储。', + 'type' => 'string', + 'example' => 'InfrequentAccess', + ], + 'Atime' => [ + 'description' => '查询时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。'."\n" + ."\n" + .'仅当Type为File时，返回该值且有意义。', + 'type' => 'string', + 'example' => '2021-02-01T10:08:08Z', + ], + 'Name' => [ + 'description' => '文件名或目录名。', + 'type' => 'string', + 'example' => 'file.txt', + ], + 'RetrieveTime' => [ + 'description' => '距现在最近一次数据取回任务执行的时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。'."\n" + ."\n" + .'仅当Type为File时，返回该值且有意义。', + 'type' => 'string', + 'example' => '2021-02-11T10:08:08Z', + ], + 'Inode' => [ + 'description' => '文件或目录inode。', + 'type' => 'string', + 'example' => '66', + ], + 'FileId' => [ + 'description' => '目录或文件的FileId。', + 'type' => 'string', + 'example' => '66', + ], + 'Owner' => [ + 'description' => '便携账号ID。'."\n" + .'仅当ProtocolType=SMB且开启访问控制时，该返回值具有意义。', + 'type' => 'string', + 'example' => '37862c****', + ], + 'HasArchiveFile' => [ + 'description' => '是否包含归档存储文件。'."\n" + ."\n" + .'仅当Type为Directory时，返回该值且有意义。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：包含'."\n" + .'- false：不包含', + 'type' => 'string', + 'example' => 'true', + ], + 'OfflineDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'OfflineUnchangedDuration' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.PathNotExist', + 'errorMessage' => 'The specified path does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=\\",\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\",\\n \\"Entries\\": [\\n {\\n \\"Type\\": \\"File\\",\\n \\"HasInfrequentAccessFile\\": true,\\n \\"Ctime\\": \\"2021-02-11T10:08:10Z\\",\\n \\"Mtime\\": \\"2021-02-11T10:08:08Z\\",\\n \\"Size\\": 1024,\\n \\"StorageType\\": \\"InfrequentAccess\\",\\n \\"Atime\\": \\"2021-02-01T10:08:08Z\\",\\n \\"Name\\": \\"file.txt\\",\\n \\"RetrieveTime\\": \\"2021-02-11T10:08:08Z\\",\\n \\"Inode\\": \\"66\\",\\n \\"FileId\\": \\"66\\",\\n \\"Owner\\": \\"37862c****\\",\\n \\"HasArchiveFile\\": \\"true\\",\\n \\"OfflineDuration\\": 0,\\n \\"OfflineUnchangedDuration\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDirectoriesAndFilesResponse>\\n <NextToken>TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=</NextToken>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n <Entries>\\n <Type>File</Type>\\n <HasInfrequentAccessFile>true</HasInfrequentAccessFile>\\n <Ctime>2021-02-11T10:08:10Z</Ctime>\\n <Mtime>2021-02-11T10:08:08Z</Mtime>\\n <Size>1024</Size>\\n <StorageType>InfrequentAccess</StorageType>\\n <Atime>2021-02-01T10:08:08Z</Atime>\\n <Name>file.txt</Name>\\n <RetrieveTime>2021-02-11T10:08:08Z</RetrieveTime>\\n <Inode>66</Inode>\\n <FileId>66</FileId>\\n <Owner>37862c****</Owner>\\n </Entries>\\n</ListDirectoriesAndFilesResponse>","errorExample":""}]', + 'title' => '查询目录和文件列表', + 'description' => '仅通用型NAS文件系统支持该功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableRecycleBin' => [ + 'summary' => '开启回收站功能。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '14453', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '待开启回收站功能的文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'ReservedDays', + 'in' => 'query', + 'schema' => [ + 'description' => '回收站中文件的保留时间。单位：天。'."\n" + ."\n" + .'取值范围：1~180'."\n" + ."\n" + .'默认值：3', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '180', + 'minimum' => '1', + 'example' => '3', + 'default' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E15E394-38A6-457A-A62A-D9797C9A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.RecycleBinEnabled', + 'errorMessage' => 'The recycle bin is already enabled.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E15E394-38A6-457A-A62A-D9797C9A****\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableRecycleBinResponse>\\n <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>\\n</EnableRecycleBinResponse>","errorExample":""}]', + 'title' => '开启回收站功能', + 'description' => '仅通用型NAS文件系统支持该接口。', + ], + 'DisableAndCleanRecycleBin' => [ + 'summary' => '关闭通用型NAS文件系统的回收站功能，并清空回收站中的数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '14454', + 'abilityTreeNodes' => [ + 'FEATUREnas0A1PB1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E15E394-38A6-457A-A62A-D9797C9A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.RecycleBinDisabled', + 'errorMessage' => 'The operation is denied because the recycle bin is disabled.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E15E394-38A6-457A-A62A-D9797C9A****\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAndCleanRecycleBinResponse>\\n <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>\\n</DisableAndCleanRecycleBinResponse>","errorExample":""}]', + 'title' => '关闭并清空回收站', + 'description' => '- 仅通用型NAS文件系统支持该功能。'."\n" + .'- 关闭回收站会彻底删除回收站内的所有文件。'."\n" + .'- 已关闭的回收站重新开启后，回收站内容为空，无法找回开启回收站功能前删除的文件。', + ], + 'UpdateRecycleBinAttribute' => [ + 'summary' => '修改一个回收站中数据的保留时间。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '14458', + 'abilityTreeNodes' => [ + 'FEATUREnas0A1PB1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'ReservedDays', + 'in' => 'query', + 'schema' => [ + 'description' => '回收站中文件的保留时间。单位：天。'."\n" + ."\n" + .'取值范围：1~180'."\n" + ."\n" + .'默认值：3', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '180', + 'minimum' => '1', + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C5****546E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.RecycleBinDisabled', + 'errorMessage' => 'The operation is denied because the recycle bin is disabled.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C5****546E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateRecycleBinAttributeResponse>\\n <RequestId>BC7C825C-5F65-4B56-BEF6-98C5****546E</RequestId>\\n</UpdateRecycleBinAttributeResponse>","errorExample":""}]', + 'title' => '更改回收站的属性', + 'description' => '仅通用型NAS文件系统支持该功能。', + ], + 'GetRecycleBinAttribute' => [ + 'summary' => '查询指定通用型NAS文件系统的回收站配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14459', + 'abilityTreeNodes' => [ + 'FEATUREnas0A1PB1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E15E394-38A6-457A-A62A-D9797C9A****', + ], + 'RecycleBinAttribute' => [ + 'description' => '回收站描述信息。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '回收站中文件的存储量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'SecondarySize' => [ + 'description' => '回收站中低频数据存储量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Status' => [ + 'description' => '回收站状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Enable：回收站已启用。'."\n" + .'- Disable：回收站已关闭。', + 'type' => 'string', + 'example' => 'Disable', + ], + 'ReservedDays' => [ + 'description' => '回收站中文件的保留时间。单位：天。'."\n" + ."\n" + .'当回收站状态为关闭时，该参数返回0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'EnableTime' => [ + 'description' => '回收站开启的时间。', + 'type' => 'string', + 'example' => '2021-05-30T10:08:08Z', + ], + 'ArchiveSize' => [ + 'description' => '回收站中归档数据存储量。'."\n" + .'单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611661312', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E15E394-38A6-457A-A62A-D9797C9A****\\",\\n \\"RecycleBinAttribute\\": {\\n \\"Size\\": 100,\\n \\"SecondarySize\\": 100,\\n \\"Status\\": \\"Disable\\",\\n \\"ReservedDays\\": 0,\\n \\"EnableTime\\": \\"2021-05-30T10:08:08Z\\",\\n \\"ArchiveSize\\": 1611661312\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRecycleBinAttributeResponse>\\n <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>\\n <RecycleBinAttribute>\\n <Size>100</Size>\\n <SecondarySize>100</SecondarySize>\\n <Status>Disable</Status>\\n <ReservedDays>0</ReservedDays>\\n <EnableTime>2021-05-30T10:08:08Z</EnableTime>\\n </RecycleBinAttribute>\\n</GetRecycleBinAttributeResponse>","errorExample":""}]', + 'title' => '获取回收站的属性', + 'description' => '仅通用型NAS文件系统支持该功能。', + ], + 'CreateRecycleBinRestoreJob' => [ + 'summary' => '恢复一个暂存回收站中的文件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14460', + 'abilityTreeNodes' => [ + 'FEATUREnas0A1PB1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '待恢复的文件或目录的FileId。'."\n" + ."\n" + .'您可以通过调用[ListRecycledDirectoriesAndFiles](~~2412174~~)接口查询已删除数据的FileId信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '04***08', + ], + ], + [ + 'name' => 'TargetFileId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件恢复后所存储目录的FileId。'."\n" + .'- 您可以通过调用[ListRecentlyRecycledDirectories](~~2412173~~)接口查询执行过删除操作的目录TargetFileId信息。'."\n" + ."\n" + .'- 您可以通过调用[ListDirectoriesAndFiles](~~2412163~~)接口查询文件系统中已存在目录TargetFileId信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '13***15', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'>若您未指定ClientToken，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'rb-10****491ff-r-162****165400', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingTargetFileId', + 'errorMessage' => 'TargetFileId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFileId', + 'errorMessage' => 'FileId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.KMSUnauthorized', + 'errorMessage' => 'KMS is not authorized.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.CMKNotEnabled', + 'errorMessage' => 'The CMK needs to be enabled.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.RecycleBinDisabled', + 'errorMessage' => 'The operation is denied because the recycle bin is disabled.', + ], + [ + 'errorCode' => 'OperationDenied.Conflict', + 'errorMessage' => 'The operation is in conflict with (% JobId). Please try again later.', + ], + [ + 'errorCode' => 'OperationDenied.TooManyRunningJobs', + 'errorMessage' => 'The maximum number of running job is one. Please try again later.', + ], + [ + 'errorCode' => 'InvalidTargetFileId.NotDirectory', + 'errorMessage' => 'The specified TargetFileId(%'."\n" + ."\n" + .'TargetFileId) is not directory.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFileId.NotFound', + 'errorMessage' => 'The specified FileId(%FileId) does not exist.', + ], + [ + 'errorCode' => 'InvalidTargetFileId.NotFound', + 'errorMessage' => 'The specified TargetFileId(%TargetFileId) does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"JobId\\": \\"rb-10****491ff-r-162****165400\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRecycleBinRestoreJobResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n <JobId>8C****C54</JobId>\\n</CreateRecycleBinRestoreJobResponse>","errorExample":""}]', + 'title' => '恢复回收站中暂存的文件', + 'description' => '- 仅通用型NAS文件系统支持该功能。'."\n" + .'- 单个文件系统一次只能执行一个文件恢复或清理任务。正在恢复文件时，无法发起新的文件恢复或清理任务。'."\n" + .'- 单个恢复任务只能恢复一个文件或目录，恢复指定目录会递归恢复目录下的所有文件。'."\n" + .'- 文件被恢复后会进行数据整理，数据整理期间读请求性能稍有下降。', + ], + 'CreateRecycleBinDeleteJob' => [ + 'summary' => '创建一个彻底删除回收站中暂存的文件或目录的任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '14461', + 'abilityTreeNodes' => [ + 'FEATUREnas0A1PB1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '待彻底删除文件或目录的FileId。'."\n" + ."\n" + .'您可以通过调用[ListRecycledDirectoriesAndFiles](~~2412174~~)接口查询已删除数据的FileId信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '04***08', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'>若您未指定ClientToken，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '8C****C54', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFileId', + 'errorMessage' => 'FileId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.KMSUnauthorized', + 'errorMessage' => 'KMS is not authorized.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.CMKNotEnabled', + 'errorMessage' => 'The CMK needs to be enabled.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.Conflict', + 'errorMessage' => 'The operation is in conflict with (% JobId). Please try again later.', + ], + [ + 'errorCode' => 'OperationDenied.TooManyRunningJobs', + 'errorMessage' => 'The maximum number of running job is one. Please try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFileId.NotFound', + 'errorMessage' => 'The specified FileId(%FileId) does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"JobId\\": \\"8C****C54\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRecycleBinDeleteJobResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n <JobId>8C****C54</JobId>\\n</CreateRecycleBinDeleteJobResponse>","errorExample":""}]', + 'title' => '彻底删除回收站中暂存的文件或目录', + 'description' => '- 仅通用型NAS文件系统支持该功能。'."\n" + .'- 彻底删除目录时，目录中的内容会被递归清理。'."\n" + .'- 单个文件系统一次只能执行一个彻底删除任务。正在彻底删除文件或目录时，无法发起新的恢复或清理任务。', + ], + 'CancelRecycleBinJob' => [ + 'summary' => '取消一个回收站中正在运行中的任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14462', + 'abilityTreeNodes' => [ + 'FEATUREnas0A1PB1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '待取消任务ID。'."\n" + ."\n" + .'您可以通过调用[ListRecycleBinJobs](~~2412172~~)接口查询JobId信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rb-15****ed-r-1625****2441', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingJobId', + 'errorMessage' => 'JobId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.Conflict', + 'errorMessage' => 'The operation is in conflict with (% JobId). Please try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidJobId.NotFound', + 'errorMessage' => 'The specified JobId(%JobId) does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelRecycleBinJobResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</CancelRecycleBinJobResponse>","errorExample":""}]', + 'title' => '取消回收站中的任务', + 'description' => '### 接口说明'."\n" + ."\n" + .'- 仅通用型NAS文件系统支持该功能。'."\n" + .'- 仅支持取消状态为运行中的任务，已达到终态的任务（PartialSuccess：部分运行成功、Success：运行成功、Fail：运行失败、Cancelled：已取消）执行取消操作不生效。'."\n" + .'- 取消运行中的彻底删除任务时，已彻底删除的任务无法恢复。'."\n" + .'- 取消运行中的文件恢复任务时，已恢复的文件可以在文件系统查询，未恢复的文件可以在回收站中查询。', + ], + 'ListRecycleBinJobs' => [ + 'summary' => '查询回收站中的一个或多个任务信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14463', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rb-15****ed-r-1625****2441', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时当前的页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- Running：运行中'."\n" + .'- Defragmenting：数据整理中'."\n" + .'- PartialSuccess：部分运行成功'."\n" + .'- Success：运行成功'."\n" + .'- Fail：运行失败'."\n" + .'- Cancelled：已取消'."\n" + .'- All（默认值）：全部', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + 'default' => 'All', + 'enum' => [ + 'Running', + 'Defragmenting', + 'PartialSuccess', + 'Success', + 'Fail', + 'Cancelled', + 'All', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E15E394-38A6-457A-A62A-D9797C9A****', + ], + 'TotalCount' => [ + 'description' => '回收站中任务的总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '列表的分页页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每个分页包含的任务个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Jobs' => [ + 'description' => '回收站中的任务信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '8C****C54', + ], + 'Type' => [ + 'description' => '任务类型。包括：'."\n" + ."\n" + .'- Restore：文件恢复任务'."\n" + .'- Delete：文件删除任务', + 'type' => 'string', + 'example' => 'Restore', + ], + 'FileId' => [ + 'description' => '任务对应文件或目录的FileId。', + 'type' => 'string', + 'example' => '04***08', + ], + 'Status' => [ + 'description' => '任务状态。包括：'."\n" + ."\n" + .'- Running：运行中'."\n" + .'- Defragmenting：数据整理中'."\n" + .'- PartialSuccess：部分运行成功'."\n" + .'- Success：运行成功'."\n" + .'- Fail：运行失败'."\n" + .'- Cancelled：已取消', + 'type' => 'string', + 'example' => 'Fail', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\n" + .'当Status为Fail或PartialSuccess时，该返回值有效。', + 'type' => 'string', + 'example' => 'InvalidFileId.NotFound', + ], + 'Progress' => [ + 'description' => '查询任务的执行进度。'."\n" + ."\n" + .'取值范围：1~100', + 'type' => 'string', + 'example' => '100', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2021-05-30T10:08:08Z', + ], + 'FileName' => [ + 'description' => '任务对应文件或目录的名称。', + 'type' => 'string', + 'example' => 'test001', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n" + .'当JobStatus为Fail或PartialSuccess时，该返回值有效。', + 'type' => 'string', + 'example' => 'The Target File or Directory does not exist.', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidStatus', + 'errorMessage' => 'Specified parameter Status is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidJobId.NotFound', + 'errorMessage' => 'The specified JobId(%JobId) does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E15E394-38A6-457A-A62A-D9797C9A****\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Jobs\\": [\\n {\\n \\"Id\\": \\"8C****C54\\",\\n \\"Type\\": \\"Restore\\",\\n \\"FileId\\": \\"04***08\\",\\n \\"Status\\": \\"Fail\\",\\n \\"ErrorCode\\": \\"InvalidFileId.NotFound\\",\\n \\"Progress\\": \\"100\\",\\n \\"CreateTime\\": \\"2021-05-30T10:08:08Z\\",\\n \\"FileName\\": \\"test001\\",\\n \\"ErrorMessage\\": \\"The Target File or Directory does not exist.\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRecycleBinJobsResponse>\\n <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <Jobs>\\n <Id>8C****C54</Id>\\n <Type>Restore</Type>\\n <FileId>04***08</FileId>\\n <Status>Running</Status>\\n <ErrorCode>无</ErrorCode>\\n <Progress>100</Progress>\\n <CreateTime>2021-05-30T10:08:08Z</CreateTime>\\n <FileName>test001</FileName>\\n <ErrorMessage>无</ErrorMessage>\\n </Jobs>\\n</ListRecycleBinJobsResponse>","errorExample":""}]', + 'title' => '查询回收站中的任务列表', + 'description' => '- 仅通用型NAS文件系统支持该功能。'."\n" + .'- 最多可以查询最近执行的50个任务。', + ], + 'ListRecentlyRecycledDirectories' => [ + 'summary' => '查询最近执行过删除操作的目录。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14465', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页标识，首次查询无需传入。'."\n" + ."\n" + .'如果一次查询结果并没有完整返回所有的目录，则返回NextToken不为空。您可以在查询中上传正确的NextToken继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1256****25', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询返回目录的个数。'."\n" + ."\n" + .'取值范围：10~1000'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '10', + 'example' => '100', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E15E394-38A6-457A-A62A-D9797C9A****', + ], + 'NextToken' => [ + 'title' => 'Id of the request', + 'description' => '下一页标识。'."\n" + ."\n" + .'如果一次查询结果并没有完整返回所有的目录，则返回NextToken不为空。您可以在查询中上传正确的NextToken继续查询。', + 'type' => 'string', + 'example' => '1256****25', + ], + 'Entries' => [ + 'description' => '最近执行过删除操作的目录信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '目录ID。', + 'type' => 'string', + 'example' => '04***08', + ], + 'Path' => [ + 'description' => '目录的绝对路径。', + 'type' => 'string', + 'example' => '/a/b', + ], + 'Name' => [ + 'description' => '目录的名称。', + 'type' => 'string', + 'example' => 'b', + ], + 'LastDeleteTime' => [ + 'description' => '该目录最近一次执行删除操作的时间。', + 'type' => 'string', + 'example' => '2021-05-30T10:08:08Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.KMSUnauthorized', + 'errorMessage' => 'KMS is not authorized.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.CMKNotEnabled', + 'errorMessage' => 'The CMK needs to be enabled.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invaild.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E15E394-38A6-457A-A62A-D9797C9A****\\",\\n \\"NextToken\\": \\"1256****25\\",\\n \\"Entries\\": [\\n {\\n \\"FileId\\": \\"04***08\\",\\n \\"Path\\": \\"/a/b\\",\\n \\"Name\\": \\"b\\",\\n \\"LastDeleteTime\\": \\"2021-05-30T10:08:08Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRecentlyRecycledDirectoriesResponse>\\n <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>\\n <NextToken>1256****25</NextToken>\\n <Entries>\\n <FileId>04***08</FileId>\\n <Path>/a/b</Path>\\n <Name>b</Name>\\n <LastDeleteTime>2021-05-30T10:08:08Z</LastDeleteTime>\\n </Entries>\\n</ListRecentlyRecycledDirectoriesResponse>","errorExample":""}]', + 'title' => '查询最近删除的目录', + 'description' => '仅通用型NAS文件系统支持该功能。', + ], + 'ListRecycledDirectoriesAndFiles' => [ + 'summary' => '查询已删除的文件或目录。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14464', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询目录的FileId。'."\n" + ."\n" + .'您可以通过调用[ListRecentlyRecycledDirectories ](~~2412173~~)接口查询FileId信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '04***08', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页标识，首次查询无需传入。'."\n" + ."\n" + .'如果一次查询结果并没有完整返回所有的文件和目录，则返回NextToken不为空。'."\n" + .'您可以在查询中上传正确的NextToken继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1256****25', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询返回文件或目录的个数。'."\n" + ."\n" + .'取值范围：10~1000'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '10', + 'example' => '100', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'NextToken' => [ + 'title' => 'Id of the request', + 'description' => '下一页标识。'."\n" + ."\n" + .'如果一次查询结果并没有完整返回所有的文件和目录，则返回NextToken不为空。您可以在查询中上传正确的NextToken继续查询。', + 'type' => 'string', + 'example' => '无', + ], + 'Entries' => [ + 'description' => '回收站中文件或目录的信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件或目录的FileId。', + 'type' => 'string', + 'example' => '04***08', + ], + 'Type' => [ + 'description' => '返回对象类型。包括：'."\n" + ."\n" + .'- File：文件'."\n" + .'- Directory：目录', + 'type' => 'string', + 'example' => 'File', + ], + 'Name' => [ + 'description' => '文件或目录删除前的名称。', + 'type' => 'string', + 'example' => 'test001', + ], + 'DeleteTime' => [ + 'description' => '文件或目录被删除的时间。', + 'type' => 'string', + 'example' => '2021-05-30T10:08:08Z', + ], + 'Inode' => [ + 'description' => '文件或目录的inode。', + 'type' => 'string', + 'example' => '04***08', + ], + 'ATime' => [ + 'description' => '最近访问时间。', + 'type' => 'string', + 'example' => '2019-10-30T10:08:08Z', + ], + 'MTime' => [ + 'description' => '最近修改时间。', + 'type' => 'string', + 'example' => '2019-10-30T10:08:08Z', + ], + 'CTime' => [ + 'description' => '元数据最近修改时间。', + 'type' => 'string', + 'example' => '2019-10-30T10:08:08Z', + ], + 'Size' => [ + 'description' => '文件大小。单位：Byte。'."\n" + ."\n" + .'当Type=Directory时，返回为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.KMSUnauthorized', + 'errorMessage' => 'KMS is not authorized.', + ], + [ + 'errorCode' => 'InvalidParameter.KMSKeyId.CMKNotEnabled', + 'errorMessage' => 'The CMK needs to be enabled.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFileId.NotFound', + 'errorMessage' => 'The specified FileId(%FileId) does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invaild.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"NextToken\\": \\"无\\",\\n \\"Entries\\": [\\n {\\n \\"FileId\\": \\"04***08\\",\\n \\"Type\\": \\"File\\",\\n \\"Name\\": \\"test001\\",\\n \\"DeleteTime\\": \\"2021-05-30T10:08:08Z\\",\\n \\"Inode\\": \\"04***08\\",\\n \\"ATime\\": \\"2019-10-30T10:08:08Z\\",\\n \\"MTime\\": \\"2019-10-30T10:08:08Z\\",\\n \\"CTime\\": \\"2019-10-30T10:08:08Z\\",\\n \\"Size\\": 1073741824\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRecycledDirectoriesAndFilesResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n <NextToken>无</NextToken>\\n <Entries>\\n <FileId>04***08</FileId>\\n <Type>File</Type>\\n <Name>test001</Name>\\n <DeleteTime>2021-05-30T10:08:08Z</DeleteTime>\\n <Inode>04***08</Inode>\\n <ATime>2019-10-30T10:08:08Z</ATime>\\n <MTime>2019-10-30T10:08:08Z</MTime>\\n <CTime>2019-10-30T10:08:08Z</CTime>\\n <Size>1073741824</Size>\\n </Entries>\\n</ListRecycledDirectoriesAndFilesResponse>","errorExample":""}]', + 'title' => '查询已删除的文件或目录', + 'description' => '仅通用型NAS支持该功能。', + ], + 'EnableSmbAcl' => [ + 'summary' => '开启SMB AD ACL功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13968', + 'abilityTreeNodes' => [ + 'FEATUREnasWJVZ38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'Keytab', + 'in' => 'query', + 'schema' => [ + 'description' => 'keytab文件内容通过base64加密后的字符串。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'BQIAAABHAAIADUFMSUFEVEVTVC5DT00ABGNpZnMAGXNtYnNlcnZlcjI0LmFsaWFkdGVzdC5jb20AAAABAAAAAAEAAQAIqIx6v7p11oUAAABHAAIADUFMSUFEVEVTVC5DT00ABGNpZnMAGXNtYnNlcnZlcjI0LmFsaWFkdGVzdC5jb20AAAABAAAAAAEAAwAIqIx6v7p11oUAAABPAAIADUFMSUFEVEVTVC5DT00ABGNpZnMAGXNtYnNlcnZlcjI0LmFsaWFkdGVzdC5jb20AAAABAAAAAAEAFwAQnQZWB3RAPHU7PMIJyBWePAAAAF8AAgANQUxJQURURVNULkNPTQAEY2lmcwAZc21ic2VydmVyMjQuYWxpYWR0ZXN0LmNvbQAAAAEAAAAAAQASACAGJ7F0s+bcBjf6jD5HlvlRLmPSOW+qDZe0Qk0lQcf8WwAAAE8AAgANQUxJQURURVNULkNPTQAEY2lmcwAZc21ic2VydmVyMjQuYWxpYWR0ZXN0LmNvbQAAAAEAAAAAAQARABDdFmanrSIatnDDhxxxxx', + ], + ], + [ + 'name' => 'KeytabMd5', + 'in' => 'query', + 'schema' => [ + 'description' => 'keytab文件内容通过MD5加密后的字符串。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'E3CCF7E2416DF04FA958AA4513EAxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableSmbAclResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</EnableSmbAclResponse>","errorExample":""}]', + 'title' => '开启SMB AD ACL', + ], + 'DisableSmbAcl' => [ + 'summary' => '关闭SMB AD ACL功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13966', + 'abilityTreeNodes' => [ + 'FEATUREnasWJVZ38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableSmbAclResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</DisableSmbAclResponse>","errorExample":""}]', + 'title' => '关闭SMB AD ACL', + ], + 'ModifySmbAcl' => [ + 'summary' => '更新SMB AD ACL功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13980', + 'abilityTreeNodes' => [ + 'FEATUREnasWJVZ38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'Keytab', + 'in' => 'query', + 'schema' => [ + 'description' => 'keytab文件内容通过base64加密后的字符串。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'BQIAAABHAAIADUFMSUFEVEVTVC5DT00ABGNpZnMAGXNtYnNlcnZlcjI0LmFsaWFkdGVzdC5jb20AAAABAAAAAAEAAQAIqIx6v7p11oUAAABHAAIADUFMSUFEVEVTVC5DT00ABGNpZnMAGXNtYnNlcnZlcjI0LmFsaWFkdGVzdC5jb20AAAABAAAAAAEAAwAIqIx6v7p11oUAAABPAAIADUFMSUFEVEVTVC5DT00ABGNpZnMAGXNtYnNlcnZlcjI0LmFsaWFkdGVzdC5jb20AAAABAAAAAAEAFwAQnQZWB3RAPHU7PMIJyBWePAAAAF8AAgANQUxJQURURVNULkNPTQAEY2lmcwAZc21ic2VydmVyMjQuYWxpYWR0ZXN0LmNvbQAAAAEAAAAAAQASACAGJ7F0s+bcBjf6jD5HlvlRLmPSOW+qDZe0Qk0lQcf8WwAAAE8AAgANQUxJQURURVNULkNPTQAEY2lmcwAZc21ic2VydmVyMjQuYWxpYWR0ZXN0LmNvbQAAAAEAAAAAAQARABDdFmanrSIatnDDh****', + ], + ], + [ + 'name' => 'KeytabMd5', + 'in' => 'query', + 'schema' => [ + 'description' => 'keytab文件内容通过MD5加密后的字符串。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'E3CCF7E2416DF04FA958AA4513EA****', + ], + ], + [ + 'name' => 'EnableAnonymousAccess', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '是否允许匿名访问。 '."\n" + ."\n" + .'- true：允许匿名访问。'."\n" + ."\n" + .'- false（默认）：不允许匿名访问。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'EncryptData', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用传输加密。'."\n" + ."\n" + .'- true：启用传输加密。'."\n" + ."\n" + .'- false（默认）：不启用传输加密。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'RejectUnencryptedAccess', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拒绝非加密客户端。'."\n" + ."\n" + .'- true：拒绝非加密客户端。'."\n" + ."\n" + .'- false（默认）：不拒绝非加密客户端 。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'SuperAdminSid', + 'in' => 'query', + 'schema' => [ + 'description' => '超级用户的ID。ID规则如下：'."\n" + ."\n" + .'- 必须以`S`开头且除开头的S之外后面不能出现其他字母。'."\n" + ."\n" + .'- 至少三个短横线（-）相隔。'."\n" + ."\n" + .'例如`S-1-5-22`或`S-1-5-22-23`。', + 'type' => 'string', + 'required' => false, + 'example' => 'S-1-5-22', + ], + ], + [ + 'name' => 'HomeDirPath', + 'in' => 'query', + 'schema' => [ + 'description' => '每个用户的用户目录主路径。文件路径格式如下：'."\n" + ."\n" + .'- 以正斜线（/）或反斜线（\\）作为分隔符。'."\n" + ."\n" + .'- 每段内容不能包含`<>":|?*`。'."\n" + ."\n" + .'- 每段长度范围为0~255。'."\n" + ."\n" + .'- 总长度范围为0~32767。'."\n" + ."\n" + .'例如用户目录是`/home`，则对于用户A，文件系统会在A登录时自动创建`/home/A`的目录。如果`/home/A`已经存在，则跳过。'."\n" + ."\n" + .'> 用户A需要拥有创建目录的权限，否则无法创建`/home/A`目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/home', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifySmbAclResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6***</RequestId>\\n</ModifySmbAclResponse>","errorExample":""}]', + 'title' => '更新SMB AD ACL', + ], + 'DescribeSmbAcl' => [ + 'summary' => '查看SMB AD ACL功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13960', + 'abilityTreeNodes' => [ + 'FEATUREnasWJVZ38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '31a8e4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'Acl' => [ + 'description' => 'ACL信息。', + 'type' => 'object', + 'properties' => [ + 'EnableAnonymousAccess' => [ + 'description' => '是否允许匿名访问。取值如下：'."\n" + ."\n" + .'- true：允许匿名访问。'."\n" + ."\n" + .'- false ：不允许匿名访问。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Enabled' => [ + 'description' => '是否启用SMB AD ACL功能。'."\n" + ."\n" + .'- true：启用SMB AD ACL功能。'."\n" + ."\n" + .'- false：不启用SMB AD ACL功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EncryptData' => [ + 'description' => '是否启用传输加密。'."\n" + ."\n" + .'- true：启用传输加密。'."\n" + ."\n" + .'- false：不启用传输加密。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RejectUnencryptedAccess' => [ + 'description' => '是否拒绝非加密客户端。'."\n" + ."\n" + .'- true：拒绝非加密客户端。'."\n" + ."\n" + .'- false：不拒绝非加密客户端 。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SuperAdminSid' => [ + 'description' => '超级用户的ID。', + 'type' => 'string', + 'example' => 'S-1-0-0', + ], + 'HomeDirPath' => [ + 'description' => '每个用户的用户目录主路径。', + 'type' => 'string', + 'example' => '/home', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"Acl\\": {\\n \\"EnableAnonymousAccess\\": true,\\n \\"Enabled\\": true,\\n \\"EncryptData\\": true,\\n \\"RejectUnencryptedAccess\\": true,\\n \\"SuperAdminSid\\": \\"S-1-0-0\\",\\n \\"HomeDirPath\\": \\"/home\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSmbAclResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n <Acl>\\n <AuthMethod>Kerberos</AuthMethod>\\n <EnableAnonymousAccess>true</EnableAnonymousAccess>\\n <Enabled>true</Enabled>\\n <EncryptData>true</EncryptData>\\n <RejectUnencryptedAccess>true</RejectUnencryptedAccess>\\n <SuperAdminSid>S-1-0-0</SuperAdminSid>\\n <HomeDirPath>/home</HomeDirPath>\\n </Acl>\\n</DescribeSmbAclResponse>","errorExample":""}]', + 'title' => '查看SMB AD ACL', + ], + 'CreateFile' => [ + 'summary' => '创建目录或者文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '137907', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '为特殊用户使用API', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ca404****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '指定目录或文件的绝对路径，必须以正斜线（/）开头和结尾，长度为2~1024。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/test/', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '对象类型。取值：'."\n" + ."\n" + .'- File：文件。'."\n" + .'- Directory：目录。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'File', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '便携账号ID。'."\n" + .'限制：长度16位字符串，支持数字和英文小写字母。', + 'type' => 'string', + 'required' => false, + 'example' => '378cc7630f26****', + ], + ], + [ + 'name' => 'OwnerAccessInheritable', + 'in' => 'query', + 'schema' => [ + 'description' => '共享目录文件。'."\n" + .'取值：'."\n" + .'- false（默认值）：不共享目录权限。'."\n" + .'- true：共享目录权限。'."\n" + .'> - 当Type=Directory并且Owner不为空时，该参数生效。'."\n" + .'> - 目录带有可继承的Owner权限。该目录下创建的子目录和子文件，即使是其他人创建的，这个Owner都具有读写权限。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateFileResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n</CreateFileResponse>","errorExample":""}]', + 'title' => '创建目录或者文件', + 'description' => '- 该接口只对部分用户开放。'."\n" + ."\n" + .'- 仅支持通用型NAS并且已开启访问控制的SMB协议类型文件系统。', + ], + 'EnableNfsAcl' => [ + 'summary' => '开启NFS ACL功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13967', + 'abilityTreeNodes' => [ + 'FEATUREnasWJVZ38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '43f264xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '29F4F360-A6A8-561A-A45B-A0F6882969BA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29F4F360-A6A8-561A-A45B-A0F6882969BA\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableNfsAclResponse>\\n <RequestId>29F4F360-A6A8-561A-A45B-A0F6882969BA</RequestId>\\n</EnableNfsAclResponse>","errorExample":""}]', + 'title' => '打开NFS ACL功能', + 'description' => '仅通用型NAS NFS协议文件系统支持该功能。', + ], + 'DisableNfsAcl' => [ + 'summary' => '关闭NFS ACL功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '13965', + 'abilityTreeNodes' => [ + 'FEATUREnasWJVZ38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '91fcdxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '24487C24-AE54-57EC-B4E4-4EDEEEB83B01', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24487C24-AE54-57EC-B4E4-4EDEEEB83B01\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableNfsAclResponse>\\n <RequestId>24487C24-AE54-57EC-B4E4-4EDEEEB83B01</RequestId>\\n</DisableNfsAclResponse>","errorExample":""}]', + 'title' => '关闭NFS ACL功能', + 'description' => '仅通用型NAS NFS协议文件系统支持该功能。', + ], + 'DescribeNfsAcl' => [ + 'summary' => '查询指定文件系统是否启用了NFS ACL功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13958', + 'abilityTreeNodes' => [ + 'FEATUREnasWJVZ38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '206614xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A1098673-1746-505E-A5F1-08527B7EDBDF', + ], + 'Acl' => [ + 'description' => 'ACL信息。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否启用了NFS ACL功能。'."\n" + ."\n" + .'- true：启用了NFS ACL功能。'."\n" + ."\n" + .'- false：未启用NFS ACL功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1098673-1746-505E-A5F1-08527B7EDBDF\\",\\n \\"Acl\\": {\\n \\"Enabled\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeNfsAclResponse>\\n <RequestId>A1098673-1746-505E-A5F1-08527B7EDBDF</RequestId>\\n <Acl>\\n <Enabled>true</Enabled>\\n </Acl>\\n</DescribeNfsAclResponse>","errorExample":""}]', + 'title' => '查询NFS ACL', + 'description' => '仅通用型NAS NFS协议文件系统支持该功能。', + ], + 'CreateLogAnalysis' => [ + 'summary' => '将通用型NAS文件系统日志转储到日志服务中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13933', + 'abilityTreeNodes' => [ + 'FEATUREnasA0C6YC', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174494xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5B4511A7-C99E-4071-AA8C-32E2529DA963', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SubAccount.NoLogSLRPermission', + 'errorMessage' => 'The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasLogDelivery. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.', + ], + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'The API operation does not support the file system type.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B4511A7-C99E-4071-AA8C-32E2529DA963\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLogAnalysisResponse>\\n <RequestId>5B4511A7-C99E-4071-AA8C-32E2529DA963</RequestId>\\n</CreateLogAnalysisResponse>","errorExample":""}]', + 'title' => '创建日志管理的日志模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLogAnalysis' => [ + 'summary' => '停止通用型NAS文件系统的日志转储。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13942', + 'abilityTreeNodes' => [ + 'FEATUREnas0MLWQI', + 'FEATUREnas3DACY7', + 'FEATUREnas71NBOZ', + 'FEATUREnasA0C6YC', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174494xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70EACC9C-D07A-4A34-ADA4-77506C42B023', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70EACC9C-D07A-4A34-ADA4-77506C42B023\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLogAnalysisResponse>\\n <RequestId>70EACC9C-D07A-4A34-ADA4-77506C42B023</RequestId>\\n</DeleteLogAnalysisResponse>","errorExample":""}]', + 'title' => '删除日志管理的日志', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogAnalysis' => [ + 'summary' => '列出日志分析中配置的日志转储信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13955', + 'abilityTreeNodes' => [ + 'FEATUREnasA0C6YC', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每个分页包含的文件系统个数。'."\n" + .'取值范围：1~100'."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统列表的分页页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- standard：通用型NAS'."\n" + .'- extreme：极速型NAS'."\n" + .'- all（默认值）：所有类型', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'default' => 'all', + 'enum' => [ + 'all', + 'standard', + 'extreme', + 'bmcpfs', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '该地域日志转储信息总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '每个分页包含的日志转储信息数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C84F77AF-3DE5-48F1-B19B-37FCBE24****', + ], + 'PageNumber' => [ + 'description' => '日志转储信息的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Analyses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Analysis' => [ + 'description' => '日志转储信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetaKey' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '0c7154xxxx', + ], + 'MetaValue' => [ + 'description' => '指定文件系统对应的日志转储信息。', + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'description' => 'NAS访问日志服务所使用的角色。', + 'type' => 'string', + 'example' => 'acs:ram::162165525211xxxx:role/aliyunnaslogarchiverole', + ], + 'Region' => [ + 'description' => '文件系统操作日志专属Logstore所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Logstore' => [ + 'description' => '用于存储NAS操作日志的专属Logstore名称。', + 'type' => 'string', + 'example' => 'nas-nfs', + ], + 'Project' => [ + 'description' => '文件系统操作日志专属Logstore所在的Project名称。', + 'type' => 'string', + 'example' => 'nas-1746495857602745-cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"C84F77AF-3DE5-48F1-B19B-37FCBE24****\\",\\n \\"PageNumber\\": 1,\\n \\"Analyses\\": {\\n \\"Analysis\\": [\\n {\\n \\"MetaKey\\": \\"0c7154xxxx\\",\\n \\"MetaValue\\": {\\n \\"RoleArn\\": \\"acs:ram::162165525211xxxx:role/aliyunnaslogarchiverole\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Logstore\\": \\"nas-nfs\\",\\n \\"Project\\": \\"nas-1746495857602745-cn-hangzhou\\"\\n }\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLogAnalysisResponse>\\n <TotalCount>10</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>C84F77AF-3DE5-48F1-B19B-37FCBE24****</RequestId>\\n <PageNumber>1</PageNumber>\\n <Analyses>\\n <MetaKey>0c7154xxxx</MetaKey>\\n <MetaValue>\\n <RoleArn>acs:ram::162165525211xxxx:role/aliyunnaslogarchiverole</RoleArn>\\n <Region>cn-hangzhou</Region>\\n <Logstore>nas-nfs</Logstore>\\n <Project>nas-1746495857602745-cn-hangzhou</Project>\\n </MetaValue>\\n </Analyses>\\n <Code>200</Code>\\n</DescribeLogAnalysisResponse>","errorExample":""}]', + 'title' => '获取日志管理的日志信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateFileset' => [ + 'summary' => '创建一个Fileset。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55589', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + 'FEATUREnasXEQXVN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-099394bd928c****。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-290w65p03ok64y*****', + ], + ], + [ + 'name' => 'FileSystemPath', + 'in' => 'query', + 'schema' => [ + 'description' => '待创建的Fileset的绝对路径。'."\n" + ."\n" + .'- CPFS路径限制。'."\n" + .' - 指定目录的父目录必须是文件系统中已存在的目录。'."\n" + .' - 长度为2~1024个字符。'."\n" + .' - 指定目录必须以正斜线（/）开头和结尾。'."\n" + .' - CPFS智算版路径限制。'."\n" + .' - 长度为2~1024个字符。'."\n" + .' - 指定目录必须以正斜线（/）开头和结尾。'."\n" + .' - Fileset路径必须为新路径，不能为已存在路径，Fileset 路径不支持重命名，不支持路径为软链接。'."\n" + .' - Fileset路径支持的最大深度为8层，根目录/为0层。例如，Fileset路径为/test/aaa/ccc/，则表示路径深度为3层。'."\n" + .' - Fileset路径为多层目录时，父目录必须是已存在的目录。'."\n" + .' - 不支持在 Fileset 中嵌套 Fileset，即当父目录已指定为Fileset，其子目录不支持指定为Fileset。一个 Fileset 路径只支持一个配额。'."\n" + .' - 路径总长度最多为990个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/test/', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FsetId为空。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => '实例释放保护属性，指定是否支持通过控制台或API（[DeleteFileset](~~2402263~~)）释放实例。'."\n" + ."\n" + .'- true：开启实例释放保护。'."\n" + .'- false（默认）：关闭实例释放保护。'."\n" + ."\n" + .'> 该属性只能限制手动释放操作，对系统释放操作不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'Fileset的描述信息。'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以http://和https://开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => '内部事务目录', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-4266554*****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Quota', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '配额信息。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持此参数。', + 'type' => 'object', + 'properties' => [ + 'FileCountLimit' => [ + 'description' => '配额文件数量限制。取值范围：'."\n" + ."\n" + .'- 最小值：10,000。'."\n" + ."\n" + .'- 最大值：10,000,000,000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + 'SizeLimit' => [ + 'description' => '配额总容量限制。单位：Byte。'."\n" + ."\n" + .'取值范围：'."\n" + ."\n" + .'- 最小值：10,737,418,240（10 GiB）。'."\n" + ."\n" + .'- 步长：107,3741,824（1 GiB）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10737418240', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'FsetId' => [ + 'description' => 'Fileset ID。', + 'type' => 'string', + 'example' => 'fset-1902718ea0ae****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFileSystemPath', + 'errorMessage' => 'FileSystemPath is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem type.', + ], + [ + 'errorCode' => 'InvalidFilesystemVersion.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem version.', + ], + [ + 'errorCode' => 'InvalidRequest', + 'errorMessage' => 'The request is invalid.', + ], + [ + 'errorCode' => 'Quota.Invalid.Limit', + 'errorMessage' => 'Quota limit is invalid.', + ], + [ + 'errorCode' => 'Resource.Exceed.Limit', + 'errorMessage' => 'Resource exceed limit.', + ], + [ + 'errorCode' => 'Resource.Check.Fail', + 'errorMessage' => 'Resource check failed.', + ], + [ + 'errorCode' => 'Fileset.Path.Duplicate', + 'errorMessage' => 'Fileset path is duplicate.', + ], + [ + 'errorCode' => 'Fileset.Path.Nested', + 'errorMessage' => 'Fileset path is nested.', + ], + [ + 'errorCode' => 'Fileset.Path.NotExist', + 'errorMessage' => 'Fileset.Path.Not.Exist.', + ], + [ + 'errorCode' => 'Fileset.Path.Exist', + 'errorMessage' => 'Fileset already exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.AlreadyExists', + 'errorMessage' => 'The operation is denied due to IdirName already exists in parent path.', + ], + [ + 'errorCode' => 'OperationDenied.TooManyFilesets', + 'errorMessage' => 'The operation is denied due to too many fileset in filesystem.', + ], + [ + 'errorCode' => 'OperationDenied.TooManyDepths', + 'errorMessage' => 'The operation is denied due to Fileset path too deep.', + ], + [ + 'errorCode' => 'OperationDenied.NestedDir', + 'errorMessage' => 'The operation is denied due to nested directory.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.FilesetNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystemPath.ParentNotFound', + 'errorMessage' => 'The specified parent path does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystemPath.NotDirectory', + 'errorMessage' => 'The specified idir parent path is not directory.', + ], + [ + 'errorCode' => 'InvalidFileSystemPath.InvalidCharacters', + 'errorMessage' => 'The specified fileset path contains invalid characters.', + ], + [ + 'errorCode' => 'InvalidFilesetPath.InvalidParameter', + 'errorMessage' => 'Fileset path is invalid.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"FsetId\\": \\"fset-1902718ea0ae****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateFilesetResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n <FsetId>fset-1902718ea0ae****</FsetId>\\n</CreateFilesetResponse>","errorExample":""}]', + 'title' => '创建文件集', + 'description' => '- CPFS使用说明'."\n" + ."\n" + .' - 仅支持CPFS 2.2.0及以上版本创建Fileset。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .' - 单个CPFS文件系统最多支持创建10个Fileset。'."\n" + .' - 父目录必须是已存在的目录。'."\n" + .' - Fileset路径支持的最大深度为8层，根目录/为0层。例如，Fileset路径为/test/aaa/ccc/，则表示路径深度为3层。'."\n" + .' - 不支持Fileset中嵌套Fileset。即当父目录已指定为Fileset，其子目录不支持指定为Fileset。'."\n" + .' - Fileset最多支持100万个文件，如果文件数量超过此上限，添加新文件会返回`no space`错误信息。'."\n" + ."\n" + .'- CPFS智算版使用说明'."\n" + .' - 仅支持CPFS智算版 2.7.0及以上版本创建Fileset。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .' - 单个CPFS文件系统最多支持创建500个Fileset。'."\n" + .' - Fileset路径必须为新路径，不能为已存在路径，Fileset 路径不支持重命名，不支持路径为软链接。'."\n" + .' - Fileset路径支持的最大深度为8层，根目录/为0层。例如，Fileset路径为/test/aaa/ccc/，则表示路径深度为3层。'."\n" + .' - Fileset路径为多层目录时，父目录必须是已存在的目录。'."\n" + .' - 不支持在 Fileset 中嵌套 Fileset，即当父目录已指定为Fileset，其子目录不支持指定为Fileset。一个 Fileset 路径只支持一个配额。'."\n" + .' - Fileset容量配额，最小起步10 GiB，扩容单位为1 GiB。'."\n" + .' - Fileset最多支持100亿个文件或目录，最小起步10000，扩容单位为1。'."\n" + .' - 修改目录配额时，设置的配额容量或文件数必须高于已使用容量或文件数。'."\n" + .' - 配额的统计有15分钟的延迟，当前的实际使用量15分钟之后才会生效。', + ], + 'DeleteFileset' => [ + 'summary' => '删除一个Fileset。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55630', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-099394bd928c****。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + ], + [ + 'name' => 'FsetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fileset ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fset-1902718ea0ae****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次删除请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际删除实例。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode。'."\n" + ."\n" + .'- false（默认）：发送正常请求，通过检查后直接删除实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFsetId', + 'errorMessage' => 'FsetId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesetId.NotFound', + 'errorMessage' => 'Invalid FilesetId.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.FilesetNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + [ + 'errorCode' => 'InvalidOperation.DeletionProtection', + 'errorMessage' => 'The operation is not allowed due to resource is protected by deletion protection.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFsetId.NotFound', + 'errorMessage' => 'The specified Fileset ID does not exist.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttling.Api', + 'errorMessage' => 'Request was denied due to api flow control.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFilesetResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n</DeleteFilesetResponse>","errorExample":""}]', + 'title' => '删除文件集', + 'description' => '- 仅支持CPFS 2.2.0和CPFS智算版2.7.0及以上版本删除Fileset。删除后，目录中的数据也会被全部删除且无法恢复，请谨慎删除。'."\n" + .'- 如果开启了删除保护功能，需要先关闭删除保护，才能进行删除操作。'."\n" + .'- 直接删除CPFS智算版 Fileset不会立即释放空间，会有24小时回收。如果您需要立即释放空间，可先清空Fileset下的数据，再删除Fileset。数据被删除后无法恢复，请谨慎删除。', + ], + 'ModifyFileset' => [ + 'summary' => '修改一个Fileset信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55631', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-099394bd928c****。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + ], + [ + 'name' => 'FsetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fileset ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fset-1902718ea0ae****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'Fileset的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次修改请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际修改实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会修改实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接修改实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例释放保护属性，指定是否支持通过控制台或API（[DeleteFileset](~~2402263~~)）释放实例。'."\n" + ."\n\n" + ."\n" + .'- true：开启实例释放保护。'."\n" + .'- false：关闭实例释放保护。'."\n" + ."\n" + .'> 该属性只能限制手动释放操作，对系统释放操作不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFsetId', + 'errorMessage' => 'FsetId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesetId.NotFound', + 'errorMessage' => 'Invalid FilesetId.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.FilesetNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFsetId.NotFound', + 'errorMessage' => 'The specified Fileset ID does not exist.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyFilesetResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n</ModifyFilesetResponse>","errorExample":""}]', + 'title' => '修改文件集', + 'description' => '仅支持CPFS 2.2.0和CPFS智算版2.7.0及以上版本修改Fileset信息。', + ], + 'GetFileset' => [ + 'summary' => '查询创建的Fileset信息。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'FsetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fileset ID。'."\n" + .'> 当文件系统类型为CPFS时，该参数必填。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fset-1902718ea0ae****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'Fileset的描述信息。', + 'type' => 'string', + 'example' => 'Description', + ], + 'FileSystemPath' => [ + 'description' => 'Fileset在CPFS文件系统中的路径。', + 'type' => 'string', + 'example' => 'pathtoroot/fset/', + ], + 'FsetId' => [ + 'description' => 'Fileset ID。'."\n" + .'> 当文件系统类型为CPFS时，该参数必填。', + 'type' => 'string', + 'example' => 'fset-03250e8fe78d****', + ], + 'Status' => [ + 'description' => 'Fileset的状态。包括：'."\n" + ."\n" + .'- CREATING：正在创建Fileset。'."\n" + .'- CREATED：Fileset已创建完成，正常运行中。 '."\n" + .'- RELEASING：Fileset正在释放中。'."\n" + .'- RELEASED：Fileset已删除。', + 'type' => 'string', + 'example' => 'CREATED', + ], + 'CreateTime' => [ + 'description' => 'Fileset的创建时间。'."\n" + ."\n" + .'返回格式：`yyyy-MM-dd HH:mm:ss`', + 'type' => 'string', + 'example' => '2025-11-21 12:49:25', + ], + 'UpdateTime' => [ + 'description' => 'Fileset的最近一次更新时间。'."\n" + ."\n" + .'返回格式：`yyyy-MM-dd HH:mm:ss`', + 'type' => 'string', + 'example' => '2025-11-22 12:49:25', + ], + 'DeletionProtection' => [ + 'description' => '实例释放保护属性，指定是否支持通过控制台或API（[DeleteFileset](~~2402263~~)）释放实例。'."\n" + ."\n" + .'- true：开启实例释放保护。'."\n" + .'- false（默认）：关闭实例释放保护。'."\n" + ."\n" + .'> 该属性只能限制手动释放操作，对系统释放操作不生效。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FileCountUsage' => [ + 'description' => '文件数量使用量。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'SpaceUsage' => [ + 'description' => '容量使用量。单位：Byte。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'Quota' => [ + 'description' => '配额信息。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持此参数。', + 'type' => 'object', + 'properties' => [ + 'SizeLimit' => [ + 'description' => '配额总容量限制。单位：Byte。'."\n" + ."\n" + .'取值范围：'."\n" + ."\n" + .'- 最小值：10,737,418,240（10 GiB）。'."\n" + ."\n" + .'- 步长：1,073,741,824（1 GiB）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10,737,418,240', + ], + 'FileCountLimit' => [ + 'description' => '配额文件数量限制。取值范围：'."\n" + ."\n" + .'- 最小值：10,000。'."\n" + ."\n" + .'- 最大值：10,000,000,000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + ], + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'example' => 'cpfs-0244729a8ef8****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.FilesetNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified filesystem does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"Data\\": {\\n \\"Description\\": \\"Description\\",\\n \\"FileSystemPath\\": \\"pathtoroot/fset/\\",\\n \\"FsetId\\": \\"fset-03250e8fe78d****\\",\\n \\"Status\\": \\"CREATED\\",\\n \\"CreateTime\\": \\"2025-11-21 12:49:25\\",\\n \\"UpdateTime\\": \\"2025-11-22 12:49:25\\",\\n \\"DeletionProtection\\": false,\\n \\"FileCountUsage\\": 1024,\\n \\"SpaceUsage\\": 1024,\\n \\"Quota\\": {\\n \\"SizeLimit\\": 0,\\n \\"FileCountLimit\\": 10001\\n },\\n \\"FileSystemId\\": \\"cpfs-0244729a8ef8****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询文件集信息', + 'description' => '仅CPFS 2.2.0和CPFS智算版2.7.0及以上版本支持Fileset。您可以在控制台文件系统详情页面查看版本信息。', + ], + 'DescribeFilesets' => [ + 'summary' => '查询已创建的Fileset列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55590', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-099394bd928c****。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待查询Fileset的筛选键信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '筛选键的名称。取值：'."\n" + ."\n" + .'- FsetIds：根据Fileset ID筛选。'."\n" + .'- FileSystemPath：根据Fileset在CPFS文件系统中的路径筛选。'."\n" + .'- Description：根据Fileset的描述筛选。'."\n" + .'- QuotaExists: 根据Quota是否存在进行筛选。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持QuotaExists参数进行筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'FsetIds', + 'enum' => [ + 'FsetIds', + 'FileSystemPath', + 'Description', + 'QuotaExists', + ], + ], + 'Value' => [ + 'description' => '筛选键的值。该参数不支持通配符。'."\n" + ."\n" + .'- 当Key取值为FsetIds时，Value取值为Fileset ID。可以是一个或一组Fileset ID，Fileset ID最多可设置10个，多个值使用英文逗号分隔。例如，`fset-1902718ea0ae****`或`fset-1902718ea0ae****,fset-3212718ea0ae****`。'."\n" + .'- 当Key取值为FileSystemPath时，Value取值为Fileset在CPFS文件系统中的路径或路径的一部分。长度为2~1024个英文或中文字符。请您使用UTF-8编码。'."\n" + .'- 当Key取值为Description时，Value取值为Fileset的描述或描述的一部分。'."\n" + .'- 当Key取值为QuotaExists时，Value取值为true或false，不填写则返回所有的Fileset。', + 'type' => 'string', + 'required' => false, + 'example' => 'fset-1902718ea0ae****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询结果的个数。'."\n" + ."\n" + .'取值范围：10~100。默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'OrderByField', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。'."\n" + ."\n" + .'- FileCountLimit：配额文件数量限制。'."\n" + .'- SizeLimit：配额容量限制。'."\n" + .'- FileCountUsage：文件数量使用量。'."\n" + .'- SpaceUsage：容量使用量。', + 'type' => 'string', + 'required' => false, + 'example' => 'FileCountLimit', + 'enum' => [ + 'SpaceUsage', + 'FileCountUsage', + 'SizeLimit', + 'FileCountLimit', + ], + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。'."\n" + ."\n" + .'- asc（默认值）： 升序，指定排序按照从小到大的顺序进行。'."\n" + .'- desc：降序， 指定排序按照从大到小的顺序进行。'."\n" + .'> 当填写OrderByField参数后，此字段生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + 'NextToken' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-099394bd928c****。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + 'Entries' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Entrie' => [ + 'description' => 'Fileset信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息集合。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'Fileset的描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'FileSystemPath' => [ + 'description' => 'Fileset的路径。', + 'type' => 'string', + 'example' => 'pathtoroot/fset', + ], + 'FsetId' => [ + 'description' => 'Fileset ID。', + 'type' => 'string', + 'example' => 'fset-1902718ea0ae****', + ], + 'Status' => [ + 'description' => 'Fileset的状态。包括：'."\n" + ."\n" + .'- CREATING：正在创建Fileset。'."\n" + .'- CREATED：Fileset已创建完成，正常运行中。 '."\n" + .'- RELEASING：Fileset正在释放中。'."\n" + .'- RELEASED：Fileset已删除。', + 'type' => 'string', + 'example' => 'CREATED', + ], + 'CreateTime' => [ + 'description' => 'Fileset的创建时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'example' => '2021-09-30T10:08:08Z', + ], + 'UpdateTime' => [ + 'description' => 'Fileset的最近一次更新时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-09-30T10:08:08Z', + ], + 'DeletionProtection' => [ + 'description' => '实例释放保护属性，指定是否支持通过控制台或API（[DeleteFileset](~~2402263~~)）释放实例。'."\n" + ."\n" + .'- true：开启实例释放保护。'."\n" + .'- false：关闭实例释放保护。'."\n" + ."\n" + .'> 该属性只能限制手动释放操作，对系统释放操作不生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FileCountUsage' => [ + 'description' => '文件数量使用量。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'SpaceUsage' => [ + 'description' => '容量使用量。单位：Byte。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'Quota' => [ + 'description' => '配额信息。'."\n" + .'> 仅CPFS智算版2.7.0及以上版本支持此参数。', + 'type' => 'object', + 'properties' => [ + 'SizeLimit' => [ + 'description' => '配额容量限制。单位：Byte。'."\n" + ."\n" + .' - 最小值：10,737,418,240（10 GiB）。'."\n" + ."\n" + .' - 步长：1,073,741,824（1 GiB）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10737418240', + ], + 'FileCountLimit' => [ + 'description' => '配额文件数量限制。'."\n" + .'取值范围：'."\n" + ."\n" + .' - 最小值：10,000。'."\n" + ."\n" + .' - 最大值：10,000,000,000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-099394bd928c****。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidParameter.SortOrder', + 'errorMessage' => 'Invalid sort order.', + ], + [ + 'errorCode' => 'InvalidParameter.SortOrderField', + 'errorMessage' => 'Invalid sort order field.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.FilesetNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'The specified Filter.N.Key is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterValue', + 'errorMessage' => 'The specified Filter.N.Value is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invaild.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidMaxResults', + 'errorMessage' => 'The specified MaxResults is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\",\\n \\"NextToken\\": \\"TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=\\",\\n \\"FileSystemId\\": \\"bmcpfs-290w65p03ok64ya****\\",\\n \\"Entries\\": {\\n \\"Entrie\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"FileSystemPath\\": \\"pathtoroot/fset\\",\\n \\"FsetId\\": \\"fset-1902718ea0ae****\\",\\n \\"Status\\": \\"CREATED\\",\\n \\"CreateTime\\": \\"2021-09-30T10:08:08Z\\",\\n \\"UpdateTime\\": \\"2021-09-30T10:08:08Z\\",\\n \\"DeletionProtection\\": true,\\n \\"FileCountUsage\\": 1024,\\n \\"SpaceUsage\\": 1024,\\n \\"Quota\\": {\\n \\"SizeLimit\\": 10737418240,\\n \\"FileCountLimit\\": 10000\\n },\\n \\"FileSystemId\\": \\"bmcpfs-290w65p03ok64ya****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询文件集列表', + 'description' => '- 仅CPFS 2.2.0和CPFS智算版2.7.0及以上版本支持Fileset。您可以在控制台文件系统详情页面查看版本信息。'."\n" + ."\n" + .'- 筛选键（Filters）中，FsetIds需要做全字匹配，FileSystemPath、Description支持模糊匹配。'."\n" + .'- 支持组合查询。', + ], + 'SetFilesetQuota' => [ + 'summary' => '设置文件集配额。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238301', + 'abilityTreeNodes' => [ + 'FEATUREnasXEQXVN', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '特殊用户支持的API', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPFS智算版文件系统ID。必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + ], + [ + 'name' => 'FsetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fileset ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fset-1902718ea0ae****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次删除请求执行预检。'."\n" + .'预检操作会帮助您检查参数有效性、依赖条件等，并不会实际删除实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会删除导出目录。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200HttpCode。'."\n" + ."\n" + .'- false（默认）：发送正常请求，通过检查后直接删除实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'FileCountLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Quota文件数量限制。取值范围：'."\n" + ."\n" + .'- 最小值：10,000。'."\n" + ."\n" + .'- 最大值：10,000,000,000。'."\n" + ."\n" + .'> 该参数不填代表文件数量无限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'SizeLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Quota 总容量限制。单位：Byte。'."\n" + ."\n" + .'取值范围：'."\n" + ."\n" + .'- 最小值：10,737,418,240（10 GiB）。'."\n" + ."\n" + .'- 步长：1,073,741,824（1 GiB）。'."\n" + ."\n" + .'> 该参数不填代表容量无限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10737418240', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFsetId', + 'errorMessage' => 'FsetId is mandatory for this action.', + ], + [ + 'errorCode' => 'Quota.Invalid.Limit', + 'errorMessage' => 'Quota limit is invalid.', + ], + [ + 'errorCode' => 'Quota.Exceed.Limit', + 'errorMessage' => 'Quota exceed limit.', + ], + [ + 'errorCode' => 'InvalidFilesetId.NotFound', + 'errorMessage' => 'Invalid FilesetId.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.FilesetNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFsetId.NotFound', + 'errorMessage' => 'The specified Fileset ID does not exist.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttling.Api', + 'errorMessage' => 'Request was denied due to api flow control.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","type":"json"}]', + 'title' => '为文件集设置配额', + 'description' => '- 仅CPFS智算版2.7.0及以上版本支持为文件集设置配额。'."\n" + .'- Fileset容量配额，最小起步10 GiB，扩容单位为1 GiB。'."\n" + .'- Fileset最多支持100亿个文件或目录，最小起步10000，扩容单位为1。'."\n" + .'- 修改目录配额时，设置的配额容量或文件数必须高于已使用容量或文件数。'."\n" + .'- 容量限制和文件数限制至少填写其中一项。'."\n" + .'- 配额的统计有15分钟的延迟，当前的实际使用量15分钟之后才会生效。', + ], + 'CancelFilesetQuota' => [ + 'summary' => '取消文件集设置的配额。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238649', + 'abilityTreeNodes' => [ + 'FEATUREnasXEQXVN', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '为特殊用户使用API', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPFS智算版文件系统ID。必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + ], + [ + 'name' => 'FsetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fileset ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fset-1902718ea0ae****'."\n", + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建数据流动。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但DataFlowld为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFsetId', + 'errorMessage' => 'FsetId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesetId.NotFound', + 'errorMessage' => 'Invalid FilesetId.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.FilesetNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFsetId.NotFound', + 'errorMessage' => 'The specified Fileset ID does not exist.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttling.Api', + 'errorMessage' => 'Request was denied due to api flow control.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\\\n\\"\\n}","type":"json"}]', + 'title' => '为文件集取消配额', + 'description' => '仅CPFS智算版2.7.0及以上版本支持取消配额。', + ], + 'CreateDataFlow' => [ + 'summary' => '创建一个CPFS通用版或CPFS智算版文件系统与源端存储的数据流动。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '49006', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS通用版：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'FsetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fileset ID。'."\n" + .'> 当文件系统类型为CPFS通用版时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'fset-1902718ea0ae****', + ], + ], + [ + 'name' => 'SourceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '源端存储的访问地址。格式：`<storage type>://[<account id>:]<path>`。'."\n" + ."\n" + .'其中：'."\n" + ."\n" + .'- storage type：目前只支持oss。'."\n" + .'- account id：可选参数，源端存储所属账号的UID。使用跨账号的OSS时，该参数必填。'."\n" + .'- path：OSS的Bucket名称。限制如下。'."\n" + ."\n" + .' - 仅支持小写字母、数字和短划线（-）且必须以小写字母或者数字开头和结尾。'."\n" + ."\n" + .' - 最长为128个字符。'."\n" + ."\n" + .' - 使用UTF-8编码。'."\n" + ."\n" + .'> - OSS Bucket必须为在该地域已存在的Bucket。'."\n" + .'> - 仅CPFS智算版2.6.0及以上版本支持 account id 参数。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://178321033379****:bucket-01', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'SourceSecurityType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '源端存储的安全保护类型，如果源端存储必须通过安全保护访问，请指定源端存储的安全保护类型。取值：'."\n" + ."\n" + .'- 无（默认值）：表示源端存储不需要通过安全保护方式访问。'."\n" + .'- SSL：通过SSL证书保护访问。', + 'type' => 'string', + 'required' => false, + 'example' => 'SSL', + ], + ], + [ + 'name' => 'Throughput', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动的传输带宽上限，单位：MB/s 。取值： '."\n" + ."\n" + .'- 600'."\n" + .'- 1200'."\n" + .'- 1500'."\n" + ."\n" + .'> 数据流动的传输带宽必须小于文件系统的IO带宽。'."\n" + .'> 当文件系统类型为CPFS通用版时，该参数必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '600', + 'enum' => [ + '600', + '1200', + '1500', + '2000', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据流动的描述。 '."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Bucket01 DataFlow', + ], + ], + [ + 'name' => 'AutoRefreshs', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '自动更新配置信息集合。'."\n" + .'> 当文件系统类型为CPFS通用版时，本参数生效。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshPath' => [ + 'description' => '自动更新目录，CPFS通用版注册源端存储的数据修改事件，检查该目录下的源端数据是否发生更新并自动导入更新的数据。'."\n" + ."\n" + .'默认为空，源端存储的任何数据更新不会自动导入 CPFS通用版，需要通过手动任务导入更新。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~1024个字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以正斜线（/）开头和结尾。'."\n" + .'- 该目录必须是CPFS通用版上的已有目录，且必须位于该数据流动的Fileset目录中。', + 'type' => 'string', + 'required' => false, + 'example' => '/prefix1/prefix2/', + 'maxLength' => 1024, + 'minLength' => 2, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'AutoRefreshPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '自动更新策略，源端数据更新以后，数据更新导入到CPFS通用版的策略。'."\n" + ."\n" + .'- None（默认值）：源端的数据更新不自动导入CPFS通用版，用户可通过数据流动任务导入源端的数据更新。'."\n" + .'- ImportChanged：源端的数据更新自动导入CPFS通用版。'."\n" + .'> 当文件系统类型为CPFS通用版时，本参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'None', + 'enum' => [ + 'None', + 'ImportChanged', + ], + ], + ], + [ + 'name' => 'AutoRefreshInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '自动更新间隔时间，每隔该时间间隔，CPFS通用版检查目录内是否存在数据更新，如果有数据更新，启动自动更新任务，单位：分钟。'."\n" + ."\n" + .'取值范围：10~525600，默认值：10。'."\n" + .'> 当文件系统类型为CPFS通用版时，本参数生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '525600', + 'minimum' => '5', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'SourceStoragePath', + 'in' => 'query', + 'schema' => [ + 'title' => '源端存储内的访问路径。', + 'description' => '源端存储Bucket内的访问路径。限制如下。'."\n" + ."\n" + .' - 必须以/开头和结尾。'."\n" + ."\n" + .'- 区分大小写。'."\n" + ."\n" + .'- 长度为1~1023个字符之间。'."\n" + ."\n" + .'- 使用UTF-8编码。'."\n" + ."\n" + .'> 当文件系统类型为CPFS智算版时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '/prefix/', + 'maxLength' => 1023, + 'minLength' => 1, + ], + ], + [ + 'name' => 'FileSystemPath', + 'in' => 'query', + 'schema' => [ + 'title' => 'CPFS文件系统内的目录。', + 'description' => 'CPFS智算版文件系统内的目录。限制如下。'."\n" + .'- 必须以/开头和结尾。'."\n" + ."\n" + .'- 该目录必须是CPFS智算版上的已有目录。'."\n" + ."\n" + .'- 长度为1~1023个字符之间。'."\n" + ."\n" + .'- 使用UTF-8编码。'."\n" + ."\n" + .'> 当文件系统类型为CPFS智算版时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '/path/', + 'maxLength' => 1023, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0D****3E', + ], + 'DataFlowId' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'example' => 'df-194433a5be31****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFsetId', + 'errorMessage' => 'FsetId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingSourceStorage', + 'errorMessage' => 'SourceStorage is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingThroughput', + 'errorMessage' => 'Throughput is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesystemVersion.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem version.', + ], + [ + 'errorCode' => 'DataFlow.Bucket.RegionUnmatched', + 'errorMessage' => 'The bucket and file system are not in the same region.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.NoStock', + 'errorMessage' => 'The operation is denied due to no stock.', + ], + [ + 'errorCode' => 'OperationDenied.DependFset', + 'errorMessage' => 'The operation is denied due to invalid fileset state.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DependMountpoint', + 'errorMessage' => 'The operation is denied because no mount point is found.', + ], + [ + 'errorCode' => 'OperationDenied.FsetAlreadyInUse', + 'errorMessage' => 'The Fset is already bound to another data flow.', + ], + [ + 'errorCode' => 'OperationDenied.AutoRefreshNotSupport', + 'errorMessage' => 'The operation is denied. Auto refresh is not supported.', + ], + [ + 'errorCode' => 'OperationDenied.DependBucketTag', + 'errorMessage' => 'The operation is denied. The OSS Bucket tag cpfs-dataflow is missing.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + [ + 'errorCode' => 'InvalidOperation.DeletionProtection', + 'errorMessage' => 'The operation is not allowed due to resource is protected by deletion protection.', + ], + [ + 'errorCode' => 'DataFlow.Bucket.AccessDenied', + 'errorMessage' => 'Bucket access denied.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidThroughput.OutOfBounds', + 'errorMessage' => 'Throughput is out of bounds.', + ], + [ + 'errorCode' => 'InvalidDescription.InvalidFormat', + 'errorMessage' => 'Description format is invalid.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.InvalidParameter', + 'errorMessage' => 'Refresh path is invalid.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.Duplicated', + 'errorMessage' => 'Refresh path is duplicated.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.NotFound', + 'errorMessage' => 'Refresh path does not exist.', + ], + [ + 'errorCode' => 'InvalidRefreshPolicy.InvalidParameter', + 'errorMessage' => 'Refresh policy is invalid.', + ], + [ + 'errorCode' => 'InvalidRefreshInterval.OutOfBounds', + 'errorMessage' => 'Refresh interval is out of bounds.', + ], + [ + 'errorCode' => 'InvalidSourceStorage.Unreachable', + 'errorMessage' => 'Source storage cannot be accessed.', + ], + [ + 'errorCode' => 'InvalidSourceStorage.NotFound', + 'errorMessage' => 'Source storage is not found.', + ], + [ + 'errorCode' => 'InvalidSourceStorage.NotSupport', + 'errorMessage' => 'Source storage type is not supported.', + ], + [ + 'errorCode' => 'InvalidSourceStorage.PermissionDenied', + 'errorMessage' => 'The source storage access permission is denied.', + ], + [ + 'errorCode' => 'InvalidSourceStorage.InvalidRegion', + 'errorMessage' => 'Source storage region is invalid.', + ], + [ + 'errorCode' => 'InvalidSourceStorage.InvalidParameter', + 'errorMessage' => 'Source storage has invalid parameters.', + ], + [ + 'errorCode' => 'InvalidSourceSecurityType.NotSupport', + 'errorMessage' => 'The source security type is not supported.', + ], + [ + 'errorCode' => 'InvalidAutoRefresh.TooManyAutoRefreshes', + 'errorMessage' => 'The number of auto refreshes exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidSourceStorage.NeedVersioning', + 'errorMessage' => 'Source storage must enable versioning.', + ], + [ + 'errorCode' => 'InvalidFsetId.NotFound', + 'errorMessage' => 'The specified Fileset ID does not exist.', + ], + [ + 'errorCode' => 'DataFlow.Bucket.NotExist', + 'errorMessage' => 'Bucket does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0D****3E\\",\\n \\"DataFlowId\\": \\"df-194433a5be31****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDataFlowResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0D****3E</RequestId>\\n <DataFlowId>dfid-194433a5be31****</DataFlowId>\\n</CreateDataFlowResponse>","errorExample":""}]', + 'title' => '创建数据流动', + 'description' => '- 本接口适用于以下产品：'."\n" + ."\n" + .'| 产品 | 文件系统ID格式 | 支持数据流动的最低版本 |'."\n" + .'|------|----------------|------------------------|'."\n" + .'| **CPFS通用版** | 以 `cpfs-` 开头，例如 cpfs-125487**** | 2.2.0 及以上 |'."\n" + .'| **CPFS智算版** | 以 `bmcpfs-` 开头，例如 bmcpfs-0015**** | 2.4.0 及以上 |'."\n" + .'> ：CPFS通用版和CPFS智算版共用同一套API，但在参数取值和功能支持上有所区别。请根据您使用的产品类型参考相应章节。'."\n" + ."\n" + .'- 基础操作'."\n" + .' - CPFS通用版、CPFS智算版文件系统状态为运行中时，才能创建数据流动。'."\n" + .' - 一个CPFS通用版或CPFS智算版文件系统最多允许创建 **10 个**数据流动。'."\n" + .' - 创建数据流动一般耗时 2～5 分钟，您可通过 [DescribeDataFlows](~~336901~~) 检查数据流动创建是否完成。'."\n" + ."\n" + .'- 权限'."\n" + ."\n" + .' 创建数据流动时，文件存储CPFS会获取`AliyunServiceRoleForNasOssDataflow`和`AliyunServiceRoleForNasEventNotification`两个服务关联角色。更多信息，请参见[CPFS服务关联角色](~~185138~~)。'."\n" + ."\n" + .'- CPFS通用版使用说明'."\n" + ."\n" + .' 本章节适用于文件系统ID以 `cpfs-` 开头的CPFS通用版。'."\n" + .' - 计费'."\n" + ."\n" + .' - 创建数据流动将按照数据流动带宽计费。更多信息，请参见[CPFS通用版计费说明](~~111858~~)。'."\n" + .' - 使用自动更新（AutoRefresh）时，需要通过EventBridge收集源端OSS存储的对象修改事件，事件将产生费用。更多信息，请参见[EventBridge计费说明](~~163752~~)。'."\n" + ."\n" + .' - 数据流动规格'."\n" + .' - 数据流动带宽（Throughput）支持600 MB/s、1200 MB/s和1500 MB/s三种规格。数据流动带宽是指该数据流动进行导入或导出数据时能达到的最大传输带宽。'."\n" + .' - 创建一个数据流动，会消耗1个文件存储CPFS通用版挂载点使用的vSwitch IP地址，请您确保该vSwitch IP资源充足。'."\n" + .' - 库存查询：当设置DryRun为true时，可校验创建该规格的数据流动的资源是否满足。'."\n" + ."\n" + .' - Fileset'."\n" + .' - 数据流动的目的端是CPFS通用版文件系统中的Fileset。Fileset是CPFS通用版文件系统中一种新的目录树结构，是在父文件系统中的一个小型文件系统，拥有独立的inode空间和管理能力。'."\n" + .' - 创建数据流动时该Fileset必须已存在，且不能与其他Fileset嵌套。一个Fileset上只能创建一个数据流动，对应一个源端存储。'."\n" + .' - Fileset内的文件数量上限是100万，如果从OSS Bucket导入的文件数量超过上限，创建新文件会报错`no space`。'."\n" + .' > 如果Fileset中已存在数据，创建数据流动后，Fileset内的已有数据会被清空，替换为OSS端同步过来的数据。'."\n" + ."\n" + .' - 自动更新'."\n" + .' - 配置自动更新（AutoRefresh）后，当源端存储数据发生变化时，变化的元数据会自动同步到CPFS通用版文件系统，变化的数据会在用户访问文件时按需加载，或者启动数据流动任务加载数据。'."\n" + .' - 自动更新依赖EventBridge收集源端OSS存储的对象修改事件。需要先[开通EventBridge服务](~~182246~~)。'."\n" + .' - 自动更新的作用范围是prefix，由参数RefreshPath指定。一个数据流动最多可配置5个自动更新目录。'."\n" + .' - 自动更新间隔（AutoRefreshInterval）指CPFS通用版设置的自动更新时间，检查源端OSS Bucket该prefix内是否存在数据更新，如果有数据更新则启动自动更新任务。当OSS源端的对象修改事件频率超过CPFS通用版数据流动处理能力时，自动更新任务会堆积，元数据更新会延迟，数据流动的状态为`Misconfigured`，您可以提升数据流动规格，或者降低OSS修改频率来解决。'."\n" + .' - 在文件存储CPFS通用版数据流动对prefix配置自动更新时，会在用户侧创建事件总线，并创建源端OSS Bucket的prefix的事件规则。当源端OSS Bucket的prefix内发生对象修改后，会在EventBridge中产生OSS事件，由CPFS通用版数据流动处理。'."\n" + .' > 文件存储CPFS通用版在EventBridge创建的事件总线、事件规则带有`Create for cpfs auto refresh`的描述，事件总线、事件规则都不能修改或删除，否则自动更新无法正常工作。'."\n" + ."\n" + .' - 源端存储'."\n" + .' - 源端存储仅支持OSS。数据流动的源端存储（SourceStorage）必须是OSS Bucket。'."\n" + .' - CPFS通用版数据流动支持加密和非加密两种方式访问OSS。选择加密（SSL）方式访问OSS时，需确认OSS Bucket的传输加密支持加密访问方式。'."\n" + .' - 如果多个CPFS通用版的数据流动、或者同一个文件存储CPFS通用版的多个数据流动的源端存储是同一个OSS Bucket，为了防止多个文件存储CPFS通用版向同一个源导出数据产生数据冲突，需要该OSS Bucket开启版本控制。'."\n" + .' - 不支持跨地域的OSS数据流动，OSS Bucket必须与CPFS通用版文件系统在同一个地域。'."\n" + .' > 创建数据流动前，您需要先给源端OSS Bucket设置标签（key: cpfs-dataflow, value: true），以便CPFS通用版数据流动访问该Bucket的数据。在数据流动的使用过程中，不能删除和修改该标签，否则CPFS通用版数据流动无法访问Bucket的数据。'."\n" + ."\n" + .'- CPFS智算版使用说明'."\n" + ."\n" + .' 本章节适用于文件系统ID以 `bmcpfs-` 开头的CPFS智算版。'."\n" + ."\n" + .' - 源端存储'."\n" + .' - 源端存储仅支持OSS。数据流动的源端存储（SourceStorage）必须是OSS Bucket。'."\n" + .' - CPFS智算版数据流动支持加密和非加密两种方式访问OSS。选择加密（SSL）方式访问OSS时，需确认OSS Bucket的传输加密支持加密访问方式。'."\n" + .' - 如果多个CPFS智算版的数据流动、或者同一个CPFS智算版的多个数据流动的源端存储是同一个OSS Bucket，为了防止多个CPFS智算版向同一个源导出数据产生数据冲突，需要该OSS Bucket开启版本控制。'."\n" + .' - 不支持跨地域的OSS数据流动，OSS Bucket必须与CPFS智算版文件系统在同一个地域。'."\n" + .' - CPFS智算版2.6.0及以上版本支持使用跨账号OSS进行数据流动的创建。'."\n" + .' - 只有在使用跨账号的OSS时，需要设置account id参数。'."\n" + .' - 使用跨账号的OSS时，需要先进行账号授权。具体授权请参考[跨账号数据流动授权](~~2713462~~)。'."\n" + .' > 创建数据流动前，您需要先给源端OSS Bucket设置标签（key: cpfs-dataflow, value: true），以便CPFS智算版数据流动访问该Bucket的数据。在数据流动的使用过程中，不能删除和修改该标签，否则CPFS智算版数据流动无法访问Bucket的数据。'."\n" + ."\n" + .' - 数据流动对文件系统的限制'."\n" + ."\n" + .' - 在数据流动关联的文件系统路径中，不可对非空目录执行重命名操作，否则报错Permission Denied或者目录非空。'."\n" + .' - 目录、文件名中的特殊字符需要谨慎使用，支持大小写字母、数字、感叹号（！）、短划线（-）、下划线（_）、半角句号（.）、星号（*）和半角圆括号（()）。'."\n" + .' - 不支持超长路径，数据流动支持的路径最大长度是1023字符。'."\n" + ."\n" + .' - 数据流动导入限制'."\n" + ."\n" + .' - Symlink类型的文件导入到CPFS智算版后，会转变为包含数据的普通文件，并丢失Symlink信息。'."\n" + .' - 如果OSS Bucket存在多个版本，则只复制最新的版本。'."\n" + .' - 不支持长度大于255字节的文件名或子目录名。'."\n" + .' - 数据流动导出限制'."\n" + ."\n" + .' - Symlink类型的文件在同步到OSS后，不会同步Symlink所指向的文件，而是会变成一个普通的无数据空白对象。'."\n" + .' - Hardlink类型的文件仅作为普通文件同步到OSS。'."\n" + .' - Socket、Device、Pipe类型的文件导出到OSS Bucket时，会变成一个普通的无数据空白对象。'."\n" + .' - 不支持长度大于1023字符的目录路径。', + ], + 'DeleteDataFlow' => [ + 'summary' => '删除一个数据流动。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '49024', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDataFlowResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</DeleteDataFlowResponse>","errorExample":""}]', + 'title' => '删除数据流动', + 'description' => '- 仅CPFS 2.2.0及以上版本、智算CPFS 2.4.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 仅支持删除`Running`、`Stopped`状态的数据流动。'."\n" + .'- 删除后，数据流动相关的资源会被释放，且无法恢复。如需数据流动，请您重新创建。', + ], + 'ModifyDataFlow' => [ + 'summary' => '修改数据流动的属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '49026', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '数据流动的描述。 '."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以http://和https://开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Bucket01数据流动', + ], + ], + [ + 'name' => 'Throughput', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据流动的传输带宽上限，单位：MB/s 。'."\n" + .'取值： '."\n" + ."\n" + .'- 600'."\n" + .'- 1200'."\n" + .'- 1500'."\n" + ."\n" + .'> 数据流动的传输带宽必须小于文件系统的IO带宽。当文件系统类型为CPFS时，该参数必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + 'enum' => [ + '600', + '1200', + '1500', + '2000', + ], + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.NoStock', + 'errorMessage' => 'The operation is denied due to no stock.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidThroughput.OutOfBounds', + 'errorMessage' => 'Throughput is out of bounds.', + ], + [ + 'errorCode' => 'InvalidDescription.InvalidFormat', + 'errorMessage' => 'Description format is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDataFlowResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</ModifyDataFlowResponse>","errorExample":""}]', + 'title' => '修改数据流动', + 'description' => '- CPFS 2.2.0及以上版本、CPFS智算版 2.4.0及以上版本支持数据流动。'."\n" + .'- 仅支持状态为`Running（正常）`状态的数据流动修改属性。'."\n" + .'- 修改数据流动一般耗时2~5分钟，您可以通过[DescribeDataFlows](~~2402270~~)查询修改数据流动的状态。'."\n" + .'- CPFS数据流动规格：'."\n" + .' - 数据流动带宽（Throughput）支持600 MB/s、1200 MB/s和1500 MB/s三种规格。数据流动带宽是指该数据流动进行导入或导出数据时能达到的最大传输带宽。'."\n" + .' - 库存查询：当设置DryRun为true时，可校验修改该规格的数据流动的资源是否满足。'."\n" + .'- CPFS计费'."\n" + ."\n" + .' 修改数据流动带宽（Throughput）涉及数据流动带宽计费，建议您提前了解CPFS的计费方式。更多详情，请参见[CPFS计费说明](~~111858~~)。', + ], + 'DescribeDataFlows' => [ + 'summary' => '查询一个CPFS文件系统的数据流动信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '49017', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '查询数据流动的筛选键。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '筛选键的名称。取值：'."\n" + ."\n" + .'- DataFlowIds: 根据数据流动ID筛选。'."\n" + .'- FsetIds：根据Fileset ID筛选。'."\n" + .'- FileSystemPath：根据Fileset在CPFS文件系统中的路径筛选。'."\n" + .'- SourceStorage：根据源端存储的访问路径筛选。'."\n" + .'- ThroughputList：根据数据流动的传输带宽筛选。'."\n" + .'- Description：根据Fileset的描述筛选。'."\n" + .'- Status：根据数据流动状态筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'FsetIds', + 'enum' => [ + 'DataFlowIds', + 'FsetIds', + 'FileSystemPath', + 'SourceStorage', + 'ThroughputList', + 'Description', + 'Status', + 'SourceStoragePath', + ], + ], + 'Value' => [ + 'description' => '筛选键的值。该参数不支持通配符。'."\n" + ."\n" + .'- Key取值为DataFlowIds时，Value取值为数据流动ID或数据流动ID的一部分。可以是一个或一组DataFlowId，数据流动ID最多可设置10个。例如，`df-194433a5be31****`或`df-194433a512a2****,df-234533a5be31****`。'."\n" + ."\n" + .'- 当Key取值为FsetIds时，Value取值为Fileset Id或Fileset ID的部分。可以是一个或一组Fileset ID，Fileset ID最多可设置10个。例如，`fset-1902718ea0ae****`或`fset-235718ea0ae****,fset-5122718ea0ae****`。'."\n" + .'- 当Key取值为FileSystemPath时，Value取值为CPFS文件系统中的路径或路径的一部分。长度为1~1024个字符。'."\n" + .'- 当Key取值为SourceStorage时，Value取值为源端存储的访问路径。最长为1024个字符。'."\n" + .'- 当Key取值为ThroughputList时，Value取值为数据流动的传输带宽且支持组合查询。'."\n" + .'- 当Key取值为Description时，Value取值为数据流动的描述或描述的一部分。'."\n" + .'- 当Key取值为Status时，Value取值为数据流动状态。'."\n" + .'- 当Key取值为SourceStoragePath时，Value取值为源端存储访问路径或访问路径的一部分。最长1024个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'FsetIds', + ], + ], + 'required' => false, + ], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询结果的个数。'."\n" + ."\n" + .'取值范围：10~100。默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + 'NextToken' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + 'DataFlowInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataFlow' => [ + 'description' => '数据流动信息合集。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => 'cpfs-099394bd928c****', + ], + 'DataFlowId' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'example' => 'df-194433a5be31****', + ], + 'FsetId' => [ + 'description' => 'Fileset ID。'."\n" + .'>仅支持CPFS。', + 'type' => 'string', + 'example' => 'fset-1902718ea0ae****', + ], + 'Status' => [ + 'description' => '数据流动状态。包括：'."\n" + ."\n" + .'- Starting：数据流动正在创建或启动中。'."\n" + .'- Running：数据流动已创建完成，正常运行中。 '."\n" + .'- Updating：数据流动正在发生修改，例如提升传输带宽、修改自动更新间隔时间。'."\n" + .'- Deleting：数据流动删除中。'."\n" + .'- Stopping：数据流动停止中。'."\n" + .'- Stopped：数据流动已停止。'."\n" + .'- Misconfigured：数据流动配置异常，例如源端存储无法访问，传输带宽过低无法完成自动更新。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。包括：'."\n" + ."\n" + .'- 无（默认值）：表示该数据流动状态正常。'."\n" + .'- SourceStorageUnreachable：未查询到源端存储的访问路径。'."\n" + .'- ThroughputTooLow：数据流动带宽过低。', + 'type' => 'string', + 'example' => 'SourceStorageUnreachable', + ], + 'SourceStorage' => [ + 'description' => '源端存储的访问路径。格式：`<storage type>://[<account id>:]<path>`。'."\n" + ."\n" + .'其中：'."\n" + ."\n" + .'- storage type：目前只支持OSS。'."\n" + .'- account id：源端存储所属账号的UID。'."\n" + .'- path：OSS的bucket名称。'."\n" + .' - 仅支持小写字母、数字和短划线（-）且必须以小写字母或者数字开头和结尾。'."\n" + .' - 长度为8~128个英文字符。'."\n" + .' - 使用UTF-8编码。'."\n" + .' - 不能以http://和https://开头。'."\n" + ."\n" + .'>- OSS Bucket必须为在该地域已存在的Bucket。'."\n" + .'> - 仅CPFS智算版2.6.0及以上版本支持account id参数。', + 'type' => 'string', + 'example' => 'oss://178321033379****:bucket-01', + ], + 'SourceSecurityType' => [ + 'description' => '源端存储的安全保护类型，如果源端存储必须通过安全保护访问，请指定源端存储的安全保护类型。取值：'."\n" + ."\n" + .'- 无（默认值）：表示源端存储不需要通过安全保护方式访问。'."\n" + .'- SSL：通过SSL证书保护访问。', + 'type' => 'string', + 'example' => 'SSL', + ], + 'Throughput' => [ + 'description' => '数据流动的传输带宽上限，单位：MB/s 。取值： '."\n" + ."\n" + .'- 600'."\n" + .'- 1200'."\n" + .'- 1500'."\n" + ."\n" + .'> - 数据流动的传输带宽必须小于文件系统的IO带宽。'."\n" + .'> - 仅支持CPFS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600', + ], + 'Description' => [ + 'description' => '数据流动的描述。 '."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'example' => 'Bucket01数据流动', + ], + 'CreateTime' => [ + 'description' => 'Fileset的创建时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。'."\n" + .'> 仅支持CPFS。', + 'type' => 'string', + 'example' => '2021-09-30T10:08:08Z', + ], + 'UpdateTime' => [ + 'description' => 'Fileset的最近一次更新时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。'."\n" + .'> 仅支持CPFS。', + 'type' => 'string', + 'example' => '2021-09-30T10:08:08Z', + ], + 'AutoRefresh' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRefresh' => [ + 'description' => '自动更新策略信息集合。'."\n" + ."\n" + .'>仅支持CPFS。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshPath' => [ + 'description' => '自动更新目录，CPFS仅自动检查该目录下的源端数据是否发生更新并自动导入更新的数据。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~1024个字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以/开头和结尾。'."\n" + ."\n" + .'> 该目录必须是CPFS上的已有目录，且必须位于开启了数据流动的Fileset中。', + 'type' => 'string', + 'example' => '/prefix1/prefix2/', + ], + ], + ], + ], + ], + ], + 'FileSystemPath' => [ + 'description' => 'Fileset在CPFS文件系统中的路径。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~1024个英文或中文字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以/开头和结尾。'."\n" + .'- 该目录必须是CPFS上的Fileset目录。'."\n" + .'>仅支持CPFS。', + 'type' => 'string', + 'example' => '/a/b/c/', + ], + 'FsetDescription' => [ + 'description' => '自动更新的描述。'."\n" + .'>仅支持CPFS。', + 'type' => 'string', + 'example' => '自动更新01', + ], + 'AutoRefreshInterval' => [ + 'description' => '自动更新间隔时间。每隔该时间间隔，CPFS会检查目录内是否存在数据更新，如果有数据更新，启动自动更新任务。单位：分钟。'."\n" + ."\n" + .'取值范围：5~526600。默认值：10。'."\n" + .'>仅支持CPFS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AutoRefreshPolicy' => [ + 'description' => '自动更新策略，源端数据更新以后，数据更新导入到CPFS的策略。包括：'."\n" + ."\n" + .'- None：源端的数据更新不自动导入CPFS，用户可通过数据流动任务导入源端的数据更新。'."\n" + .'- ImportChanged：源端的数据更新自动导入CPFS。'."\n" + .'>仅支持CPFS。', + 'type' => 'string', + 'example' => 'None', + ], + 'SourceStoragePath' => [ + 'title' => '源端存储内的访问路径。', + 'description' => '源端存储Bucket内的访问路径。'."\n" + ."\n" + .'> 仅支持CPFS智算版。', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => '/prefix/'."\n", + 'maxLength' => 1024, + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesystemVersion.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem version.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFilterValue', + 'errorMessage' => 'The specified parameter Filter.1.Value is invalid.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'The specified Filter.N.Key is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidMaxResults', + 'errorMessage' => 'The specified MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\",\\n \\"NextToken\\": \\"TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=\\",\\n \\"DataFlowInfo\\": {\\n \\"DataFlow\\": [\\n {\\n \\"FileSystemId\\": \\"cpfs-099394bd928c****\\",\\n \\"DataFlowId\\": \\"df-194433a5be31****\\",\\n \\"FsetId\\": \\"fset-1902718ea0ae****\\",\\n \\"Status\\": \\"Running\\",\\n \\"ErrorMessage\\": \\"SourceStorageUnreachable\\",\\n \\"SourceStorage\\": \\"oss://178321033379****:bucket-01\\",\\n \\"SourceSecurityType\\": \\"SSL\\",\\n \\"Throughput\\": 600,\\n \\"Description\\": \\"Bucket01数据流动\\",\\n \\"CreateTime\\": \\"2021-09-30T10:08:08Z\\",\\n \\"UpdateTime\\": \\"2021-09-30T10:08:08Z\\",\\n \\"AutoRefresh\\": {\\n \\"AutoRefresh\\": [\\n {\\n \\"RefreshPath\\": \\"/prefix1/prefix2/\\"\\n }\\n ]\\n },\\n \\"FileSystemPath\\": \\"/a/b/c/\\",\\n \\"FsetDescription\\": \\"自动更新01\\",\\n \\"AutoRefreshInterval\\": 10,\\n \\"AutoRefreshPolicy\\": \\"None\\",\\n \\"SourceStoragePath\\": \\"/prefix/\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataFlowsResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n <NextToken>TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=</NextToken>\\n <DataFlowInfo>\\n <FileSystemId>cpfs-099394bd928c****</FileSystemId>\\n <DataFlowId>dfid-194433a5be31****</DataFlowId>\\n <FsetId>fset-1902718ea0ae****</FsetId>\\n <Status>Running</Status>\\n <ErrorMessage>无</ErrorMessage>\\n <SourceStorage>oss://bucket1</SourceStorage>\\n <SourceSecurityType>SSL</SourceSecurityType>\\n <Throughput>600</Throughput>\\n <Description>Bucket01数据流动</Description>\\n <CreateTime>2021-09-30T10:08:08Z</CreateTime>\\n <UpdateTime>2021-09-30T10:08:08Z</UpdateTime>\\n <AutoRefresh>\\n <RefreshPath>/prefix1/prefix2/</RefreshPath>\\n </AutoRefresh>\\n <FileSystemPath>/a/b/c/</FileSystemPath>\\n <FsetDescription>自动更新01</FsetDescription>\\n <AutoRefreshInterval>10</AutoRefreshInterval>\\n <AutoRefreshPolicy>None</AutoRefreshPolicy>\\n </DataFlowInfo>\\n</DescribeDataFlowsResponse>","errorExample":""}]', + 'title' => '查询数据流动列表', + 'description' => '- 仅CPFS 2.2.0及以上版本、CPFS智算版2.4.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 筛选键（Filters）中，FsetIds、DataFlowlds、SourceStorage、ThroughputList、Status需要做全字匹配，FileSystemPath、Description、SourceStoragePath支持模糊匹配。'."\n" + .'- 支持组合查询。', + ], + 'StopDataFlow' => [ + 'summary' => '停用一个数据流动。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '49021', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDataFlowResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</StopDataFlowResponse>","errorExample":""}]', + 'title' => '停用数据流动', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + .'- 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 只能停用`Running（正常）`状态的数据流动。'."\n" + .'- 停用后，不可在数据流动上创建数据流动任务。如果配置了自动更新，源端发生的数据更新也不会同步到CPFS上。'."\n" + .'- 停用后，由于资源被回收，数据流动带宽将不再计费，但重新启动数据流动可能因为库存不足导致启动失败。'."\n" + .'- 停用数据流动一般耗时2～5分钟，您可通过[DescribeDataFlows](~~2402271~~)查询数据流动状态。', + ], + 'StartDataFlow' => [ + 'summary' => '启用一个数据流动。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '49022', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.NoStock', + 'errorMessage' => 'The operation is denied due to no stock.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDataFlowResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</StartDataFlowResponse>","errorExample":""}]', + 'title' => '启用数据流动', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + .'- 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 只能启动`Stopped（停止）`状态的数据流动。'."\n" + .'- 当DryRun为`true`时，可校验启动该规格的数据流动的资源是否充足。如果库存资源不足，数据流动则无法启动。'."\n" + .'- 启动数据流动一般耗时2～5分钟，您可通过[DescribeDataFlows](~~2402270~~)查询数据流动状态。', + ], + 'CreateDataFlowTask' => [ + 'summary' => '创建一个数据流动任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '49027', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'SrcTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '当指定SrcTaskId时，需填写数据流动任务ID。系统将从目标数据流动任务中复制TaskAction、DataType和EntryList参数信息，您无需单独指定这些内容。'."\n" + .'> 不支持数据流动流式任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'task-29ee8e890f45****', + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据流动任务类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- Import：从源端存储将指定的数据导入至CPFS。'."\n" + .'- Export：将CPFS上指定的数据导出至源端存储。'."\n" + .'- StreamImport：从源端存储将指定的数据批量导入至CPFS。'."\n" + .'- StreamExport：将CPFS上指定的数据批量导出至源端存储。'."\n" + .'- Evict：释放CPFS上文件的数据块，释放后文件在CPFS上只保留元数据，您仍能查询该文件，但文件数据块已清除，不占用CPFS上的存储容量。当访问该文件数据时，将再从源端存储按需加载。'."\n" + .'- Inventory：获取CPFS上数据流动管理的文件清单，可提供文件在数据流动中的缓存状态。'."\n" + .'> CPFS智算版仅支持Import、Export、StreamImport和StreamExport。StreamImport和StreamExport仅CPFS智算版2.6.0版本及以上版本支持。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Import', + 'enum' => [ + 'Import', + 'Export', + 'Evict', + 'Inventory', + 'StreamImport', + 'StreamExport', + ], + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据流动任务操作的数据类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- Metadata：文件的元数据，包括文件的timestamp、 ownership、permission等属性信息。选择Metadata，只会导入文件的元数据，用户只能看到该文件，但访问该文件数据时，数据从源端存储按需加载。'."\n" + .'- Data：文件的数据块。'."\n" + .'- MetaAndData：文件的元数据和数据块。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Metadata', + 'enum' => [ + 'Metadata', + 'Data', + 'MetaAndData', + '', + ], + ], + ], + [ + 'name' => 'Directory', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '数据的源目录。'."\n" + ."\n" + .'限制：'."\n" + .'- 长度为1~1023个字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以正斜线（/）开头和结尾。'."\n" + .'- 一次只能列举一个目录。'."\n" + .'- 当TaskAction为Export时，该目录必须是FileSystemPath内的相对路径。'."\n" + .'- 当TaskAction为Import时，该目录必须是SourceStoragePath内的相对路径。'."\n" + .'- 当TaskAction为StreamExport时，该目录必须是FileSystemPath内的相对路径。'."\n" + .'- 当TaskAction为StreamImport时，该目录必须是SourceStoragePath内的相对路径。'."\n" + .'> StreamImport和StreamExport仅CPFS智算版2.6.0版本及以上版本支持。', + 'type' => 'string', + 'required' => false, + 'example' => '/path_in_cpfs/', + 'maxLength' => 1023, + ], + ], + [ + 'name' => 'EntryList', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动任务执行的文件列表。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 使用UTF-8编码。'."\n" + .'- 文件列表总长度小于64KB。'."\n" + .'- 文件列表采用JSON格式。'."\n" + .'- 单个文件路径长度为 1~1023 个字符，且必须以正斜线（/）开头。'."\n" + .'- 当TaskAction为Import时，列表中每个元素代表一个OSS Object名称。'."\n" + .'- 当TaskAction为Export时，列表中每个元素代表一个CPFS文件路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '["/path_in_cpfs/file1", "/path_in_cpfs/file2"]', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但TaskId为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ConflictPolicy', + 'in' => 'query', + 'schema' => [ + 'title' => '同名文件冲突策略。', + 'description' => '同名文件冲突策略。'."\n" + .'取值：'."\n" + ."\n" + .'- SKIP_THE_FILE：跳过同名文件。'."\n" + .'- KEEP_LATEST：比较更新时间，保留最新版本。'."\n" + .'- OVERWRITE_EXISTING：强制覆盖同名文件。'."\n" + .'> 当文件系统类型为cpfs智算版时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'SKIP_THE_FILE', + 'enum' => [ + 'SKIP_THE_FILE', + 'KEEP_LATEST', + 'OVERWRITE_EXISTING', + ], + ], + ], + [ + 'name' => 'DstDirectory', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动任务映射目标目录。'."\n" + .'限制：'."\n" + .' - 必须以正斜线（/）开头和结尾，不支持/../。'."\n" + .' - 长度为 1~1023 个字符。'."\n" + .' - 使用 UTF-8 编码。'."\n" + .' - 一次只能列举一个目录。'."\n" + .' - 当 TaskAction 为 Export 时，该目录必须是 SourceStoragePath 内的相对路径。'."\n" + .' - 当 TaskAction 为 Import 时，该目录必须是 FileSystemPath 内的相对路径。'."\n" + .' - 当 TaskAction 为 StreamExport 时，该目录必须是 SourceStoragePath 内的相对路径。'."\n" + .' - 当 TaskAction 为 StreamImport 时，该目录必须是 FileSystemPath 内的相对路径。'."\n" + .'> StreamImport和StreamExport仅CPFS智算版2.6.0版本及以上版本支持。', + 'type' => 'string', + 'required' => false, + 'example' => '/path_in_cpfs/', + ], + ], + [ + 'name' => 'CreateDirIfNotExist', + 'in' => 'query', + 'schema' => [ + 'description' => '目录不存在时，自动创建目录。'."\n" + .'取值：'."\n" + ."\n" + .'- true：自动创建目录。'."\n" + .'- false（默认值）：不自动创建目录。'."\n" + ."\n" + .'> - TaskAction = Import时，该参数生效。'."\n" + .'> - 仅CPFS智算版2.6.0版本及以上版本支持。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Includes', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤directory下目录，传输过滤目录内包含的文件夹内容。'."\n" + ."\n" + .'> - 仅在指定了Directory参数时，该参数生效。'."\n" + .'> - 单个文件夹路径长度为1~1023个字符，且必须以正斜线（/）开头与结尾，总长度限制不超过3000字符。'."\n" + .'> - 仅CPFS智算版支持该功能。', + 'type' => 'string', + 'required' => false, + 'example' => '["/test/","/test1/"]', + ], + ], + [ + 'name' => 'TransferFileListPath', + 'in' => 'query', + 'schema' => [ + 'description' => '指定oss目录，根据oss目录中的csv文件的内容同步数据。限制如下。'."\n" + .'- 必须以/开头和结尾。'."\n" + ."\n" + .'- 区分大小写。'."\n" + ."\n" + .'- 长度为 1~1023 个字符之间。'."\n" + ."\n" + .'- 使用 UTF-8 编码。'."\n" + ."\n\n" + .'>- TransferFileListPath，Directory和EntryList为互斥参数，只能三者选一。'."\n" + .'>- 该参数为oss下真实存在路径。路径下*.csv文件存储在oss中。'."\n" + .'> - TransferFileListPath仅支持Import、Export功能。'."\n" + .'> - Import的场景，会将csv文件中指定的文件或者目录，从oss导入到cpfs。'."\n" + .'> - Export的场景，会将csv文件中指定的文件或者目录，从cpfs导出到oss'."\n" + .'> - csv文件格式中应该包含Name、Type列，Name为相对路径，Type支持dir和file两种值；如果type为dir，name后缀必须以/结尾。'."\n" + .'>- 仅CPFS智算版支持该功能。', + 'type' => 'string', + 'required' => false, + 'example' => '/test_oss_path/', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + 'TaskId' => [ + 'description' => '数据流动任务ID。', + 'type' => 'string', + 'example' => 'task-38aa8e890f45****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesystemVersion.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem version.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.InvalidFormat', + 'errorMessage' => 'The EntryList format is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.SizeTooLarge', + 'errorMessage' => 'The specified EntryList size exceeds 64 KB.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidTaskAction.NotSupported', + 'errorMessage' => 'The task action is not supported.', + ], + [ + 'errorCode' => 'InvalidTaskAction.PermissionDenied', + 'errorMessage' => 'The task action is not allowed.', + ], + [ + 'errorCode' => 'InvalidSrcTaskId.NotFound', + 'errorMessage' => 'The SrcTaskId is not found.', + ], + [ + 'errorCode' => 'InvalidDataType.NotSupported', + 'errorMessage' => 'The data type is not supported.', + ], + [ + 'errorCode' => 'InvalidSrcTaskId.TaskIdInvalid', + 'errorMessage' => 'Source task ID is invalid.', + ], + [ + 'errorCode' => 'InvalidSrcTaskId.TaskIdNotFound', + 'errorMessage' => 'Source task ID is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\",\\n \\"TaskId\\": \\"task-38aa8e890f45****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDataFlowTaskResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n <TaskId>taskId-1345768****</TaskId>\\n</CreateDataFlowTaskResponse>","errorExample":""}]', + 'title' => '创建数据流动任务', + 'description' => '- CPFS使用说明'."\n" + .' - 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .' - 数据流动任务是异步执行的，您可通过[DescribeDataFlowTasks](~~2402275~~)查询任务执行状态。任务的耗时取决于需要导入、导出的数据量。如果是大量数据，建议拆分成多个任务执行。'."\n" + .' - 仅支持在Running（正常）状态的数据流动上创建数据流动任务。'."\n" + .' - 手动执行数据流动任务时，该数据流动的自动数据更新任务会被中断并等待。'."\n" + .' - 当创建导出任务时，需要确保CPFS待导出的文件绝对路径总长度不能超过1023个字符。'."\n" + ."\n" + .'- CPFS智算版使用说明'."\n" + .' - 仅CPFS智算版 2.4.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .' - 数据流动任务是异步执行的，您可通过[DescribeDataFlowTasks](~~2402275~~)查询任务执行状态。任务的耗时取决于需要导入、导出的数据量。如果是大量数据，建议拆分成多个任务执行。'."\n" + .' - 仅支持在Running（正常）状态的数据流动上创建数据流动任务。'."\n" + .' - 当创建导出任务时，需要确保智算CPFS待导出的文件绝对路径总长度不能超过1023个字符。'."\n" + .' - CPFS智算版支持批式任务和流式任务两种任务类型。更多信息，请参见[任务类型介绍](~~2845429~~)。', + ], + 'CreateDataFlowSubTask' => [ + 'summary' => '创建数据流动流式任务的子任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225698', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '特殊用户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-370lx1ev9ss27o0****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'DataFlowTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动任务ID。'."\n" + .'>仅支持数据流动流式任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'task-38aa8e890f45****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建数据流动。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但DataFlowSubTaskId为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'SrcFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '源文件路径。'."\n" + .'限制：'."\n" + .'- 长度为 1~1023 个字符。'."\n" + .'- 使用 UTF-8 编码。'."\n" + .'- 必须以正斜线（/）开头。'."\n" + .'- 必须以文件名称结尾。', + 'type' => 'string', + 'required' => true, + 'example' => '/test/file.png', + ], + ], + [ + 'name' => 'DstFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '目标文件路径。'."\n" + .'限制：'."\n" + .'- 长度为 1~1023 个字符。'."\n" + .'- 使用 UTF-8 编码。'."\n" + .'- 必须以正斜线（/）开头。'."\n" + .'- 必须以文件名称结尾。', + 'type' => 'string', + 'required' => true, + 'example' => '/mnt/file.png', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '校验条件，以下条件传入后需要校验通过。', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '修改时间，unix时间戳。单位：ns。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1725897600000000000', + ], + 'Size' => [ + 'description' => '文件大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '68', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A70BEE5D-76D3-49FB-B58F-1F398211A5C3', + ], + 'DataFlowSubTaskId' => [ + 'description' => '数据流动流式任务ID。', + 'type' => 'string', + 'example' => 'subTaskId-370kyfmyknxcyzw****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesystemVersion.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem version.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.InvalidFormat', + 'errorMessage' => 'The EntryList format is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.SizeTooLarge', + 'errorMessage' => 'The specified EntryList size exceeds 64 KB.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidTaskAction.NotSupported', + 'errorMessage' => 'The task action is not supported.', + ], + [ + 'errorCode' => 'InvalidTaskAction.PermissionDenied', + 'errorMessage' => 'The task action is not allowed.', + ], + [ + 'errorCode' => 'InvalidSrcTaskId.NotFound', + 'errorMessage' => 'The SrcTaskId is not found.', + ], + [ + 'errorCode' => 'InvalidDataType.NotSupported', + 'errorMessage' => 'The data type is not supported.', + ], + [ + 'errorCode' => 'InvalidSrcTaskId.TaskIdInvalid', + 'errorMessage' => 'Source task ID is invalid.', + ], + [ + 'errorCode' => 'InvalidSrcTaskId.TaskIdNotFound', + 'errorMessage' => 'Source task ID is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A70BEE5D-76D3-49FB-B58F-1F398211A5C3\\",\\n \\"DataFlowSubTaskId\\": \\"subTaskId-370kyfmyknxcyzw****\\"\\n}","type":"json"}]', + 'title' => '创建数据流动流式子任务', + 'description' => '- 仅CPFS智算版2.6.0 及以上版本支持。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .' - 仅支持状态为Executing（执行中）的数据流动流式任务创建子任务。'."\n" + .'- 数据流动流式任务是异步执行的，您可通过DescribeDataFlowSubTasks查询流式任务执行状态。'."\n" + .'- 当数据流动任务类型为流式任务时，运行中状态仅代表可以创建流式导入任务或流式导出任务（并不代表导入或导出任务运行中）。', + ], + 'CancelDataFlowTask' => [ + 'summary' => '取消一个Pending（等待）或Executing（运行中）状态的数据流动批式任务或流式任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '49029', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'task-38aa8e890f45****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingTaskId', + 'errorMessage' => 'TaskId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidTaskId.NotFound', + 'errorMessage' => 'The specified task ID does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelDataFlowTaskResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n</CancelDataFlowTaskResponse>","errorExample":""}]', + 'title' => '取消数据流动任务', + 'description' => '- 仅CPFS 2.2.0及以上版本、CPFS智算版2.4.0及以上版本支持数据流动任务。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 仅支持取消`Pending（等待）`和`Executing（运行中）`状态的数据流动任务。'."\n" + .'- 取消数据流动任务一般耗时5～10分钟，您可通过[DescribeDataFlowTasks](~~2402275~~)查询任务执行状态。'."\n" + .'- 如果数据流动流式任务中有正在运行的流式子任务，则不支持取消流式任务。否则会返回InvalidStatus.ResourceMismatch报错信息。', + ], + 'CancelDataFlowSubTask' => [ + 'summary' => '取消数据流动流式任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225734', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-370lx1ev9ss27o0****'."\n", + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'DataFlowTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'task-38aa8e890f45****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'DataFlowSubTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动流式任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'subTaskId-370kyfmyknxcyzw****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingTaskId', + 'errorMessage' => 'TaskId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidTaskId.NotFound', + 'errorMessage' => 'The specified task ID does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', + 'title' => '取消数据流动流式子任务', + 'description' => '- 仅CPFS智算版2.6.0 及以上版本支持。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 仅支持在 CREATED和RUNNING状态下取消数据流动流式任务。'."\n" + .'- 数据流动流式任务是异步执行的，您可通过DescribeDataFlowSubTasks查询流式任务执行状态。', + ], + 'DescribeDataFlowTasks' => [ + 'summary' => '查询数据流动任务详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '49028', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-099394bd928c****。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-290w65p03ok64ya****'."\n" + .'。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-290w65p03ok64ya****'."\n", + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '筛选键的信息合集。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '筛选键的名称。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- DataFlowIds: 根据数据流动ID筛选。'."\n" + .'- TaskIds：根据数据流动任务的ID筛选。'."\n" + .'- Originator：根据数据流动任务的发起者筛选。'."\n" + .'- TaskActions：根据数据流动任务的类型筛选。'."\n" + .'- DataTypes：根据数据流动任务的数据类型筛选。'."\n" + .'- Status：根据数据流动状态筛选。'."\n" + .'- CreateTimeBegin：筛选指定时间后创建的数据流动任务。'."\n" + .'- CreateTimeEnd：筛选指定时间前创建的数据流动任务。'."\n" + .'- StartTimeBegin：筛选指定时间后启动的数据流动任务。'."\n" + .'- StartTimeEnd：筛选指定时间前启动的数据流动任务。'."\n" + .'- EndTimeBegin：筛选指定时间后结束的数据流动任务。'."\n" + .'- EndTimeEnd：筛选指定时间前结束的数据流动任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'DataFlowIds', + 'enum' => [ + 'DataFlowIds', + 'TaskIds', + 'Originator', + 'TaskActions', + 'DataTypes', + 'Status', + 'CreateTimeBegin', + 'CreateTimeEnd', + 'StartTimeBegin', + 'StartTimeEnd', + 'EndTimeBegin', + 'EndTimeEnd', + ], + ], + 'Value' => [ + 'description' => '筛选键的值。该参数不支持通配符。'."\n" + ."\n" + .'- Key取值为DataFlowIds时，Value取值为数据流动ID或数据流动ID的一部分。可以是一个或一组DataFlowId，数据流动ID最多可设置10个。例如，`df-194433a5be31****`或`df-194433a512a2****,df-234533a5be31****`。'."\n" + .'- 当Key取值为TaskId时，Value取值为数据流动任务ID或数据流动任务ID的部分。可以是一个或一组数据流动任务ID，数据流动任务ID最多可设置10个。例如，`task-38aa8e890f45****`或`task-38aa8e890f45****,task-29ae8e890f45****`。'."\n" + .'- 当Key取值为TaskActions时，Value取值为数据流动的任务类型，包括**Import**，**Export**、**Evict**、**Inventory**、**StreamImport**和**StreamExport**。支持组合查询。目前 CPFS 智算版只支持 Import、Export、StreamImport 和 StreamExport。StreamImport 和 StreamExport 仅 CPFS 智算版 2.6.0 版本及以上版本支持。'."\n" + .'- 当Key取值为DataTypes时，Value取值为数据流动任务的数据类型，包括MetaAndData、Metadata和Data。支持组合查询。'."\n" + .'- 当Key取值为Originator时，Value取值为数据流动任务的发起者，包括User，System。'."\n" + .'- 当Key取值为Status时，Value取值为数据流动任务的状态，包括Pending、Executing、Failed、Completed、Canceling和Canceled。支持组合查询。'."\n" + .'- 当Key取值为CreateTimeBegin时，Value取值为数据流动任务创建时间最小值。格式为`yyyy-MM-ddThh:mmZ`。'."\n" + .'- 当Key取值为CreateTimeEnd时，Value取值为数据流动任务创建时间最大值。格式为`yyyy-MM-ddThh:mmZ`。'."\n" + .'- 当Key取值为StartTimeBegin时，Value取值为数据流动任务启动时间最小值。格式为`yyyy-MM-ddThh:mmZ`。'."\n" + .'- 当Key取值为StartTimeEnd时，Value取值为数据流动任务启动时间最大值。格式为`yyyy-MM-ddThh:mmZ`。'."\n" + .'- 当Key取值为EndTimeBegin时，Value取值为数据流动任务结束时间最小值。格式为`yyyy-MM-ddThh:mmZ`。'."\n" + .'- 当Key取值为EndTimeEnd时，Value取值为数据流动任务结束时间最大值。格式为`yyyy-MM-ddThh:mmZ`。', + 'type' => 'string', + 'required' => false, + 'example' => 'df-194433a5be31****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 12, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询结果的个数。'."\n" + ."\n" + .'取值范围：10~100。'."\n" + ."\n" + .'默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'WithReports', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询报表信息。'."\n" + ."\n" + .'- True（默认值）：查询报表。'."\n" + .'- False：不查询报表。'."\n" + ."\n" + .'>- 设置为False可以加快查询速度。'."\n" + .'> - 仅支持CPFS智算版。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + 'NextToken' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + 'TaskInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => '数据流动任务的信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FilesystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => 'bmcpfs-290w65p03ok64ya****', + ], + 'DataFlowId' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'example' => 'df-194433a5be31****', + ], + 'TaskId' => [ + 'description' => '数据流动任务ID。', + 'type' => 'string', + 'example' => 'task-38aa8e890f45****', + ], + 'SourceStorage' => [ + 'description' => '源端存储的访问地址。格式：`<storage type>://[<account id>:]<path>`。'."\n" + ."\n" + .'其中：'."\n" + ."\n" + .'- storage type：目前只支持oss。'."\n" + .'- account id：源端存储所属账号的UID。'."\n" + .'- path：OSS的Bucket名称。限制如下。'."\n" + ."\n" + .' - 仅支持小写字母、数字和短划线（-）且必须以小写字母或者数字开头和结尾。'."\n" + ."\n" + .' - 最长为128个字符。'."\n" + ."\n" + .' - 使用UTF-8编码。'."\n" + ."\n" + .'> - OSS Bucket必须为在该地域已存在的Bucket。'."\n" + .'> - 仅CPFS智算版2.6.0及以上版本支持 account id 参数。', + 'type' => 'string', + 'example' => 'oss://178321033379****:bucket-01', + ], + 'FileSystemPath' => [ + 'description' => 'Fileset在CPFS文件系统中的路径。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~1024个英文或中文字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以/开头和结尾。'."\n" + .'- 该目录必须是CPFS上的Fileset目录。'."\n" + .'> 仅CPFS支持该参数。', + 'type' => 'string', + 'example' => '/a/b/c/', + ], + 'Originator' => [ + 'description' => '数据流动任务的发起者。'."\n" + .'包括：'."\n" + ."\n" + .'- User：用户是该任务的发起者。'."\n" + .'- System：该任务是自动更新任务，是CPFS根据自动更新间隔时间自动发起的任务。'."\n" + .'> 仅CPFS支持该参数。', + 'type' => 'string', + 'example' => 'User', + ], + 'TaskAction' => [ + 'description' => '数据流动任务类型。包括：'."\n" + ."\n" + .'- Import：从源端存储将指定的数据导入至CPFS。'."\n" + .'- Export：将CPFS上指定的数据导出至源端存储。'."\n" + .'- StreamImport：从源端存储将指定的数据流式任务导入至CPFS。'."\n" + .'- StreamExport：将CPFS上指定的数据流式任务导出至源端存储。'."\n" + .'- Evict：释放CPFS上文件的数据块，释放后文件在CPFS上只保留元数据，您仍能查询该文件，但文件数据块已清除，不占用CPFS上的存储容量。当访问该文件数据时，将再从源端存储按需加载。'."\n" + .'- Inventory：获取CPFS上数据流动管理的文件清单，可提供文件在数据流动中的缓存状态。'."\n" + .'> StreamImport和StreamExport仅CPFS智算版2.6.0版本及以上版本支持。', + 'type' => 'string', + 'example' => 'Import', + ], + 'DataType' => [ + 'description' => '数据流动任务操作的数据类型。包括：'."\n" + ."\n" + .'- Metadata：文件的元数据，包括文件的timestamp, ownership, permission等属性信息。选择Metadata，只会导入文件的元数据，用户只能看到该文件，但访问该文件数据时，数据从源端存储按需加载。'."\n" + .'- Data：文件的数据块。'."\n" + .'- MetaAndData：文件的元数据和数据块。'."\n" + .'> CPFS智算版仅支持 MetaAndData 类型。', + 'type' => 'string', + 'example' => 'MetaAndData ', + ], + 'Progress' => [ + 'description' => '数据流动任务的进度。当前数据流动任务已经执行的操作数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'Status' => [ + 'description' => '数据流动任务的状态。包括：'."\n" + ."\n" + .'- Pending: 数据流动任务已创建，在排队中未开始执行。'."\n" + .'- Executing：数据流动任务在执行中。'."\n" + .'- Failed：数据流动任务执行失败，可以通过查看数据流动任务报告，查看失败原因。'."\n" + .'- Completed：数据流动任务执行结束，可以通过查看数据流动任务报告，查看所有文件已正确传输。'."\n" + .'- Canceled：数据流动任务被取消并且没有完成。'."\n" + .'- Canceling：数据流动任务正在被取消。', + 'type' => 'string', + 'example' => 'Failed', + ], + 'ReportPath' => [ + 'description' => '数据流动任务报告在CPFS文件系统中保存的路径。'."\n" + ."\n" + .'- CPFS的任务报告会生成在该CPFS的`.dataflow_report`目录中。'."\n" + .'- CPFS智算版会返回一个oss下载链接，可以通过链接下载任务报告。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '/path_in_cpfs/reportfile.cvs', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2021-08-04 18:27:35', + ], + 'StartTime' => [ + 'description' => '任务开始执行时间。', + 'type' => 'string', + 'example' => '2021-08-04 18:27:35', + ], + 'EndTime' => [ + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2021-08-04 18:27:35', + ], + 'FsPath' => [ + 'description' => '智能目录路径。', + 'type' => 'string', + 'example' => '/aa/', + ], + 'ConflictPolicy' => [ + 'title' => '同名文件冲突策略', + 'description' => '同名文件冲突策略。'."\n" + ."\n" + .'- SKIP_THE_FILE：跳过同名文件。'."\n" + .'- KEEP_LATEST：比较更新时间，保留最新版本。'."\n" + .'- OVERWRITE_EXISTING：强制覆盖同名文件。', + 'type' => 'string', + 'example' => 'KEEP_LATEST', + 'enum' => [ + 'SKIP_THE_FILE', + 'KEEP_LATEST', + 'OVERWRITE_EXISTING', + ], + ], + 'Directory' => [ + 'title' => '数据流动任务执行的目录', + 'description' => '数据流动任务执行的目录。', + 'type' => 'string', + 'example' => '/path_in_cpfs/', + ], + 'DstDirectory' => [ + 'description' => '数据流动任务映射目标目录。', + 'type' => 'string', + 'example' => '/path_in_cpfs/'."\n", + ], + 'ErrorMsg' => [ + 'description' => '任务异常原因。'."\n" + .'> 当该字段未返回或者返回为空时，表示没有错误信息。', + 'type' => 'string', + 'example' => '{"ErrorKey":"PATH_NOT_ACCESSIBLE","ErrorDetail":"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory"}', + ], + 'ProgressStats' => [ + 'description' => '数据流动任务进度信息。', + 'type' => 'object', + 'properties' => [ + 'FilesTotal' => [ + 'description' => '源端扫描到文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'FilesDone' => [ + 'description' => '已完成数据流动文件数（包括跳过）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ActualFiles' => [ + 'description' => '实际流动文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'BytesTotal' => [ + 'description' => '源端扫描到数据量。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131092971520', + ], + 'BytesDone' => [ + 'description' => '已完成数据流动数据量（包括跳过数据）。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131092971520', + ], + 'ActualBytes' => [ + 'description' => '实际流动数据量。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131092971520', + ], + 'RemainTime' => [ + 'description' => '预计剩余完成时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '437', + ], + 'AverageSpeed' => [ + 'description' => '平均流动速度。单位：Byte/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '342279299', + ], + ], + ], + 'Reports' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Report' => [ + 'description' => '报告列表。'."\n" + .'> - 流式任务不支持报告。'."\n" + .'> - 当WithReport=True时，该参数会返回CPFS智算版报告数据。'."\n" + .'>- 仅CPFS智算版支持WithReport参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报告名称。'."\n" + ."\n" + .'- CPFS：'."\n" + ."\n" + .' TotalFilesReport：任务报告。'."\n" + .'- CPFS智算版：'."\n" + .' - FailedFilesReport：失败的文件报告。'."\n" + .' - SkippedFilesReport：跳过的文件报告。'."\n" + .' - SuccessFilesReport：成功文件报告。', + 'type' => 'string', + 'example' => 'TotalFilesReport', + ], + 'Path' => [ + 'description' => '报告链接。', + 'type' => 'string', + 'example' => 'https://a-hbr-temp-cn-hangzhou-staging.oss-cn-hangzhou.aliyuncs.com/temp/report/162319438359****/job-000bb6fwqficjbxk****/job-000bb6fwqficjbxk****_failed.zip?Expires=1721201422&OSSAccessKeyId=LTA****************&Signature=Fp%2BvauORTIVxooXY2tec6z0T%2Bp4%3D', + ], + ], + ], + ], + ], + ], + 'Includes' => [ + 'description' => '过滤directory下目录，传输过滤目录内包含的文件夹内容。'."\n" + ."\n" + .'> 仅CPFS智算版支持该功能。', + 'type' => 'string', + 'example' => '["/test/","/test1/"]'."\n", + ], + 'TransferFileListPath' => [ + 'description' => '指定oss目录，根据oss目录中的csv文件的内容同步数据。'."\n" + .'> 仅CPFS智算版支持该功能。', + 'type' => 'string', + 'example' => '/path_in_cpfs/'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesystemVersion.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem version.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invaild.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidMaxResults', + 'errorMessage' => 'The specified MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'The specified Filter.N.Key is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\",\\n \\"NextToken\\": \\"TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=\\",\\n \\"TaskInfo\\": {\\n \\"Task\\": [\\n {\\n \\"FilesystemId\\": \\"bmcpfs-290w65p03ok64ya****\\",\\n \\"DataFlowId\\": \\"df-194433a5be31****\\",\\n \\"TaskId\\": \\"task-38aa8e890f45****\\",\\n \\"SourceStorage\\": \\"oss://178321033379****:bucket-01\\",\\n \\"FileSystemPath\\": \\"/a/b/c/\\",\\n \\"Originator\\": \\"User\\",\\n \\"TaskAction\\": \\"Import\\",\\n \\"DataType\\": \\"MetaAndData \\",\\n \\"Progress\\": 50,\\n \\"Status\\": \\"Failed\\",\\n \\"ReportPath\\": \\"/path_in_cpfs/reportfile.cvs\\",\\n \\"CreateTime\\": \\"2021-08-04 18:27:35\\",\\n \\"StartTime\\": \\"2021-08-04 18:27:35\\",\\n \\"EndTime\\": \\"2021-08-04 18:27:35\\",\\n \\"FsPath\\": \\"/aa/\\",\\n \\"ConflictPolicy\\": \\"KEEP_LATEST\\",\\n \\"Directory\\": \\"/path_in_cpfs/\\",\\n \\"DstDirectory\\": \\"/path_in_cpfs/\\\\n\\",\\n \\"ErrorMsg\\": \\"{\\\\\\"ErrorKey\\\\\\":\\\\\\"PATH_NOT_ACCESSIBLE\\\\\\",\\\\\\"ErrorDetail\\\\\\":\\\\\\"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory\\\\\\"}\\",\\n \\"ProgressStats\\": {\\n \\"FilesTotal\\": 3,\\n \\"FilesDone\\": 3,\\n \\"ActualFiles\\": 3,\\n \\"BytesTotal\\": 131092971520,\\n \\"BytesDone\\": 131092971520,\\n \\"ActualBytes\\": 131092971520,\\n \\"RemainTime\\": 437,\\n \\"AverageSpeed\\": 342279299\\n },\\n \\"Reports\\": {\\n \\"Report\\": [\\n {\\n \\"Name\\": \\"TotalFilesReport\\",\\n \\"Path\\": \\"https://a-hbr-temp-cn-hangzhou-staging.oss-cn-hangzhou.aliyuncs.com/temp/report/162319438359****/job-000bb6fwqficjbxk****/job-000bb6fwqficjbxk****_failed.zip?Expires=1721201422&OSSAccessKeyId=LTA****************&Signature=Fp%2BvauORTIVxooXY2tec6z0T%2Bp4%3D\\"\\n }\\n ]\\n },\\n \\"Includes\\": \\"[\\\\\\"/test/\\\\\\",\\\\\\"/test1/\\\\\\"]\\\\n\\",\\n \\"TransferFileListPath\\": \\"/path_in_cpfs/\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataFlowTasksResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n <NextToken>TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=</NextToken>\\n <TaskInfo>\\n <FilesystemId>cpfs-099394bd928c****</FilesystemId>\\n <DataFlowId>dfid-194433a5be3****</DataFlowId>\\n <TaskId>taskId-12345678</TaskId>\\n <SourceStorage>oss://bucket1</SourceStorage>\\n <FileSystemPath>/a/b/c/</FileSystemPath>\\n <Originator>User</Originator>\\n <TaskAction>Import</TaskAction>\\n <DataType>Metadata</DataType>\\n <Progress>240</Progress>\\n <Status>Executing</Status>\\n <ReportPath>/path_in_cpfs/reportfile.cvs</ReportPath>\\n <CreateTime>2021-08-04 18:27:35</CreateTime>\\n <StartTime>2021-08-04 18:27:35</StartTime>\\n <EndTime>2021-08-04 18:27:35</EndTime>\\n <FsPath>/aa/</FsPath>\\n </TaskInfo>\\n</DescribeDataFlowTasksResponse>","errorExample":""}]', + 'title' => '查询数据流动任务列表', + 'description' => '仅CPFS 2.2.0及以上版本、CPFS智算版2.4.0及以上版本支持查询数据流动任务。您可以在控制台文件系统详情页面查看版本信息。', + ], + 'DescribeDataFlowSubTasks' => [ + 'summary' => '查询数据流动批量子任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225738', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '特殊用户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bmcpfs-370lx1ev9ss27o0****'."\n", + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '查询数据流动流式任务的筛选键。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '筛选键的名称。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- DataFlowIds: 根据DataFlow ID筛选。'."\n" + .'- DataFlowTaskIds：根据数据流动任务的ID筛选。'."\n" + .'- DataFlowSubTaskIds：根据数据流动流式任务的ID筛选。'."\n" + .'- Status：根据数据流动状态筛选。'."\n" + .'- SrcFilePath：根据源目标文件路径筛选。'."\n" + .'- DstFilePath：根据目标文件路径筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'DataFlowSubTaskIds', + 'enum' => [ + 'DataFlowIds', + 'DataFlowTaskIds', + 'DataFlowSubTaskIds', + 'Status', + 'SrcFilePath', + 'DstFilePath', + ], + ], + 'Value' => [ + 'description' => '筛选键的值。该参数不支持通配符。'."\n" + ."\n" + .'- Key取值为DataFlowIds时，Value取值为数据流动ID或数据流动ID的一部分。可以是一个或一组DataFlowId，数据流动ID最多可设置10个。例如，`df-194433a5be31****`或`df-194433a512a2****,df-234533a5be31****`。'."\n" + .'- 当Key取值为DataFlowTaskIds时，Value取值为数据流动任务ID或数据流动任务ID的部分。可以是一个或一组数据流动任务ID，数据流动任务ID最多可设置10个。例如，`task-29ee8e890f45****`或`task-29ee8e890f45****,task-38ae8e890f45****`。'."\n" + .'- 当Key取值为DataFlowSubTaskIds时，Value取值为数据流动流式任务ID或数据流动流式任务ID的部分。可以是一个或一组数据流动流式任务ID，数据流动流式任务ID最多可设置10个。例如，`subTaskId-370kyfmyknxcyzw****'."\n" + .'`或`subTaskId-247kyfmyknxcyzw****,subTaskId-256kyfmyknxcyzw****`。'."\n" + .'- 当Key取值为Status时，Value取值为数据流动任务的状态，包括EXPIRED、CREATED、RUNNING、COMPLETE、CANCELING、FAILED和CANCELED。支持组合查询。'."\n" + .'- 当Key取值为SrcFilePath时，Value取值为源目标文件路径。最长为1023个字符。'."\n" + .'- 当Key取值为DstFilePath时，Value取值为目标文件路径。最长为1023个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'subTaskId-370kyfmyknxcyzw****'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 12, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'iWk0AQAAAAAvY2FzZS8=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询结果的个数限制。'."\n" + ."\n" + .' - 取值范围：20~100'."\n" + ."\n\n" + .'- 默认值：20', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'NextToken' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'example' => 'pUJaUwAAAABhdGUyNTk1MQ==', + ], + 'DataFlowSubTask' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataFlowSubTask' => [ + 'description' => '数据流动流式任务信息合集。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => 'bmcpfs-370lx1ev9ss27o0****'."\n", + ], + 'DataFlowId' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'example' => 'df-194433a5be31****'."\n", + ], + 'DataFlowTaskId' => [ + 'description' => '数据流动任务ID。', + 'type' => 'string', + 'example' => 'task-38aa8e890f45****', + ], + 'DataFlowSubTaskId' => [ + 'description' => '数据流动流式任务ID。', + 'type' => 'string', + 'example' => 'subTaskId-370kyfmyknxcyzw****'."\n", + ], + 'SrcFilePath' => [ + 'description' => '源文件路径。'."\n" + .'限制：'."\n" + .'- 长度为 1~1023 个字符。'."\n" + .'- 使用 UTF-8 编码。'."\n" + .'- 必须以正斜线（/）开头。'."\n" + .'- 必须以文件名称结尾。', + 'type' => 'string', + 'example' => '/test/file.png'."\n", + ], + 'DstFilePath' => [ + 'description' => '目标文件路径。'."\n" + .'限制：'."\n" + .'- 长度为 1~1023 个字符。'."\n" + .'- 使用 UTF-8 编码。'."\n" + .'- 必须以正斜线（/）开头。'."\n" + .'- 必须以文件名称结尾。', + 'type' => 'string', + 'example' => '/mnt/file.png'."\n", + ], + 'Status' => [ + 'description' => '当前数据流动流式任务状态。包括：'."\n" + ."\n" + .'- EXPIRED：任务已终止。'."\n" + .'- CREATED：任务已创建完成。 '."\n" + .'- RUNNING：任务正在运行中。'."\n" + .'- COMPLETE：任务已完成。'."\n" + .'- CANCELING：任务取消中。'."\n" + .'- FAILED：任务执行失败。'."\n" + .'- CANCELED：任务已取消。', + 'type' => 'string', + 'example' => 'FAILED', + ], + 'Progress' => [ + 'description' => '数据流动流式任务的执行进度。范围：0~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'CreateTime' => [ + 'description' => '流式任务创建时间。', + 'type' => 'string', + 'example' => '2024-07-01 19:59:29', + ], + 'StartTime' => [ + 'description' => '流式任务开始执行时间。', + 'type' => 'string', + 'example' => '2024-07-03 10:43:16', + ], + 'EndTime' => [ + 'description' => '流式任务结束时间。', + 'type' => 'string', + 'example' => '2024-07-04 11:14:22', + ], + 'ErrorMsg' => [ + 'description' => '任务执行失败消息。'."\n" + .'> 当该字段未返回或者返回为空时，表示没有错误信息。', + 'type' => 'string', + 'example' => 'file does not exist', + ], + 'ProgressStats' => [ + 'description' => '数据流动流式进度信息。', + 'type' => 'object', + 'properties' => [ + 'BytesTotal' => [ + 'description' => '源端扫描到数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '68', + ], + 'BytesDone' => [ + 'description' => '已完成数据流动数据量（包括跳过数据）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '68', + ], + 'ActualBytes' => [ + 'description' => '实际流动数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '68', + ], + 'AverageSpeed' => [ + 'description' => '平均流动速度。单位：Byte/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34', + ], + ], + ], + 'FileDetail' => [ + 'description' => '文件信息。', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '文件修改时间，unix时间戳。单位：ns。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1725897600000000000', + ], + 'Size' => [ + 'description' => '文件大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '68', + ], + 'Checksum' => [ + 'description' => '文件校验码。格式示例：crc64:123456。', + 'type' => 'string', + 'example' => 'crc64:850309505450944****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidFilesystemVersion.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem version.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invaild.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidMaxResults', + 'errorMessage' => 'The specified MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'The specified Filter.N.Key is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"NextToken\\": \\"pUJaUwAAAABhdGUyNTk1MQ==\\",\\n \\"DataFlowSubTask\\": {\\n \\"DataFlowSubTask\\": [\\n {\\n \\"FileSystemId\\": \\"bmcpfs-370lx1ev9ss27o0****\\\\n\\",\\n \\"DataFlowId\\": \\"df-194433a5be31****\\\\n\\",\\n \\"DataFlowTaskId\\": \\"task-38aa8e890f45****\\",\\n \\"DataFlowSubTaskId\\": \\"subTaskId-370kyfmyknxcyzw****\\\\n\\",\\n \\"SrcFilePath\\": \\"/test/file.png\\\\n\\",\\n \\"DstFilePath\\": \\"/mnt/file.png\\\\n\\",\\n \\"Status\\": \\"FAILED\\",\\n \\"Progress\\": 10000,\\n \\"CreateTime\\": \\"2024-07-01 19:59:29\\",\\n \\"StartTime\\": \\"2024-07-03 10:43:16\\",\\n \\"EndTime\\": \\"2024-07-04 11:14:22\\",\\n \\"ErrorMsg\\": \\"file does not exist\\",\\n \\"ProgressStats\\": {\\n \\"BytesTotal\\": 68,\\n \\"BytesDone\\": 68,\\n \\"ActualBytes\\": 68,\\n \\"AverageSpeed\\": 34\\n },\\n \\"FileDetail\\": {\\n \\"ModifyTime\\": 1725897600000000000,\\n \\"Size\\": 68,\\n \\"Checksum\\": \\"crc64:850309505450944****\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据流动流式子任务列表', + 'description' => '仅CPFS智算版2.6.0 及以上版本支持。您可以在控制台文件系统详情页面查看版本信息。', + ], + 'ApplyDataFlowAutoRefresh' => [ + 'summary' => '为指定数据流动配置自动更新。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59398', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'AutoRefreshs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '自动更新配置信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshPath' => [ + 'description' => '自动更新目录，CPFS仅自动检查该目录下的源端数据是否发生更新并自动导入更新的数据。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~1024个字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以正斜线（/）开头和结尾。'."\n" + ."\n" + .'> 该目录必须是CPFS上的已有目录，且必须位于开启了数据流动的Fileset中。', + 'type' => 'string', + 'required' => true, + 'example' => '/prefix1/prefix2/', + 'maxLength' => 1024, + 'minLength' => 2, + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'AutoRefreshPolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '自动更新策略，源端数据更新以后，数据更新导入到CPFS的策略。包括：'."\n" + ."\n" + .'- None：源端的数据更新不自动导入CPFS，用户可通过数据流动任务导入源端的数据更新。'."\n" + .'- ImportChanged：源端的数据更新自动导入CPFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'None', + 'enum' => [ + 'None', + 'ImportChanged', + ], + ], + ], + [ + 'name' => 'AutoRefreshInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '自动更新的间隔时间。每隔该时间间隔，CPFS会检查目录内是否存在数据更新，如果有数据更新，启动自动更新任务。单位为分钟。'."\n" + ."\n" + .'取值范围：10~525600。默认值：10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '525600', + 'minimum' => '5', + 'example' => '10', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is not permitted when the status is processing.', + ], + [ + 'errorCode' => 'InvalidFileSystem.AlreadyExisted', + 'errorMessage' => 'The specified file system already exists.', + ], + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.NestedDir', + 'errorMessage' => 'The operation is denied due to nested directory.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.InvalidParameter', + 'errorMessage' => 'Refresh path is invalid.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.NotFound', + 'errorMessage' => 'Refresh path does not exist.', + ], + [ + 'errorCode' => 'InvalidRefreshPolicy.InvalidParameter', + 'errorMessage' => 'Refresh policy is invalid.', + ], + [ + 'errorCode' => 'InvalidRefreshInterval.OutOfBounds', + 'errorMessage' => 'Refresh interval is out of bounds.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.AlreadyExist', + 'errorMessage' => 'The refresh path already exists.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.TooManyPaths', + 'errorMessage' => 'The number of refresh paths exceeds the limit.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<ApplyDataFlowAutoRefreshResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</ApplyDataFlowAutoRefreshResponse>","errorExample":""}]', + 'title' => '添加数据流动自动更新配置', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + .'- 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 仅支持状态为`Running（正常）`状态的数据流动添加自动更新配置。'."\n" + .'- 一个数据流动最多可以添加5个自动更新配置。'."\n" + ."\n" + .'- 创建自动更新配置一般耗时2～5分钟，您可以通过[DescribeDataFlows](~~336901~~)查询数据流动状态。'."\n" + ."\n" + .'- 自动更新依赖EventBridge收集源端OSS存储的对象修改事件。需要先[开通EventBridge服务](~~182246~~)。'."\n" + ."\n" + .' > CPFS在EventBridge创建的事件总线、事件规则带有`Create for cpfs auto refresh`的描述，事件总线、事件规则都不能修改和删除，否则自动更新无法正常工作。'."\n" + ."\n" + .'- 自动更新的作用对象是prefix，由参数RefreshPath指定。在CPFS数据流动对prefix配置自动更新时，会在用户侧创建事件总线，并创建源端OSS Bucket的prefix的事件规则。当源端OSS Bucket的prefix内发生对象修改后，会在EventBridge中产生OSS事件，由CPFS数据流动处理。'."\n" + .'- 配置自动更新（AutoRefresh）后，当源端存储数据发生变化时，变化的元数据会自动同步到CPFS文件系统，变化的数据会在用户访问文件时按需加载，或者启动数据流动任务加载数据。'."\n" + .'- 自动更新间隔（AutoRefreshInterval）指CPFS每隔该时间间隔，检查源端OSS Bucket该prefix内是否存在数据更新，如果有数据更新则启动自动更新任务。当OSS源端的对象修改事件频率超过CPFS数据流动处理能力时，自动更新任务会堆积，元数据更新会延迟，数据流动的状态为Misconfigured，您可以提升数据流动规格，或者降低OSS修改频率来解决。', + ], + 'CancelDataFlowAutoRefresh' => [ + 'summary' => '取消指定数据流动上的自动更新配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59403', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'RefreshPath', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '需要取消自动更新配置的目录。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~1024个字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以正斜线（/）开头和结尾。'."\n" + ."\n" + .'> 该目录必须是CPFS上的已有目录，且必须位于开启了数据流动的Fileset中。', + 'type' => 'string', + 'required' => true, + 'example' => '/prefix1/prefix2/', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建数据流动。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但DataFlowld为空。'."\n" + .'- false（默认值）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.InvalidParameter', + 'errorMessage' => 'Refresh path is invalid.', + ], + [ + 'errorCode' => 'InvalidRefreshPath.NotFound', + 'errorMessage' => 'Refresh path does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelDataFlowAutoRefreshResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</CancelDataFlowAutoRefreshResponse>","errorExample":""}]', + 'title' => '取消数据流动自动更新配置', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + .'- 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 仅支持取消`Running（正常）`、`Stopped（停止）`状态数据流动的自动更新配置。'."\n" + ."\n" + .'- 取消自动更新配置一般耗时2～5分钟，您可以通过[DescribeDataFlows](~~2402270~~)查询取消自动更新任务的状态。', + ], + 'ModifyDataFlowAutoRefresh' => [ + 'summary' => '修改数据流动中的自动更新配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59400', + 'abilityTreeNodes' => [ + 'FEATUREnasPWYFYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'DataFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据流动ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'df-194433a5be31****', + ], + ], + [ + 'name' => 'AutoRefreshPolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '自动更新策略，源端数据更新以后，数据更新导入到CPFS的策略。包括：'."\n" + ."\n" + .'- None：源端的数据更新不自动导入CPFS，用户可通过数据流动任务导入源端的数据更新。'."\n" + .'- ImportChanged：源端的数据更新自动导入CPFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'enum' => [ + 'None', + 'ImportChanged', + ], + ], + ], + [ + 'name' => 'AutoRefreshInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '自动更新间隔时间。每隔该时间间隔，CPFS会检查目录内是否存在数据更新，如果有数据更新，启动自动更新任务。单位为分钟。'."\n" + ."\n" + .'取值范围：5~526600。默认值：10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '525600', + 'minimum' => '5', + 'example' => '10', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和NAS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但FileSystemId为空。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalCharacters', + 'errorMessage' => 'The parameter contains illegal characters.', + ], + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingDataFlowId', + 'errorMessage' => 'DataFlowId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DependencyViolation', + 'errorMessage' => 'The operation is denied due to dependancy violation.', + ], + [ + 'errorCode' => 'OperationDenied.ConflictOperation', + 'errorMessage' => 'The operation is denied due to a conflict with an ongoing operation.', + ], + [ + 'errorCode' => 'OperationDenied.DataFlowNotSupported', + 'errorMessage' => 'The operation is not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDataFlow.NotFound', + 'errorMessage' => 'The specified data flow does not exist.', + ], + [ + 'errorCode' => 'InvalidRefreshPolicy.InvalidParameter', + 'errorMessage' => 'Refresh policy is invalid.', + ], + [ + 'errorCode' => 'InvalidRefreshInterval.OutOfBounds', + 'errorMessage' => 'Refresh interval is out of bounds.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDataFlowAutoRefreshResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</ModifyDataFlowAutoRefreshResponse>","errorExample":""}]', + 'title' => '修改数据流动自动更新配置', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + .'- 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。'."\n" + .'- 仅支持修改`Running（正常`）、`Stopped（停止）`状态数据流动的自动更新配置。'."\n" + ."\n" + .'- 修改自动更新配置一般耗时2～5分钟，您可以通过[DescribeDataFlows](~~2402270~~)查询修改自动更新任务的状态。', + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改文件系统实例所属的资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '202852', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区所在的地域ID。'."\n" + ."\n" + .'您可以调用[DescribeRegions](~~2412111~~)查看最新地域列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => '资源ID。', + 'type' => 'string', + 'required' => true, + 'example' => '31a8e4****', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '新资源组ID。'."\n" + ."\n" + .'您可以通过[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups?)查看资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfmwavnfdf****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'取值：filesystem（文件系统）', + 'type' => 'string', + 'required' => true, + 'example' => 'filesystem', + 'enum' => [ + 'filesystem', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\"\\n}","type":"json"}]', + 'title' => '更改资源组', + ], + 'CreateProtocolService' => [ + 'summary' => '创建CPFS文件系统的协议服务，创建协议服务过程大约需要5～10分钟。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '124566', + 'abilityTreeNodes' => [ + 'FEATUREnas155MFA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + 'enum' => [], + ], + ], + [ + 'name' => 'ProtocolSpec', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务的规格。'."\n" + ."\n" + .'取值： General（默认值）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'General', + 'enum' => [ + 'CL2', + 'General', + 'CL1', + ], + ], + ], + [ + 'name' => 'Throughput', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务的带宽。'."\n" + ."\n" + .'单位：MB/s。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8000', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务的协议类型。'."\n" + ."\n" + .'取值：NFS（默认值），仅支持NFSv3协议访问。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFS', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务的描述。控制台中显示为“协议服务名称”。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => '此协议服务的描述。', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '协议服务 VpcId，需与文件系统 VPC 保持一致。'."\n" + ."\n" + .'当文件系统的存储冗余类型为 同城冗余（ZRS）时禁止设置该字段。其他情况，该字段必填', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-2vct297b8157bth9z****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '协议服务 VSwitchId。'."\n" + ."\n" + .'当文件系统的存储冗余类型为 同城冗余（ZRS）时禁止设置该字段。其他情况，该字段必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vsw-2vc3c2lybvdllxyq4****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + ."\n" + .'预检操作会帮助您检查参数有效性、依赖条件等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + .'- true：发送检查请求，不会创建协议服务。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但ProtocolServiceId为空。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + 'ProtocolServiceId' => [ + 'description' => '协议机集群ID。', + 'type' => 'string', + 'example' => 'ptc-197ed6a00f2b****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingVpcId', + 'errorMessage' => 'VpcId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingVSwitchId', + 'errorMessage' => 'VSwitchId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidProtocolSpec.NotSupported', + 'errorMessage' => 'The specified protocol spec does not supported.', + ], + [ + 'errorCode' => 'InvalidNetworkType.NotSupported', + 'errorMessage' => 'The specified network type does not supported.', + ], + [ + 'errorCode' => 'Instance.IncorrectStatus', + 'errorMessage' => 'The specified instance is in an incorrect status.', + ], + [ + 'errorCode' => 'OperationDenied.ProtocolServiceExceedLimit', + 'errorMessage' => 'The protocol service amount exceed file system limit.', + ], + [ + 'errorCode' => 'PermissionDenied.CapacityTooLow', + 'errorMessage' => 'Capacity of file system too low to subscribe protocol service.', + ], + [ + 'errorCode' => 'PermissionDenied.ThroughputInvalid', + 'errorMessage' => 'Standard protocol service should not specified throughput.', + ], + [ + 'errorCode' => 'PermissionDenied.ThroughputTooSmall', + 'errorMessage' => 'Throughput of protocol service too small.', + ], + [ + 'errorCode' => 'PermissionDenied.ThroughputExceed', + 'errorMessage' => 'Throughput of protocol service must less than throughput of file system.', + ], + [ + 'errorCode' => 'InvalidProtocolType.NotSupported', + 'errorMessage' => 'The specified protocol type does not supported.', + ], + [ + 'errorCode' => 'InvalidVSwitchId.IpShortage', + 'errorMessage' => 'The specified vswitch ip shortage.', + ], + [ + 'errorCode' => 'InvalidFset.InUse', + 'errorMessage' => 'Fset already used by other export.', + ], + [ + 'errorCode' => 'InvalidFileSystemPath.InvalidCharacters', + 'errorMessage' => 'The specified filesystem path contains invalid characters.', + ], + [ + 'errorCode' => 'MntPathConflict.InvalidParam', + 'errorMessage' => 'FilesetId and Path must and can only be specified one.', + ], + [ + 'errorCode' => 'OperationDenied.TooManyDepth', + 'errorMessage' => 'The operation is denied due to Fsets path too deep.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is denied due to invalid file system state.', + ], + [ + 'errorCode' => 'OperationDenied.NoProtocolServiceQuota', + 'errorMessage' => 'No protocol service quota.', + ], + [ + 'errorCode' => 'OperationDenied.NotSupported', + 'errorMessage' => 'The operation is denied due to not supported.', + ], + [ + 'errorCode' => 'PermissionDenied.CLThroughputInvalid', + 'errorMessage' => 'Throughput of caching protocol service is invalid.', + ], + [ + 'errorCode' => 'InvalidVpcId.CrossVpcNotSupport.', + 'errorMessage' => 'Cross VPC not support.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.VpcNotFound', + 'errorMessage' => 'The specified VPC does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.VswNotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidDescription.InvalidFormat', + 'errorMessage' => 'Description format is invalid.', + ], + [ + 'errorCode' => 'InvalidVpcId.ConflictVpcCidr', + 'errorMessage' => 'Vpc cidr conflict with file system', + ], + [ + 'errorCode' => 'InvalidAccessGroupName.NotFound', + 'errorMessage' => 'The specified access group does not exist.', + ], + [ + 'errorCode' => 'InvalidAccessGroupName.NotAccessRule', + 'errorMessage' => 'There has no rule in access group.', + ], + [ + 'errorCode' => 'OperationDenied.NoStock', + 'errorMessage' => 'The operation is denied due to no stock.', + ], + [ + 'errorCode' => 'PathNotExistInFileSystem.InvalidParam', + 'errorMessage' => 'Given path does not exist in file system.', + ], + [ + 'errorCode' => 'InvalidFsetId.NotFound', + 'errorMessage' => 'The specified Fileset ID does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.VpcVswitchMismatch', + 'errorMessage' => 'Given vSwitch mismatch with given VPC.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\",\\n \\"ProtocolServiceId\\": \\"ptc-197ed6a00f2b****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateProtocolServiceResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n <ProtocolServiceId>ptc-123****</ProtocolServiceId>\\n</CreateProtocolServiceResponse>","errorExample":""}]', + 'title' => '创建协议服务', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + .'- 仅CPFS 2.3.0及以上版本支持协议服务。您可以通过调用[DescribeFileSystems](~~163314~~)接口查询目标文件系统的版本号。'."\n" + ."\n" + .'- 协议服务规格'."\n" + ."\n" + .' 协议服务包括两种协议类型：通用型和缓存型。缓存型相比通用型，提供热点数据缓存能力。在命中缓存的情况下，缓存型协议服务的带宽可超过CPFS文件系统的带宽，达到协议服务设定的最大带宽值。'."\n" + .' '."\n" + .' - 通用型：为CPFS提供NFS协议访问能力和[目录级挂载点](~~427175~~)，用户无需配置POSIX客户端管理集群。该功能免费。'."\n" + .' - 缓存型：在通用型基础上提供基于LRU策略的服务端内存缓存。当数据缓存于内存中时，CPFS可提供更高的内网带宽。缓存型协议服务分为缓存1型和缓存2型两种协议服务规格，差异点为内网带宽大小和内存缓存大小。'."\n" + ."\n" + .' > 缓存型协议服务为收费服务，正在邀测。有关缓存型协议服务的付费方式，请参见[计费项](~~111858~~)。如果您有任何反馈或疑问，欢迎加入钉钉用户群（钉钉群号：31045006299）与CPFS工程师进行交流讨论。'."\n" + ."\n" + .'- 协议类型'."\n" + ."\n" + .' 仅支持NFSv3协议。'."\n" + ."\n" + .'- 其它'."\n" + ."\n" + .' - 一个CPFS文件系统只能创建一个协议服务。'."\n" + ."\n" + .' - 创建协议服务会消耗指定vSwitch上的IP地址（最多消耗32个IP地址），请确保目标vSwitch IP资源充足。', + ], + 'DeleteProtocolService' => [ + 'summary' => '删除CPFS文件系统的协议服务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '124951', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + 'FEATUREnasRXWLI5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtocolServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ptc-197ed6a00f2b****', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + 'enum' => [], + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次修改请求执行预检。 预检操作会帮助您检查参数有效性、依赖条件等，并不会实际修改实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会修改协议服务。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接修改协议服务。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingProtocolServiceId', + 'errorMessage' => 'ProtocolServiceId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Instance.IncorrectStatus', + 'errorMessage' => 'The specified instance is in an incorrect status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidPtcStatus', + 'errorMessage' => 'The operation is denied due to invalid protocol service status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is denied due to invalid file system state.', + ], + [ + 'errorCode' => 'OperationDenied.NotSupported', + 'errorMessage' => 'The operation is denied due to not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidProtocolService.NotFound', + 'errorMessage' => 'The specified protocol service does not exist.', + ], + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProtocolServiceResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</DeleteProtocolServiceResponse>","errorExample":""}]', + 'title' => '删除协议服务', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + .'- 删除协议服务时，会同时删除协议服务中的导出目录。', + ], + 'ModifyProtocolService' => [ + 'summary' => '修改一个协议服务，支持修改协议服务描述信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124952', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtocolServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ptc-197ed6a00f2b****', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + 'enum' => [], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '协议服务的描述。'."\n" + ."\n" + .'限制：'."\n" + ."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '此协议服务的描述信息', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次修改请求执行预检。'."\n" + .'预检操作会帮助您检查参数有效性、依赖条件等，并不会实际修改实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + .'- true：发送检查请求，不会修改协议服务。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接修改协议服务。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingProtocolServiceId', + 'errorMessage' => 'ProtocolServiceId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Instance.IncorrectStatus', + 'errorMessage' => 'The specified instance is in an incorrect status.', + ], + [ + 'errorCode' => 'InvalidProtocolSpec.NotSupported', + 'errorMessage' => 'The specified protocol spec does not supported.', + ], + [ + 'errorCode' => 'PermissionDenied.ThroughputInvalid', + 'errorMessage' => 'Standard protocol service should not specified throughput.', + ], + [ + 'errorCode' => 'InvalidVSwitchId.IpShortage', + 'errorMessage' => 'The specified vswitch ip shortage.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidPtcStatus', + 'errorMessage' => 'The operation is denied due to invalid protocol service status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is denied due to invalid file system state.', + ], + [ + 'errorCode' => 'OperationDenied.NotSupported', + 'errorMessage' => 'The operation is denied due to not supported.', + ], + [ + 'errorCode' => 'PermissionDenied.CLThroughputInvalid', + 'errorMessage' => 'Throughput of caching protocol service is invalid.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidProtocolService.NotFound', + 'errorMessage' => 'The specified protocol service does not exist.', + ], + [ + 'errorCode' => 'InvalidDescription.InvalidFormat', + 'errorMessage' => 'Description format is invalid.', + ], + [ + 'errorCode' => 'OperationDenied.NoStock', + 'errorMessage' => 'The operation is denied due to no stock.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyProtocolServiceResponse>\\n <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>\\n</ModifyProtocolServiceResponse>","errorExample":""}]', + 'title' => '修改协议服务', + 'description' => '该接口仅适用于CPFS文件系统。', + ], + 'DescribeProtocolService' => [ + 'summary' => '查询协议服务信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124567', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtocolServiceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务ID。'."\n" + .'- 格式：CSV'."\n" + ."\n" + .'- 限制：协议服务ID最多可设置10个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ptc-197ed6a00f2b****,ptc-196ed6a00f2b****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '按照协议服务的状态作匹配。'."\n" + ."\n" + .'格式：CSV'."\n" + ."\n" + .'取值：'."\n" + .'- Creating：创建中'."\n" + .'- Starting：启动中'."\n" + .'- Running：可用'."\n" + .'- Updating：更新中'."\n" + .'- Deleting：删除中'."\n" + .'- Stopping：停止中'."\n" + .'- Stopped：停止', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Running,Updating', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'aBcdg==', + 'enum' => [], + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询结果的个数限制。'."\n" + ."\n" + .'- 最大值：100。'."\n" + .'- 最小值：10。'."\n" + .'- 默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + 'enum' => [], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务的描述或描述的一部分作匹配。'."\n" + ."\n" + .'限制：'."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '此协议服务的描述', + 'maxLength' => 128, + 'minLength' => 2, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + .'>若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'NextToken' => [ + 'description' => '用户继续查询剩余协议服务的Marker。', + 'type' => 'string', + 'example' => 'aBcdeg==', + ], + 'ProtocolServices' => [ + 'description' => '协议机服务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '协议服务信息。', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => 'cpfs-099394bd928c****', + ], + 'ProtocolServiceId' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'example' => 'ptc-197ed6a00f2b****', + ], + 'ProtocolSpec' => [ + 'description' => '协议机集群的规格。'."\n" + .'- 取值范围：General'."\n" + .'- 默认值：General', + 'type' => 'string', + 'example' => 'General', + ], + 'ProtocolThroughput' => [ + 'description' => '协议服务的吞吐。单位：MB/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'InstanceRAM' => [ + 'description' => '协议节点的内存缓存大小。单位：GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceBaseThroughput' => [ + 'description' => '协议节点的Base吞吐。单位：MB/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstanceBurstThroughput' => [ + 'description' => '协议节点的Burst吞吐。单位：MB/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'MountTargetCount' => [ + 'description' => '此协议服务中导出的CPFS目录和Fileset总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ProtocolType' => [ + 'description' => '协议服务支持的协议类型。'."\n" + ."\n" + .'取值范围：'."\n" + .' - NFS：协议服务支持NFS协议访问。', + 'type' => 'string', + 'example' => 'NFS', + ], + 'Status' => [ + 'description' => '协议服务状态。'."\n" + ."\n" + .'取值：'."\n" + .'- Creating：创建中'."\n" + .'- Starting：启动中'."\n" + .'- Running：可用'."\n" + .'- Updating：更新中'."\n" + .'- Deleting：删除中'."\n" + .'- Stopping：停止中'."\n" + .'- Stopped：停止', + 'type' => 'string', + 'example' => 'Running', + ], + 'Description' => [ + 'description' => '协议服务的描述。'."\n" + ."\n" + .'限制：'."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'example' => '此协议服务的描述', + ], + 'CreateTime' => [ + 'description' => '协议机服务创建时间，UTC时间。', + 'type' => 'string', + 'example' => '2018-12-12T07:28:38Z', + ], + 'ModifyTime' => [ + 'description' => '协议机服务修改时间，UTC时间。', + 'type' => 'string', + 'example' => '2018-12-12T07:28:38Z', + ], + 'VpcId' => [ + 'title' => '协议服务关联的VPC ID', + 'description' => '协议服务关联的VPC ID', + 'type' => 'string', + 'example' => 'vpc-123xxx', + ], + 'VSwitchId' => [ + 'title' => '协议服务关联的VSW ID', + 'description' => '协议服务关联的VSW ID', + 'type' => 'string', + 'example' => 'vsw-123xxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidParam.TooManyProtocolServiceIds', + 'errorMessage' => 'Too many protocol service ids given.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidStatus.NotSupported', + 'errorMessage' => 'The specified protocol service status does not support.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invaild.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidMaxResults', + 'errorMessage' => 'The specified MaxResults is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"NextToken\\": \\"aBcdeg==\\",\\n \\"ProtocolServices\\": [\\n {\\n \\"FileSystemId\\": \\"cpfs-099394bd928c****\\",\\n \\"ProtocolServiceId\\": \\"ptc-197ed6a00f2b****\\",\\n \\"ProtocolSpec\\": \\"General\\",\\n \\"ProtocolThroughput\\": 500,\\n \\"InstanceRAM\\": 0,\\n \\"InstanceBaseThroughput\\": 100,\\n \\"InstanceBurstThroughput\\": 100,\\n \\"MountTargetCount\\": 5,\\n \\"ProtocolType\\": \\"NFS\\",\\n \\"Status\\": \\"Running\\",\\n \\"Description\\": \\"此协议服务的描述\\",\\n \\"CreateTime\\": \\"2018-12-12T07:28:38Z\\",\\n \\"ModifyTime\\": \\"2018-12-12T07:28:38Z\\",\\n \\"VpcId\\": \\"vpc-123xxx\\",\\n \\"VSwitchId\\": \\"vsw-123xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeProtocolServiceResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <NextToken>aBcdeg==</NextToken>\\n <ProtocolServices>\\n <ProtocolService>\\n <FileSystemId>cpfs-123****</FileSystemId>\\n <ProtocolServiceId>ptc-123***</ProtocolServiceId>\\n <ProtocolSpec>General</ProtocolSpec>\\n <ProtocolThroughput>500</ProtocolThroughput>\\n <InstanceRAM>0</InstanceRAM>\\n <InstanceBaseThroughput>100</InstanceBaseThroughput>\\n <InstanceBurstThroughput>100</InstanceBurstThroughput>\\n <MountTargetCount>5</MountTargetCount>\\n <ProtocolType>NFS</ProtocolType>\\n <Status>Running</Status>\\n <Description>此协议服务的描述</Description>\\n <CreateTime>2018-12-12T07:28:38Z</CreateTime>\\n <ModifyTime>2018-12-12T07:28:38Z</ModifyTime>\\n </ProtocolService>\\n </ProtocolServices>\\n</DescribeProtocolServiceResponse>","errorExample":""}]', + 'title' => '查询协议服务信息', + 'description' => '该接口仅适用于CPFS文件系统。', + ], + 'CreateProtocolMountTarget' => [ + 'summary' => '创建一个协议服务导出目录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124954', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtocolServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ptc-197ed6a00f2b****', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + 'enum' => [], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '协议服务导出的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-2vct297b8157bth9z****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '协议服务导出的交换机ID。'."\n" + ."\n" + .'当文件系统的存储冗余类型不为 同城冗余（ZRS）时，若设置了VpcId，则该字段必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vsw-2vc3c2lybvdllxyq4****', + ], + ], + [ + 'name' => 'FsetId', + 'in' => 'query', + 'schema' => [ + 'description' => '需导出的Fileset ID。'."\n" + ."\n" + .'限制：'."\n" + .'- 该Fileset必须已存在。'."\n" + .'- 一个Fileset只允许创建一个导出目录。'."\n" + .'- Fileset和Path只能且必须指定一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'fset-1902718ea0ae****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '需导出的CPFS目录的路径。'."\n" + ."\n" + .'限制：'."\n" + .'- 该目录必须是CPFS上的已有目录。'."\n" + .'- 同一目录只允许创建一个导出。'."\n" + .'- Fileset和Path只能且必须指定一个。'."\n" + ."\n" + .'格式：'."\n" + .'- 长度为1~1024个字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以正斜线（/）开头和结尾，根目录为`/`。', + 'type' => 'string', + 'required' => false, + 'example' => '/', + 'maxLength' => 1024, + 'minLength' => 1, + ], + ], + [ + 'name' => 'AccessGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'默认值：DEFAULT_VPC_GROUP_NAME', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_VPC_GROUP_NAME', + 'default' => 'DEFAULT_VPC_GROUP_NAME', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务导出目录的描述。控制台中显示为**导出目录名称**。'."\n" + ."\n" + .'限制：'."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => '此导出目录的描述', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检。'."\n" + .'预检操作会帮助您检查参数有效性、依赖条件等，并不会实际创建实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + .'- true：发送检查请求，不会创建导出目录。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode，但ExportId为空。'."\n" + ."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'VSwitchIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '协议服务导出的交换机 ID 列表。', + 'type' => 'array', + 'items' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '协议服务导出的交换机 ID 列表。'."\n" + ."\n" + .'当文件系统的存储冗余类型为 同城冗余（ZRS）时，若设置了VpcId，则该字段必须设置Vpc下三个不同可用区的交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-123xxx', + ], + 'required' => false, + 'maxItems' => 3, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'ExportId' => [ + 'description' => '协议服务导出目录ID。', + 'type' => 'string', + 'example' => 'exp-19abf5beab8d****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingProtocolServiceId', + 'errorMessage' => 'ProtocolServiceId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Instance.IncorrectStatus', + 'errorMessage' => 'The specified instance is in an incorrect status.', + ], + [ + 'errorCode' => 'InvalidVSwitchId.IpShortage', + 'errorMessage' => 'The specified vswitch ip shortage.', + ], + [ + 'errorCode' => 'InvalidFset.InUse', + 'errorMessage' => 'Fset already used by other export.', + ], + [ + 'errorCode' => 'MntPathConflict.InvalidParam', + 'errorMessage' => 'FilesetId and Path must and can only be specified one.', + ], + [ + 'errorCode' => 'OperationDenied.TooManyDepth', + 'errorMessage' => 'The operation is denied due to Fsets path too deep.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidPtcStatus', + 'errorMessage' => 'The operation is denied due to invalid protocol service status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is denied due to invalid file system state.', + ], + [ + 'errorCode' => 'OperationDenied.CrossVPCExceedLimit', + 'errorMessage' => 'Cross vpc mount exceed limit.', + ], + [ + 'errorCode' => 'OperationDenied.NoMountTargetQuota', + 'errorMessage' => 'No mount target quota on this protocol service.', + ], + [ + 'errorCode' => 'OperationDenied.NotSupported', + 'errorMessage' => 'The operation is denied due to not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidProtocolService.NotFound', + 'errorMessage' => 'The specified protocol service does not exist.', + ], + [ + 'errorCode' => 'InvalidVpcId.ConflictVpcCidr', + 'errorMessage' => 'Vpc cidr conflict with file system', + ], + [ + 'errorCode' => 'InvalidFsetId.NotFound', + 'errorMessage' => 'The specified fileset ID does not exist.', + ], + [ + 'errorCode' => 'Fset.IncorrectStatus', + 'errorMessage' => 'The specified fset is in an incorrect status.', + ], + [ + 'errorCode' => 'InvalidFileSystemPath.InvalidCharacters', + 'errorMessage' => 'The specified fileset path contains invalid characters.', + ], + [ + 'errorCode' => 'InvalidAccessGroupName.NotFound', + 'errorMessage' => 'The specified access group does not exist.', + ], + [ + 'errorCode' => 'InvalidAccessGroupName.NotAccessRule', + 'errorMessage' => 'There has no rule in access group.', + ], + [ + 'errorCode' => 'InvalidDescription.InvalidFormat', + 'errorMessage' => 'Description format is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.VpcNotFound', + 'errorMessage' => 'The specified VPC does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.VswNotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"ExportId\\": \\"exp-19abf5beab8d****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateProtocolMountTargetResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <ExportId>exp-123****</ExportId>\\n</CreateProtocolMountTargetResponse>","errorExample":""}]', + 'title' => '创建协议服务导出目录', + 'description' => '- 该接口仅适用于CPFS文件系统。'."\n" + ."\n" + .'- 前提条件'."\n" + .' '."\n" + .' 已创建协议服务。'."\n" + .'- 其它'."\n" + .' - 协议服务的导出VPC网段不可与文件系统VPC网段重叠。'."\n" + .' - 一个协议服务上的多个导出VPC之间网段不可重叠。'."\n" + .' - 同一个协议服务最多可以创建10个导出目录。'."\n" + .' - 创建协议服务导出目录会消耗指定vSwitch上的IP地址（最多消耗32个IP地址），请确保目标vSwitch IP资源充足。', + ], + 'DeleteProtocolMountTarget' => [ + 'summary' => '删除一个协议服务导出目录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '131496', + 'abilityTreeNodes' => [ + 'FEATUREnas5IJRRZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtocolServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ptc-197ed6a00f2b****', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '导出目录ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'exp-19abf5beab8d****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次删除请求执行预检。'."\n" + .'预检操作会帮助您检查参数有效性、依赖条件等，并不会实际删除实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true：发送检查请求，不会删除导出目录。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200HttpCode。'."\n" + ."\n" + .'- false（默认）：发送正常请求，通过检查后直接删除实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98696EF0-1607-4E9D-B01D-F20930B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingExportId', + 'errorMessage' => 'ExportId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingProtocolServiceId', + 'errorMessage' => 'ProtocolServiceId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Instance.IncorrectStatus', + 'errorMessage' => 'The specified instance is in an incorrect status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidMntStatus', + 'errorMessage' => 'The operation is denied due to invalid protocol mount targte status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidPtcStatus', + 'errorMessage' => 'The operation is denied due to invalid protocol service status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is denied due to invalid file system state.', + ], + [ + 'errorCode' => 'OperationDenied.NotSupported', + 'errorMessage' => 'The operation is denied due to not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidProtocolService.NotFound', + 'errorMessage' => 'The specified protocol service does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98696EF0-1607-4E9D-B01D-F20930B6****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProtocolMountTargetResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0*********</RequestId>\\n</DeleteProtocolMountTargetResponse>","errorExample":""}]', + 'title' => '删除协议服务导出目录', + 'description' => '该接口仅适用于CPFS文件系统。', + ], + 'ModifyProtocolMountTarget' => [ + 'summary' => '修改协议服务的导出目录参数，只能修改权限组和描述信息。VPC ID和vSwitch ID不允许修改，如果需要修改，需要删除导出目录再新建。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124957', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtocolServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ptc-197ed6a00f2b****', + ], + ], + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务导出目录ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'exp-19abf5beab8d****', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务导出目录的描述。'."\n" + ."\n" + .'限制：'."\n" + .'- 长度为2~128个英文或中文字符。'."\n" + .'- 必须以大小写字母或中文开头，不能以`http://`和`https://`开头。'."\n" + .'- 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => '此导出目录的描述信息', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次修改请求执行预检。'."\n" + .'预检操作会帮助您检查参数有效性、依赖条件等，并不会实际修改实例，也不会产生费用。'."\n" + ."\n" + .'取值：'."\n" + .'- true：发送检查请求，不会修改导出目录。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode。'."\n" + ."\n" + .'- false（默认）：发送正常。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingExportId', + 'errorMessage' => 'ExportId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingAccessGroupName', + 'errorMessage' => 'AccessGroupName is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingProtocolServiceId', + 'errorMessage' => 'ProtocolServiceId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Instance.IncorrectStatus', + 'errorMessage' => 'The specified instance is in an incorrect status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidMntStatus', + 'errorMessage' => 'The operation is denied due to invalid protocol mount targte status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidPtcStatus', + 'errorMessage' => 'The operation is denied due to invalid protocol service status.', + ], + [ + 'errorCode' => 'OperationDenied.InvalidState', + 'errorMessage' => 'The operation is denied due to invalid file system state.', + ], + [ + 'errorCode' => 'OperationDenied.NotSupported', + 'errorMessage' => 'The operation is denied due to not supported.', + ], + ], + [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidProtocolService.NotFound', + 'errorMessage' => 'The specified protocol service does not exist.', + ], + [ + 'errorCode' => 'InvalidExportId.NotFound', + 'errorMessage' => 'The specified ExportId does not exist.', + ], + [ + 'errorCode' => 'InvalidAccessGroupName.NotFound', + 'errorMessage' => 'The specified access group does not exist.', + ], + [ + 'errorCode' => 'InvalidAccessGroupName.NotAccessRule', + 'errorMessage' => 'There has no rule in access group.', + ], + [ + 'errorCode' => 'InvalidDescription.InvalidFormat', + 'errorMessage' => 'Description format is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyProtocolMountTargetResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</ModifyProtocolMountTargetResponse>","errorExample":""}]', + 'title' => '修改协议服务的导出目录参数', + 'description' => '该接口仅适用于CPFS文件系统。', + ], + 'DescribeProtocolMountTarget' => [ + 'summary' => '查询协议服务导出目录。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124960', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'aBcdg==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '每次查询结果的个数限制。'."\n" + ."\n" + .' - 取值范围：10~100'."\n" + ."\n\n" + .'- 默认值：20', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '查询协议服务导出目录的筛选键。', + 'type' => 'array', + 'items' => [ + 'description' => '查询协议服务导出目录的筛选键。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '筛选键的名称。'."\n" + ."\n" + .'- ProtocolServiceIds：根据协议服务ID筛选。'."\n" + ."\n" + .'- ExportIds：根据ExportId筛选。'."\n" + ."\n" + .'- VpcIds：根据VpcId进行筛选。'."\n" + ."\n" + .'- FsetIds：根据Fileset ID进行筛选。'."\n" + ."\n" + .'- Paths：根据挂载点对应的文件系统路径进行筛选。'."\n" + ."\n" + .'- AccessGroupNames：根据权限组名称进行筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'ExportIds', + ], + 'Value' => [ + 'description' => '筛选键的值。该参数不支持通配符。'."\n" + ."\n" + .'- Key取值为ProtocolServiceIds时，Value设置为协议服务ID，协议服务ID 最多可设置 10 个。例如`ptc-12345678`或`ptc-12345678,ptc-12345679`。'."\n" + ."\n" + .'- Key取值为ExportIds时，Value设置为导出目录ID，导出目录ID最多可设置 10 个。例如`exp-12345678`或`exp-12345678,exp-12345679`。'."\n" + ."\n" + .'- Key取值为VpcIds时，Value设置为协议服务所在的VpcId， Vpc Id最多可设置 10 个。例如 `vpc-12345678`或`vpc-12345678,vpc-12345679`。'."\n" + ."\n" + .'- Key取值为FsetIds时，Value设置为Fileset ID，Fileset ID 最多可设置 10 个。例如 `fset-12345678`或`fset-12345678,fset-12345679`。'."\n" + ."\n" + .'- Key取值为Paths时，Value设置为挂载点对应的文件系统目录，Path最多可设置 10 个。例如 `/cpfs/mnt_1/`或`/cpfs/mnt_1/,/cpfs/mnt_2/`。'."\n" + ."\n" + .'- Key取值为AccessGroupNames时，Value值设置为协议服务的权限组名称，AccessGroupName最多可设置 10 个。例如 `ag-12345678`或`ag-12345678,ag-12345679`。', + 'type' => 'string', + 'required' => false, + 'example' => 'exp-19abf5beab8d****, exp-19acf6beaf7d****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ProtocolServiceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '协议服务Id列表', + 'description' => '协议服务Id列表', + 'type' => 'string', + 'required' => false, + 'example' => 'ptc-123xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0****', + ], + 'NextToken' => [ + 'description' => '用户继续查询剩余导出目录的Marker。', + 'type' => 'string', + 'example' => 'aBcdeg==', + ], + 'ProtocolMountTargets' => [ + 'description' => ' '."\n" + .'协议服务导出目录集合。', + 'type' => 'array', + 'items' => [ + 'description' => '协议服务导出目录。', + 'type' => 'object', + 'properties' => [ + 'ExportId' => [ + 'description' => '协议服务导出目录ID。', + 'type' => 'string', + 'example' => 'exp-19abf5beab8d****', + ], + 'ProtocolMountTargetDomain' => [ + 'description' => '协议服务导出目录的域名。', + 'type' => 'string', + 'example' => 'cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com', + ], + 'ProtocolType' => [ + 'description' => '协议服务支持的协议类型。', + 'type' => 'string', + 'example' => 'NFS', + ], + 'VpcId' => [ + 'description' => '协议服务导出的专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-2vct297b8157bth9z****', + ], + 'VSwitchId' => [ + 'description' => '协议服务导出的交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2vc3c2lybvdllxyq4****', + ], + 'FsetId' => [ + 'description' => '协议服务导出的Fileset ID。', + 'type' => 'string', + 'example' => 'fset-1902718ea0ae****', + ], + 'Path' => [ + 'description' => '协议服务导出的目录。', + 'type' => 'string', + 'example' => '/path/', + ], + 'AccessGroupName' => [ + 'description' => '协议服务导出目录绑定的权限组。', + 'type' => 'string', + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + 'CreateTime' => [ + 'description' => '协议服务导出目录创建时间。', + 'type' => 'string', + 'example' => '2018-12-12T07:28:38Z', + ], + 'Status' => [ + 'description' => '挂载点状态。', + 'type' => 'string', + 'example' => 'CREATING', + ], + 'ProtocolServiceId' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'example' => 'ptc-123****', + ], + 'Description' => [ + 'description' => '协议服务导出目录的描述。'."\n", + 'type' => 'string', + 'example' => '此协议服务导出目录的描述。', + ], + 'VSwitchIds' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '同城冗余虚拟交换机ID列表', + 'type' => 'array', + 'items' => [ + 'title' => '同城冗余虚拟交换机ID列表', + 'description' => '同城冗余虚拟交换机ID列表', + 'type' => 'string', + 'example' => 'vsw-123xxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidNextToken', + 'errorMessage' => 'The specified NextToken is invaild.', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidMaxResults', + 'errorMessage' => 'The specified MaxResults is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterValue', + 'errorMessage' => 'The specified Filter.N.Value is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'The specified Filter.N.Key is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0****\\",\\n \\"NextToken\\": \\"aBcdeg==\\",\\n \\"ProtocolMountTargets\\": [\\n {\\n \\"ExportId\\": \\"exp-19abf5beab8d****\\",\\n \\"ProtocolMountTargetDomain\\": \\"cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com\\",\\n \\"ProtocolType\\": \\"NFS\\",\\n \\"VpcId\\": \\"vpc-2vct297b8157bth9z****\\",\\n \\"VSwitchId\\": \\"vsw-2vc3c2lybvdllxyq4****\\",\\n \\"FsetId\\": \\"fset-1902718ea0ae****\\",\\n \\"Path\\": \\"/path/\\",\\n \\"AccessGroupName\\": \\"DEFAULT_VPC_GROUP_NAME\\",\\n \\"CreateTime\\": \\"2018-12-12T07:28:38Z\\",\\n \\"Status\\": \\"CREATING\\",\\n \\"ProtocolServiceId\\": \\"ptc-123****\\",\\n \\"Description\\": \\"此协议服务导出目录的描述。\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-123xxx\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeProtocolMountTargetResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0****</RequestId>\\n <NextToken>aBcdeg==</NextToken>\\n <ProtocolMountTargets>\\n <ProtocolMountTarget>\\n <ExportId>exp-123****</ExportId>\\n <ProtocolMountTargetDomain>cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com</ProtocolMountTargetDomain>\\n <ProtocolType>NFS</ProtocolType>\\n <VpcId>vpc-123***</VpcId>\\n <VSwitchId>vsw-123****</VSwitchId>\\n <FsetId>fset-123****</FsetId>\\n <Path>/path/</Path>\\n <AccessGroupName>DEFAULT_VPC_GROUP_NAME</AccessGroupName>\\n <CreateTime>2018-12-12T07:28:38Z</CreateTime>\\n <Status>CREATING</Status>\\n <ProtocolServiceId>ptc-123****</ProtocolServiceId>\\n <Description>此协议服务导出目录的描述。</Description>\\n </ProtocolMountTarget>\\n </ProtocolMountTargets>\\n</DescribeProtocolMountTargetResponse>","errorExample":""}]', + 'title' => '查询协议服务导出目录', + 'description' => '该接口仅适用于CPFS文件系统。', + ], + 'GetProtocolMountTarget' => [ + 'summary' => '查询协议服务导出目录信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124960', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'M18xMA==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '每次查询结果的个数。'."\n" + ."\n" + .'取值范围：10~100。默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'- CPFS：必须以`cpfs-`开头，例如cpfs-125487\\*\\*\\*\\*。'."\n" + ."\n" + .'- CPFS智算版：必须以`bmcpfs-`开头，例如bmcpfs-0015\\*\\*\\*\\*。'."\n" + .'- CPFS SE：必须以`cpfsse-`开头，例如cpfsse-022c71b134\\*\\*\\*\\*。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpfs-099394bd928c****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ProtocolServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ptc-197ed6a00f2b****', + ], + ], + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '协议服务导出目录ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'exp-19abf5beab8d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6299428C-3861-435D-AE54-9B330A00****', + ], + 'NextToken' => [ + 'description' => '当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。', + 'type' => 'string', + 'example' => 'M18xMA==', + ], + 'ProtocolMountTarget' => [ + 'description' => '协议服务导出目录信息', + 'type' => 'object', + 'properties' => [ + 'ExportId' => [ + 'description' => '导出目录ID。', + 'type' => 'string', + 'example' => 'exp-19abf5beab8d****', + ], + 'ProtocolMountTargetDomain' => [ + 'description' => '协议服务导出目录的域名。', + 'type' => 'string', + 'example' => 'cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com', + ], + 'ProtocolType' => [ + 'description' => '文件系统协议类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- NFS：NFS文件协议'."\n" + .'- SMB：SMB文件协议'."\n" + .'- cpfs：CPFS文件系统支持的协议类型', + 'type' => 'string', + 'example' => 'NFS', + ], + 'VpcId' => [ + 'description' => '协议服务导出的专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1h5mxoqfuo3xurf****', + ], + 'VSwitchId' => [ + 'description' => '协议服务导出的交换机ID。', + 'type' => 'string', + 'example' => 'vsw-8vb2qjnxs6hiobzve****', + ], + 'VSwitchIds' => [ + 'description' => '协议服务导出的交换机 ID 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '协议服务导出的交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1q3ro8erikjjrb2****', + ], + ], + 'FsetId' => [ + 'description' => 'Fileset ID。', + 'type' => 'string', + 'example' => 'fset-299b4ca04de8****', + ], + 'Path' => [ + 'description' => '查询到的CPFS目录的路径。'."\n" + ."\n" + .'格式：'."\n" + .'- 长度为1~1024个字符。'."\n" + .'- 使用UTF-8编码。'."\n" + .'- 必须以正斜线（/）开头和结尾，根目录为`/`。', + 'type' => 'string', + 'example' => '/', + ], + 'AccessGroupName' => [ + 'description' => '权限组名称。'."\n" + ."\n" + .'默认权限组：DEFAULT_VPC_GROUP_NAME', + 'type' => 'string', + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + 'CreateTime' => [ + 'description' => '创建时间。'."\n" + .'返回格式：yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'example' => '2025-12-22 17:49:25', + ], + 'Status' => [ + 'description' => '协议服务导出目录的状态。包括：'."\n" + .'- CREATING：创建中。'."\n" + .'- AVAILABLE ：可用。'."\n" + .'- MODIFYING：修改中。'."\n" + .'- DELETING：删除中。'."\n" + .'- STOPPING：停止中。', + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'Description' => [ + 'description' => '协议服务导出的描述。', + 'type' => 'string', + 'example' => '此协议服务导出的描述。', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingFileSystemId', + 'errorMessage' => 'FileSystemId is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingExportId', + 'errorMessage' => 'ExportId is mandatory for this action.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidFileSystem.NotFound', + 'errorMessage' => 'The specified file system does not exist.', + ], + [ + 'errorCode' => 'Resource.NotFound', + 'errorMessage' => 'The specified resource does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6299428C-3861-435D-AE54-9B330A00****\\",\\n \\"NextToken\\": \\"M18xMA==\\",\\n \\"ProtocolMountTarget\\": {\\n \\"ExportId\\": \\"exp-19abf5beab8d****\\",\\n \\"ProtocolMountTargetDomain\\": \\"cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com\\",\\n \\"ProtocolType\\": \\"NFS\\",\\n \\"VpcId\\": \\"vpc-bp1h5mxoqfuo3xurf****\\",\\n \\"VSwitchId\\": \\"vsw-8vb2qjnxs6hiobzve****\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-bp1q3ro8erikjjrb2****\\"\\n ],\\n \\"FsetId\\": \\"fset-299b4ca04de8****\\",\\n \\"Path\\": \\"/\\",\\n \\"AccessGroupName\\": \\"DEFAULT_VPC_GROUP_NAME\\",\\n \\"CreateTime\\": \\"2025-12-22 17:49:25\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"Description\\": \\"此协议服务导出的描述。\\"\\n }\\n}","type":"json"}]', + 'title' => '查询协议服务导出目录信息', + ], + 'DetachVscFromFilesystems' => [ + 'summary' => '取消 VSC 设备关联到文件系统。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '特定账户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '文件系统和虚拟存储通道的 ID 信息，每批次最多 10 个。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统和虚拟存储通道的 ID 信息，每批次最多 10 个。', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'bmcpfs-290t15yn4uo8lid****'."\n", + ], + 'VscId' => [ + 'description' => '虚拟存储通道ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsc-8vb864o3ppwfvh****'."\n", + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.FileSystem', + 'errorMessage' => 'Invalid FileSystem in ResourceIds.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceIds', + 'errorMessage' => 'Invalid ResourceIds, can not be empty or batch size large than 10.', + ], + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem type.', + ], + [ + 'errorCode' => 'InvalidParameter.VscId', + 'errorMessage' => 'Invalid VscId in ResourceIds.', + ], + [ + 'errorCode' => 'InvalidParameter.VscIds', + 'errorMessage' => 'Invalid VscId in ResourceIds.VscIds must be the same.', + ], + [ + 'errorCode' => 'Ram.AddRamParamFailed', + 'errorMessage' => 'Ram check has failed due to param invalid, please check param.', + ], + [ + 'errorCode' => 'FeatureOrAPI.NotSupported', + 'errorMessage' => 'The Feature/API is not supported in this region now.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.Ram', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","type":"json"}]', + 'title' => '取消VSC设备关联到文件系统', + 'description' => '- 仅CPFS智算版支持该功能。'."\n" + .'- 支持批量执行，批量执行情况下，目前仅支持1个VscId关联到多个FileSystemId，即ResourceIds.VscId需相等。', + ], + 'AttachVscToFilesystems' => [ + 'summary' => '关联 VSC 设备到文件系统。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnasOIBEFL', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '特定账户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '文件系统和虚拟存储通道的 ID 信息，每批次最多 10 个。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统和虚拟存储通道的 ID 信息，每批次最多 10 个。', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'bmcpfs-290t15yn4uo8lid****', + ], + 'VscId' => [ + 'description' => '虚拟存储通道ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsc-8vb864o3ppwfvh****', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。'."\n" + ."\n" + .'ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。'."\n" + ."\n" + .'> 若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceIds', + 'errorMessage' => 'Invalid ResourceIds, can not be empty or batch size large than 10.', + ], + [ + 'errorCode' => 'InvalidParameter.FileSystem', + 'errorMessage' => 'Invalid FileSystem in ResourceIds.', + ], + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem type.', + ], + [ + 'errorCode' => 'InvalidParameter.VscId', + 'errorMessage' => 'Invalid VscId in ResourceIds.', + ], + [ + 'errorCode' => 'InvalidParameter.VscIds', + 'errorMessage' => 'Invalid VscId in ResourceIds.VscIds must be the same.', + ], + [ + 'errorCode' => 'Ram.AddRamParamFailed', + 'errorMessage' => 'Ram check has failed due to param invalid, please check param.', + ], + [ + 'errorCode' => 'FeatureOrAPI.NotSupported', + 'errorMessage' => 'The Feature/API is not supported in this region now.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.Ram', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\"\\n}","type":"json"}]', + 'title' => '关联VSC设备到文件系统', + 'description' => '- 仅CPFS智算版支持该功能。'."\n" + .'- 支持批量执行，批量执行情况下，目前仅支持1个VscId关联到多个FileSystemId，即ResourceIds.VscId需相等。', + ], + 'DescribeFilesystemsVscAttachInfo' => [ + 'summary' => '查询文件系统关联的虚拟存储通道信息。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191088', + 'abilityTreeNodes' => [ + 'FEATUREnasOIBEFL', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '特殊账号使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '文件系统和虚拟存储通道的 ID 信息，每批次最多 10 个。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统和虚拟存储通道的 ID 信息，每批次最多 10 个。', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'bmcpfs-290t15yn4uo8lid****'."\n", + ], + 'VscId' => [ + 'description' => '虚拟存储通道ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsc-8vb864o3ppwfvh****'."\n", + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '每次查询结果的个数。'."\n" + ."\n" + .'取值范围：10~100。'."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC7C825C-5F65-4B56-BEF6-98C56C7C****', + ], + 'NextToken' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'example' => 'TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=', + ], + 'TotalCount' => [ + 'description' => '关联信息总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxResults' => [ + 'description' => '每次查询返回目录的个数。'."\n" + ."\n" + .'取值范围：10~1000。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'VscAttachInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VscAttachInfo' => [ + 'description' => '文件系统和虚拟通道关联数据集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => 'bmcpfs-290t15yn4uo8lid****'."\n", + ], + 'VscId' => [ + 'description' => '虚拟存储通道ID。', + 'type' => 'string', + 'example' => 'vsc-8vb864o3ppwfvh****'."\n", + ], + 'Status' => [ + 'description' => '文件系统和虚拟通道关联状态。包括：'."\n" + ."\n" + .'- Attaching: 正在关联。'."\n" + .'- Attached：关联完成。'."\n" + .'- Detaching：正在取消关联。'."\n" + .'- Detached：取消关联完成。'."\n" + .'- Failed：关联失败。', + 'type' => 'string', + 'example' => 'Attached', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceIds', + 'errorMessage' => 'Invalid ResourceIds, can not be empty or batch size large than 10.', + ], + [ + 'errorCode' => 'InvalidParameter.FileSystem', + 'errorMessage' => 'Invalid FileSystem in ResourceIds.', + ], + [ + 'errorCode' => 'InvalidFilesystemType.NotSupport', + 'errorMessage' => 'This Api does not support this fileSystem type.', + ], + [ + 'errorCode' => 'InvalidParameter.VscId', + 'errorMessage' => 'Invalid VscId in ResourceIds.', + ], + [ + 'errorCode' => 'InvalidParameter.VscIds', + 'errorMessage' => 'Invalid VscId in ResourceIds.VscIds must be the same.', + ], + [ + 'errorCode' => 'Ram.AddRamParamFailed', + 'errorMessage' => 'Ram check has failed due to param invalid, please check param.', + ], + [ + 'errorCode' => 'FeatureOrAPI.NotSupported', + 'errorMessage' => 'The Feature/API is not supported in this region now.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.Ram', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC7C825C-5F65-4B56-BEF6-98C56C7C****\\",\\n \\"NextToken\\": \\"TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=\\",\\n \\"TotalCount\\": 1,\\n \\"MaxResults\\": 10,\\n \\"VscAttachInfo\\": {\\n \\"VscAttachInfo\\": [\\n {\\n \\"FileSystemId\\": \\"bmcpfs-290t15yn4uo8lid****\\\\n\\",\\n \\"VscId\\": \\"vsc-8vb864o3ppwfvh****\\\\n\\",\\n \\"Status\\": \\"Attached\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询文件系统关联的虚拟存储通道信息', + 'description' => '- 仅CPFS智算版支持该功能。'."\n" + .'- 支持批量执行，批量执行情况下，目前仅支持1个VscId关联到多个FileSystemId，即ResourceIds.VscId需相等。', + ], + 'AddClientToBlackList' => [ + 'summary' => '从CPFS服务中，将客户端加入黑名单，逐出其写入请求，起到IO Fence作用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13916', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '弃用接口', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpfs-00dfe7963fc6****', + ], + ], + [ + 'name' => 'ClientIP', + 'in' => 'query', + 'schema' => [ + 'description' => '待逐出的客户端IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.0', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。'."\n" + ."\n" + .'更多详情，请参见[如何保证幂等性](~~25693~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A70BEE5D-76D3-49FB-B58F-1F398211A5C3', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A70BEE5D-76D3-49FB-B58F-1F398211A5C3\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\r\\n<EvictClientResponse>\\r\\n <RequestId>A70BEE5D-76D3-49FB-B58F-1F398211A5C3</RequestId>\\r\\n</EvictClientResponse>","errorExample":""}]', + 'title' => '将客户端加入黑名单', + 'description' => '本接口只支持CPFS并行文件系统。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBlackListClients' => [ + 'summary' => '获取CPFS服务中黑名单客户端的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13949', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '废弃接口', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpfs-123458****', + ], + ], + [ + 'name' => 'ClientIP', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A70BEE5D-76D3-49FB-B58F-1F398211A5C3', + ], + 'Clients' => [ + 'description' => '返回客户端逐出的状态，是一个map类型的JSON格式字符串，格式：`{"client1": "EVICTING","client2":"EVICTED"}`。'."\n" + ."\n" + .'客户端逐出状态枚举值：'."\n" + ."\n" + .'- EVICTING：正在逐出'."\n" + .'- EVICTED：已逐出'."\n" + .'- ACCEPTING：恢复中 '."\n" + .'- ACCEPTABLE：已恢复', + 'type' => 'string', + 'example' => '{"client1": "EVICTING","client2":"EVICTED"}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A70BEE5D-76D3-49FB-B58F-1F398211A5C3\\",\\n \\"Clients\\": \\"{\\\\\\"client1\\\\\\": \\\\\\"EVICTING\\\\\\",\\\\\\"client2\\\\\\":\\\\\\"EVICTED\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeBlackListClientsResponse>\\n <RequestId>A70BEE5D-76D3-49FB-B58F-1F398211A5C3</RequestId>\\n <Clients>{\\"client1\\": \\"EVICTING\\",\\"client2\\":\\"EVICTED\\"}</Clients>\\n</DescribeBlackListClientsResponse>","errorExample":""}]', + 'title' => '获取CPFS服务中黑名单客户端的状态', + 'description' => '# 说明'."\n" + .'本接口只适用于CPFS并行文件系统。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveClientFromBlackList' => [ + 'summary' => '从CPFS服务中，将客户端移出黑名单，恢复其写入请求。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13982', + 'abilityTreeNodes' => [ + 'FEATUREnas2SBOJD', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '弃用接口', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpfs-00d91ca404a348****', + ], + ], + [ + 'name' => 'ClientIP', + 'in' => 'query', + 'schema' => [ + 'description' => '待移出黑名单的客户端IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.0', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。'."\n" + ."\n" + .'更多信息，请参见[如何保证幂等性](~~25693~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A70BEE5D-76D3-49FB-B58F-1F398211****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A70BEE5D-76D3-49FB-B58F-1F398211****\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveClientFromBlackListResponse>\\n <RequestId>A70BEE5D-76D3-49FB-B58F-1F398211****</RequestId>\\n</RemoveClientFromBlackListResponse>","errorExample":""}]', + 'title' => '将客户端移出黑名单', + 'description' => '本接口只支持CPFS并行文件系统。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateLDAPConfig' => [ + 'summary' => '添加LDAP配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => 'cpfs1.0支持的功能，仅支持存量用户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '109c04****', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => 'LDAP服务地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ldap://ldap.example.example', + ], + ], + [ + 'name' => 'BindDN', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定LDAP的指定条目。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn=alibaba,dc=com', + ], + ], + [ + 'name' => 'SearchBase', + 'in' => 'query', + 'schema' => [ + 'description' => 'LDAP搜索起始点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dc=example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5B4511A7-C99E-4071-AA8C-32E2529D****', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B4511A7-C99E-4071-AA8C-32E2529D****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>5B4511A7-C99E-4071-AA8C-32E2529D****</RequestId>","errorExample":""}]', + 'title' => '添加LDAP', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLDAPConfig' => [ + 'summary' => '用于删除LDAP设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => 'cpfs1.0支持的功能，仅支持存量用户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1ca404a348', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5B4511A7-C99E-4071-AA8C-32E2529DA963', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B4511A7-C99E-4071-AA8C-32E2529DA963\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\r\\n<DeleteLDAPConfigResponse>\\r\\n <RequestId>5B4511A7-C99E-4071-AA8C-32E2529DA963</RequestId>\\r\\n</DeleteLDAPConfigResponse>","errorExample":""}]', + 'title' => '删除LDAP设置', + 'description' => '# 说明'."\n" + .'本接口只支持CPFS并行文件系统。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLDAPConfig' => [ + 'summary' => '用于修改LDAP配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnasQ7YV89', + 'FEATUREnas0GUIX5', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => 'cpfs1.0支持的功能，仅支持存量用户使用', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '109c042666', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => 'LDAP服务地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ldap://ldap.example.example', + ], + ], + [ + 'name' => 'BindDN', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定LDAP的指定条目。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn=alibaba,dc=com', + ], + ], + [ + 'name' => 'SearchBase', + 'in' => 'query', + 'schema' => [ + 'description' => 'LDAP搜索起始点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dc=example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5B4511A7-C99E-4071-AA8C-32E2529DA963', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B4511A7-C99E-4071-AA8C-32E2529DA963\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>5B4511A7-C99E-4071-AA8C-32E2529DA963</RequestId>","errorExample":""}]', + 'title' => '修改LDAP配置', + 'description' => '本接口只支持CPFS并行文件系统。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFileSystemStatistics' => [ + 'summary' => '列出当前账号下文件系统的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13952', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每个分页包含的文件系统统计信息的个数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileSystem' => [ + 'description' => '文件系统列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '文件系统状态。'."\n" + ."\n" + .'极速型NAS和CPFS返回该字段，包括：'."\n" + ."\n" + .'- Pending：当前文件系统正在处理任务中。'."\n" + .'- Running：当前文件系统可用，当状态为Running时才可以进行后续操作（例如：创建挂载点等）。'."\n" + .'- Stopped：当前文件系统不可用。'."\n" + .'- Extending：当前文件系统扩容中。'."\n" + .'- Stopping：当前文件系统停机中。'."\n" + .'- Deleting：当前文件系统删除中。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'Capacity' => [ + 'description' => '文件系统的容量。'."\n" + ."\n" + .'单位：GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MeteredIASize' => [ + 'description' => '低频介质存储用量。'."\n" + ."\n" + .'单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '362832', + ], + 'CreateTime' => [ + 'description' => 'NAS文件系统的创建时间。', + 'type' => 'string', + 'example' => '2017-05-27T15:43:06CST', + ], + 'ChargeType' => [ + 'description' => '计费类型。'."\n" + ."\n" + .'包括：'."\n" + .'- Subscription：包年包月'."\n" + .'- PayAsYouGo：按量付费'."\n" + .'- Package：已绑定存储包', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'StorageType' => [ + 'description' => '存储类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- 通用型NAS：Capacity（容量型）、Performance（性能型）'."\n" + .'- 极速型NAS：standard（标准型）、advance（高级型）'."\n" + .'- CPFS：advance_100（100 MB/s/TiB基线）、advance_200（200 MB/s/TiB基线）', + 'type' => 'string', + 'example' => 'Performance', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- standard：通用型NAS'."\n" + .'- extreme：极速型NAS'."\n" + .'- cpfs：CPFS'."\n", + 'type' => 'string', + 'example' => 'standard', + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '109c04****', + ], + 'MeteredSize' => [ + 'description' => '文件系统的使用量。'."\n" + ."\n" + .'非实时使用量，为上一小时最大使用量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611661312', + ], + 'Description' => [ + 'description' => '文件系统的描述信息。', + 'type' => 'string', + 'example' => '31a8e48eda', + ], + 'ExpiredTime' => [ + 'description' => '文件系统到期时间。', + 'type' => 'string', + 'example' => '2017-08-27T15:43:06CST', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'Packages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Package' => [ + 'description' => '存储包信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '存储包起始时间。', + 'type' => 'string', + 'example' => '2019-12-05T01:40:56Z', + ], + 'ExpiredTime' => [ + 'description' => '存储包到期时间。', + 'type' => 'string', + 'example' => '2020-01-05T16:00:00Z', + ], + 'Size' => [ + 'description' => '存储包容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107374182400', + ], + 'PackageId' => [ + 'description' => '存储包ID。', + 'type' => 'string', + 'example' => 'naspackage-0be9c4b624-37****', + ], + ], + ], + ], + ], + ], + 'ProtocolType' => [ + 'description' => '文件系统协议类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- NFS：NFS文件协议'."\n" + .'- SMB：SMB文件协议'."\n" + .'- cpfs：CPFS文件系统支持的协议类型', + 'type' => 'string', + 'example' => 'NFS', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '文件系统的统计信息总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9F088138-FD73-4B68-95CC-DFAD4D85****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的文件系统统计信息个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '文件系统统计信息列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileSystemStatistics' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileSystemStatistic' => [ + 'description' => '文件系统的统计信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemType' => [ + 'description' => '文件系统类型。', + 'type' => 'string', + 'example' => 'standard', + ], + 'MeteredSize' => [ + 'description' => '文件系统的使用量。'."\n" + ."\n" + .'此参数非实时使用量，为上一小时的最大使用量。'."\n" + ."\n" + .'单位：Byte', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611', + ], + 'ExpiringCount' => [ + 'description' => '即将到期的文件系统个数。'."\n" + ."\n" + .'文件系统到期时间距离当前时间小于等于7天时将会被统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '当前类型的文件系统个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ExpiredCount' => [ + 'description' => '已到期的文件系统个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'NAS::2017-06-26::DescribeResourceStatistics', + ], + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FileSystems\\": {\\n \\"FileSystem\\": [\\n {\\n \\"Status\\": \\"Pending\\",\\n \\"Capacity\\": 1,\\n \\"MeteredIASize\\": 362832,\\n \\"CreateTime\\": \\"2017-05-27T15:43:06CST\\",\\n \\"ChargeType\\": \\"PayAsYouGo\\",\\n \\"StorageType\\": \\"Performance\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSystemType\\": \\"standard\\",\\n \\"FileSystemId\\": \\"109c04****\\",\\n \\"MeteredSize\\": 1611661312,\\n \\"Description\\": \\"31a8e48eda\\",\\n \\"ExpiredTime\\": \\"2017-08-27T15:43:06CST\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"Packages\\": {\\n \\"Package\\": [\\n {\\n \\"StartTime\\": \\"2019-12-05T01:40:56Z\\",\\n \\"ExpiredTime\\": \\"2020-01-05T16:00:00Z\\",\\n \\"Size\\": 107374182400,\\n \\"PackageId\\": \\"naspackage-0be9c4b624-37****\\"\\n }\\n ]\\n },\\n \\"ProtocolType\\": \\"NFS\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"9F088138-FD73-4B68-95CC-DFAD4D85****\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"FileSystemStatistics\\": {\\n \\"FileSystemStatistic\\": [\\n {\\n \\"FileSystemType\\": \\"standard\\",\\n \\"MeteredSize\\": 1611,\\n \\"ExpiringCount\\": 1,\\n \\"TotalCount\\": 10,\\n \\"ExpiredCount\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>100</TotalCount>\\n<RequestId>9F088138-FD73-4B68-95CC-DFAD4D85****</RequestId>\\n<PageSize>10000</PageSize>\\n<PageNumber>1</PageNumber>\\n<FileSystemStatistics>\\n <FileSystemStatistic>\\n <TotalCount>55</TotalCount>\\n <ExpiredCount>0</ExpiredCount>\\n <FileSystemType>standard</FileSystemType>\\n <MeteredSize>200704</MeteredSize>\\n <ExpiringCount>0</ExpiringCount>\\n </FileSystemStatistic>\\n <FileSystemStatistic>\\n <TotalCount>33</TotalCount>\\n <ExpiredCount>0</ExpiredCount>\\n <FileSystemType>extreme</FileSystemType>\\n <MeteredSize>849346560</MeteredSize>\\n <ExpiringCount>0</ExpiringCount>\\n </FileSystemStatistic>\\n <FileSystemStatistic>\\n <TotalCount>12</TotalCount>\\n <ExpiredCount>0</ExpiredCount>\\n <FileSystemType>cpfs</FileSystemType>\\n <MeteredSize>0</MeteredSize>\\n <ExpiringCount>0</ExpiringCount>\\n </FileSystemStatistic>\\n</FileSystemStatistics>","errorExample":""}]', + 'title' => '概览页获取数据', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeStoragePackages' => [ + 'summary' => '查询存储包列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13962', + 'abilityTreeNodes' => [ + 'FEATUREnasI92PYN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每个分页包含的存储包个数。'."\n" + ."\n" + .'取值范围：1~100'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'UseUTCDateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的时间是否按照UTC标准格式表示。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- true（默认值）：返回的时间为UTC标准格式。'."\n" + .'- false：返回Unix时间戳。', + 'type' => 'boolean', + 'required' => false, + 'minimum' => '1', + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的分页页码。'."\n" + ."\n" + .'起始值（默认值）：1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '存储包个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '035B3A3A-E514-4B41-B906-5D906CFB****', + ], + 'PageSize' => [ + 'description' => '每个分页包含的存储包个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '存储包列表的分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Packages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Package' => [ + 'description' => '存储包信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '存储包状态。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- free：未绑定文件系统，可以将该存储包绑定至同存储类型的文件系统上。'."\n" + .'- bound：已绑定文件系统。', + 'type' => 'string', + 'example' => 'free', + ], + 'FileSystemId' => [ + 'description' => '存储包所绑定的文件系统ID。', + 'type' => 'string', + 'example' => '109c****66', + ], + 'StartTime' => [ + 'description' => '存储包起始时间。', + 'type' => 'string', + 'example' => '2019-12-05T01:40:56Z', + ], + 'ExpiredTime' => [ + 'description' => '存储包到期时间。', + 'type' => 'string', + 'example' => '2020-01-05T16:00:00Z', + ], + 'Size' => [ + 'description' => '存储包的容量。'."\n" + ."\n" + .'单位：Byte', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'StorageType' => [ + 'description' => '存储包类型。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- Performance：性能型 '."\n" + .'- Capacity：容量型', + 'type' => 'string', + 'example' => 'Capacity', + ], + 'PackageId' => [ + 'description' => '存储包ID。', + 'type' => 'string', + 'example' => 'naspackage-@string(\'*****\', *)-@string(\'*****\', *)', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"035B3A3A-E514-4B41-B906-5D906CFB****\\",\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 3,\\n \\"Packages\\": {\\n \\"Package\\": [\\n {\\n \\"Status\\": \\"free\\",\\n \\"FileSystemId\\": \\"109c****66\\",\\n \\"StartTime\\": \\"2019-12-05T01:40:56Z\\",\\n \\"ExpiredTime\\": \\"2020-01-05T16:00:00Z\\",\\n \\"Size\\": 10,\\n \\"StorageType\\": \\"Capacity\\",\\n \\"PackageId\\": \\"naspackage-@string(\'*****\', *)-@string(\'*****\', *)\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>3</TotalCount>\\n<PageSize>1</PageSize>\\n<RequestId>035B3A3A-E514-4B41-B906-5D906CFB****</RequestId>\\n<PageNumber>1</PageNumber>\\n<Packages>\\n <Package>\\n <Status>free</Status>\\n <StorageType>Capacity</StorageType>\\n <Size>10</Size>\\n <ExpiredTime>2020-01-05T16:00:00Z</ExpiredTime>\\n <StartTime>2019-12-05T01:40:56Z</StartTime>\\n <FileSystemId>109c****66</FileSystemId>\\n <PackageId>naspackage-@string(\'*****\', *)-@string(\'*****\', *)</PackageId>\\n </Package>\\n</Packages>","errorExample":""}]', + 'title' => '查询存储包列表信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'nas.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'nas.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'nas.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'nas.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'nas.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'nas.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'nas.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'nas.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'nas.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'nas.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'nas.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'nas.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'nas.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'nas.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'nas.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'nas.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'nas.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'nas.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'nas.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'nas.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'nas.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'nas.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'nas.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'nas.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'nas.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'nas.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'nas.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'nas.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'nas.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'nas.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'nas.me-central-1.aliyuncs.com', + ], + ], +]; |