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/sgw/2018-05-11/api-docs.php | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/sgw/2018-05-11/api-docs.php')
| -rw-r--r-- | data/zh_cn/sgw/2018-05-11/api-docs.php | 11772 |
1 files changed, 11772 insertions, 0 deletions
diff --git a/data/zh_cn/sgw/2018-05-11/api-docs.php b/data/zh_cn/sgw/2018-05-11/api-docs.php new file mode 100644 index 0000000..5f4e585 --- /dev/null +++ b/data/zh_cn/sgw/2018-05-11/api-docs.php @@ -0,0 +1,11772 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'sgw', + 'version' => '2018-05-11', + ], + 'directories' => [ + [ + 'id' => 282066, + 'title' => '网关集群', + 'type' => 'directory', + 'children' => [ + 'CreateStorageBundle', + 'ModifyStorageBundle', + 'DescribeStorageBundle', + 'DeleteStorageBundle', + 'DescribeStorageBundles', + ], + ], + [ + 'id' => 282072, + 'title' => '网关', + 'type' => 'directory', + 'children' => [ + 'OpenSgwService', + 'CreateGateway', + 'UpgradeGateway', + 'DeleteGateway', + 'DescribeGateway', + 'ModifyGateway', + 'DeployGateway', + 'DescribeTasks', + 'DescribeGateways', + 'DescribeGatewayCategories', + 'DescribeGatewayTypes', + 'DescribeAccountConfig', + 'DescribeGatewayImages', + 'TriggerGatewayRemoteSync', + 'DescribeRegions', + 'DescribeGatewayClasses', + 'ExpandGatewayNetworkBandwidth', + ], + ], + [ + 'id' => 282090, + 'title' => '块卷', + 'type' => 'directory', + 'children' => [ + 'CreateGatewayBlockVolume', + 'DescribeGatewayBlockVolumes', + 'UpdateGatewayBlockVolume', + 'DeleteGatewayBlockVolumes', + ], + ], + [ + 'id' => 282095, + 'title' => '文件共享', + 'type' => 'directory', + 'children' => [ + 'CreateGatewayFileShare', + 'DescribeGatewayFileStatus', + 'DescribeGatewayFileShares', + 'UpdateGatewayFileShare', + 'DeleteGatewayFileShares', + 'DescribeGatewayNFSClients', + 'ModifyGatewayFileShareWatermark', + 'ExpandGatewayFileShare', + 'CreateGatewaySMBUser', + 'DeleteGatewaySMBUser', + 'DescribeGatewaySMBUsers', + 'SetGatewayDNS', + 'DescribeGatewayDNS', + 'SetGatewayADInfo', + 'DescribeGatewayADInfo', + ], + ], + [ + 'id' => 282111, + 'title' => '缓存盘', + 'type' => 'directory', + 'children' => [ + 'CreateGatewayCacheDisk', + 'DescribeGatewayCaches', + 'ExpandCacheDisk', + 'DeleteGatewayCacheDisk', + ], + ], + [ + 'id' => 282116, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'ListTagResources', + 'UntagResources', + ], + ], + [ + 'id' => 282120, + 'title' => '日志监控', + 'type' => 'directory', + 'children' => [ + 'CreateGatewayLogging', + 'DescribeGatewayLogging', + 'EnableGatewayLogging', + 'DisableGatewayLogging', + 'DeleteGatewayLogging', + ], + ], + [ + 'id' => 282126, + 'title' => '极速同步组', + 'type' => 'directory', + 'children' => [ + 'CreateExpressSync', + 'AddSharesToExpressSync', + 'DescribeExpressSyncs', + 'DescribeExpressSyncShares', + 'DeleteExpressSync', + 'RemoveSharesFromExpressSync', + ], + ], + [ + 'id' => 282133, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeGatewayLocations', + 'DescribeGatewaySMBClients', + 'DescribeGatewaySMBSecurityStrategy', + 'ListAlertEvents', + 'SetGatewaySMBSecurityStrategy', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeGatewayModificationClasses', + 'ModifyGatewayClass', + 'RestartFileShares', + 'UploadGatewayLog', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateStorageBundle' => [ + 'summary' => '创建网关集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群名。长度限制1~60个字符，可以包含大小写字母，中文，数字，“.”，“_”或“-”，同时必须以大小写字母或者中文开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex-123***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群描述。长度限制0~128个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '测试使用', + ], + ], + [ + 'name' => 'BackendBucketRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群所在的地域。可通过DescribeRegions接口获得有效的regionId。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-000ibk4xrlr03qrjr***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyStorageBundleName', + 'errorMessage' => 'You must enter a valid name for the gateway cluster.', + ], + [ + 'errorCode' => 'InvalidRegionId', + 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.', + ], + [ + 'errorCode' => 'StorageBundleDescriptionOverLimit', + 'errorMessage' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'DuplicateStorageBundleName', + 'errorMessage' => 'The name you specified for the gateway cluster already exists. You must specify a valid name.', + ], + [ + 'errorCode' => 'InvalidStorageBundleName', + 'errorMessage' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qrjr***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateStorageBundleResponse>\\n <Message>successful</Message>\\n <RequestId>2AD80BDC-E05C-4A77-BBAD-5EDAEDE6333</RequestId>\\n <StorageBundleId>sb-000ibk4xrlr03qrjr***</StorageBundleId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateStorageBundleResponse>","errorExample":""}]', + 'title' => '创建网关集群', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyStorageBundle' => [ + 'summary' => '对指定网关集群的基本信息进行修改，包括网关集群名称、描述。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'StorageBundleId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sb-000ibk4xrlr03qrjr***', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群名。长度限制1~60个字符，可以包含大小写字母，中文，数字，“.”，“_”或“-”，同时必须以大小写字母或者中文开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex-123***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群描述。 长度不可超过128个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '测试使用', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70EACC9C-D07A-4A34-ADA4-77506C42777', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-000ibk4xrlr03qr***', + ], + 'Code' => [ + 'description' => '请求错误代号，正确时为200。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyStorageBundleId', + 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', + ], + [ + 'errorCode' => 'EmptyStorageBundleName', + 'errorMessage' => 'You must enter a valid name for the gateway cluster.', + ], + [ + 'errorCode' => 'StorageBundleDescriptionOverLimit', + 'errorMessage' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.', + ], + [ + 'errorCode' => 'InvalidStorageBundleName', + 'errorMessage' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StorageBundleNotExist', + 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"70EACC9C-D07A-4A34-ADA4-77506C42777\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qr***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyStorageBundleResponse>\\n <Message>successful</Message>\\n <RequestId>70EACC9C-D07A-4A34-ADA4-77506C42777</RequestId>\\n <StorageBundleId>sb-000ibk4xrlr03qr***</StorageBundleId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyStorageBundleResponse>","errorExample":""}]', + 'title' => '修改网关集群基本信息', + ], + 'DescribeStorageBundle' => [ + 'summary' => '查询网关集群信息。包括所在地域、时间戳、名称和描述等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'StorageBundleId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sb-0007y2889yyxkuqov***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '网关集群描述。', + 'type' => 'string', + 'example' => '测试集群', + ], + 'CreatedTime' => [ + 'description' => '网关集群的创建时间戳。单位为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1657706998', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '736C7733-FCED-4AFB-8407-C325F210CE03', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-000dt67z4ijqfocpy***', + ], + 'BackendBucketRegionId' => [ + 'description' => '网关集群所在的地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Name' => [ + 'description' => '网关集群名称。', + 'type' => 'string', + 'example' => 'sdfa***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyStorageBundleId', + 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StorageBundleNotExist', + 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"测试集群\\",\\n \\"CreatedTime\\": 1657706998,\\n \\"RequestId\\": \\"736C7733-FCED-4AFB-8407-C325F210CE03\\",\\n \\"Message\\": \\"successful\\",\\n \\"StorageBundleId\\": \\"sb-000dt67z4ijqfocpy***\\",\\n \\"BackendBucketRegionId\\": \\"cn-shanghai\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Name\\": \\"sdfa***\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeStorageBundleResponse>\\n <Description>测试集群</Description>\\n <CreatedTime>1657706998</CreatedTime>\\n <RequestId>736C7733-FCED-4AFB-8407-C325F210CE03</RequestId>\\n <Message>successful</Message>\\n <StorageBundleId>sb-000dt67z4ijqfocpy***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Name>sdfa***</Name>\\n</DescribeStorageBundleResponse>","errorExample":""}]', + 'title' => '查询网关集群信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteStorageBundle' => [ + 'summary' => '如果网关集群存在线上或线下云存储网关，请删除所有网关以后再删除该网关集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'StorageBundleId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sb-0001b2otnkdxrige****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '28708A34-83AF-42B8-928B-40E7B3E1D719', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求状态描述。可能值：'."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StorageBundleNotEmpty', + 'errorMessage' => 'Failed to delete the gateway cluster because a cloud gateway or an on-premises gateway exists. We recommend that you delete all attached gateways before you delete the gateway cluster.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StorageBundleNotExist', + 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"28708A34-83AF-42B8-928B-40E7B3E1D719\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteStorageBundleResponse>\\n <Message>successful</Message>\\n <RequestId>28708A34-83AF-42B8-928B-40E7B3E1D719</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteStorageBundleResponse>","errorExample":""}]', + 'title' => '删除指定的网关集群', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeStorageBundles' => [ + 'summary' => '查询集群列表信息。包括网关集群名称、描述及创建时间等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackendBucketRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群所在的地域。可以通过DescribeRegions接口获得有效的regionId。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群列表信息的页码。'."\n" + ."\n" + .'起始值：1。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。'."\n" + ."\n" + .'最大值：50。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '网关集群的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EB4639B-0812-4F2D-AB78-194E67645E357', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '分页展示返回的网关集群列表时的每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '网关集群列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StorageBundles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StorageBundle' => [ + 'description' => '网关集群信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '网关集群的描述。', + 'type' => 'string', + 'example' => '测试使用', + ], + 'BackendBucketRegionId' => [ + 'description' => '网关集群所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-000ibk4xrlr03qrjr***', + ], + 'Name' => [ + 'description' => '网关集群名称。', + 'type' => 'string', + 'example' => 'zy-test***', + ], + 'CreatedTime' => [ + 'description' => '网关集群创建时间。时间戳为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1565750633', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadPageSize', + 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', + ], + [ + 'errorCode' => 'BadPageNumber', + 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', + ], + [ + 'errorCode' => 'InvalidRegionId', + 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"1EB4639B-0812-4F2D-AB78-194E67645E357\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"StorageBundles\\": {\\n \\"StorageBundle\\": [\\n {\\n \\"Description\\": \\"测试使用\\",\\n \\"BackendBucketRegionId\\": \\"cn-hangzhou\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qrjr***\\",\\n \\"Name\\": \\"zy-test***\\",\\n \\"CreatedTime\\": 1565750633\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeStorageBundlesResponse>\\n <TotalCount>3</TotalCount>\\n <Message>successful</Message>\\n <PageSize>5</PageSize>\\n <RequestId>0F96A15D-BA06-4A34-9587-AA8C9C230E80</RequestId>\\n <PageNumber>1</PageNumber>\\n <Code>200</Code>\\n <StorageBundles>\\n <StorageBundle>\\n <CreatedTime>1568795768</CreatedTime>\\n <StorageBundleId>sb-0007y2889yyxkuqov***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Description>测试使用</Description>\\n <Name>sgw1-test***</Name>\\n </StorageBundle>\\n <StorageBundle>\\n <CreatedTime>1533283347</CreatedTime>\\n <StorageBundleId>sb-000dai44c82bp6i32***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Description>测试使用</Description>\\n <Name>sgw2-test***</Name>\\n </StorageBundle>\\n <StorageBundle>\\n <CreatedTime>1532663546</CreatedTime>\\n <StorageBundleId>sb-000e9qyjn694q148r***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Description>测试使用</Description>\\n <Name>sgw3-test***</Name>\\n </StorageBundle>\\n </StorageBundles>\\n <Success>true</Success>\\n</DescribeStorageBundlesResponse>","errorExample":""}]', + 'title' => '查询集群列表信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OpenSgwService' => [ + 'summary' => '开通网关服务。只有开通服务后，才能进行产品使用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '开通接口，无法反复调用并返回200', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ECCBBC17-0C21-5272-9754-9C1AAF83****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2410000000****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OrderOpend', + 'errorMessage' => 'You have already activated the service. Please go to the console to start using it.', + ], + [ + 'errorCode' => 'OrderNoRealNameAuthentication', + 'errorMessage' => 'You have not completed real name authentication yet. Please complete the real-name authentication.', + ], + [ + 'errorCode' => 'NoAvailabePaymentMetthod', + 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'The specified account has overdue payments. We recommend that you add funds to the account now.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ECCBBC17-0C21-5272-9754-9C1AAF83****\\",\\n \\"OrderId\\": \\"2410000000****\\"\\n}","type":"json"}]', + 'title' => '开通云存储网关服务', + ], + 'CreateGateway' => [ + 'summary' => '创建一个包年包月或按量付费的网关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '17166', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'StorageBundleId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群ID，如果不指定ResourceRegionId，则必须指定该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'sb-0001b2otnkdxrigeq***', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '网关名称。长度为60个字符且以大小写字母或者中文开头，可以包含大小写字母，中文、数字、下划线（_）、短划线（-）和半角句号（.）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '网关描述。长度限制0~255个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '测试使用', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '网关类别。默认值为`Aliyun`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '网关类型。取值范围：'."\n" + ."\n" + .'- File：文件网关。'."\n" + ."\n" + .'- Iscsi：块网关。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'File', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '网关位置。取值范围：'."\n" + ."\n" + .'- Cloud：线上网关。'."\n" + ."\n" + .'- On_Premise：线下网关。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Cloud', + ], + ], + [ + 'name' => 'GatewayClass', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">网关规格。**该参数涉及费用**，**详情请参见**[计量项和计费项](https://help.aliyun.com/document_detail/126872.html?spm=a2c4g.11186623.2.18.2d7376e8ZmSIJp#concept-126872-zh)。</props>'."\n" + .'<props="intl">网关规格。**该参数涉及费用**，**详情请参见**[计量项和计费项](https://www.alibabacloud.com/help/zh/csg/billable-items-and-billing-methods)。</props>'."\n" + ."\n\n" + .'如果您的网关位置在本地数据中心，即线下网关，您可以忽略这个参数。'."\n" + ."\n" + .'如果您的网关位置在阿里云，即线上网关，则取值范围：'."\n" + ."\n" + .'- Basic：基础型'."\n" + ."\n" + .'- Standard：标准型'."\n" + ."\n" + .'- Enhanced：增强型'."\n" + ."\n" + .'- Advanced：性能型', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机的ID。如果您的网关位置在本地数据中心，可以忽略这个参数。'."\n" + ."\n" + .'- 必须与您需要挂载的云服务器ECS处于同一个VPC下。'."\n" + ."\n" + .'- 如果当前的虚拟交换机所在的可用区没有可以分配的网关资源，请到其他可用区创建虚拟交换机。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vsw-bp1krhkglx3nahkb9s***', + ], + ], + [ + 'name' => 'PostPaid', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">网关付费类型。**该参数涉及费用**，**详情请参见**[计量项和计费项](https://help.aliyun.com/document_detail/126872.html?spm=a2c4g.11186623.2.18.2d7376e8ZmSIJp#concept-126872-zh)。</props>'."\n" + .'<props="intl">网关付费类型。**该参数涉及费用**，**详情请参见**[计量项和计费项](https://www.alibabacloud.com/help/zh/csg/billable-items-and-billing-methods)。</props>'."\n" + .'取值范围：'."\n" + ."\n" + .'- true：按量付费，即后付费。'."\n" + ."\n" + .'- false：包年包月，即预付费。'."\n" + ."\n" + .'默认：false（包年包月）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ReleaseAfterExpiration', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费情况下，是否到期释放。可能值如下：'."\n" + ."\n" + .'true：到期自动释放，直接收回。'."\n" + ."\n" + .'false：预付费到期后自动转为按量付费模式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PublicNetworkBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">数据公网带宽。单位为Mbps。取值范围为5~200。**该参数涉及费用**，**详情请参见**[计量项和计费项](https://help.aliyun.com/document_detail/126872.html?spm=a2c4g.11186623.2.18.2d7376e8ZmSIJp#concept-126872-zh)。</props>'."\n" + .'<props="intl">数据公网带宽。单位为Mbps。取值范围为5~200。**该参数涉及费用**，**详情请参见**[计量项和计费项](https://www.alibabacloud.com/help/zh/csg/billable-items-and-billing-methods)。</props>'."\n" + .'> - 仅线上网关支持，线下网关请忽略此参数。'."\n" + .'> - 仅当需要跨地域挂载OSS时配置。'."\n" + .'> - 传值0或不传值情况下，默认值为5。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'UntrustedEnvInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">非授信（[云盒](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)）场景下网关的实际规格。</props>'."\n" + ."\n" + .'<props="intl">非授信（[云盒](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)）场景下网关的实际规格。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + ], + [ + 'name' => 'UntrustedEnvId', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">非授信（[云盒](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)）实例ID。</props>'."\n" + ."\n" + .'<props="intl">非授信（[云盒](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)）实例ID。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'cb-2vcdsa32432***', + ], + ], + [ + 'name' => 'SecondaryVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '高可用网关备节点虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1krhkglx3nahcx9s***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BuyURL' => [ + 'description' => '购买链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***","directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}®ionId=cn-hangzhou#/buy', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8E69E1A1-9076-4C8C-8ADF-ACD253886E22', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'GatewayId' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'example' => 'gw-0001xv7je357zm9u6***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayName', + 'errorMessage' => 'You must enter a valid name for the gateway.', + ], + [ + 'errorCode' => 'InvalidGatewayName', + 'errorMessage' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', + ], + [ + 'errorCode' => 'DescriptionOverLimit', + 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.', + ], + [ + 'errorCode' => 'EmptyStorageBundleId', + 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', + ], + [ + 'errorCode' => 'InvalidGatewayClass', + 'errorMessage' => 'The specified specification of the gateway is invalid.', + ], + [ + 'errorCode' => 'InvalidGatewayType', + 'errorMessage' => 'The specified type of the gateway is invalid.', + ], + [ + 'errorCode' => 'InvalidVSwitchId', + 'errorMessage' => 'The specified VSwitch ID does not exist.', + ], + [ + 'errorCode' => 'NoAvailableOnlineResource', + 'errorMessage' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.', + ], + [ + 'errorCode' => 'DuplicateGatewayName', + 'errorMessage' => 'The specified name of the gateway already exists. You must specify a valid name.', + ], + [ + 'errorCode' => 'InvalidGatewayBandwidth', + 'errorMessage' => 'The specified public network bandwidth for the gateway is invalid. The bandwidth ranges from 6 to 200 Mbit/s.', + ], + [ + 'errorCode' => 'GatewayBandwidthNotSupported', + 'errorMessage' => 'You cannot decrease the public network bandwidth of a On Premise Gateway.', + ], + [ + 'errorCode' => 'InvalidGatewayLocation', + 'errorMessage' => 'The specified location of the gateway is invalid.', + ], + [ + 'errorCode' => 'ServiceReleased', + 'errorMessage' => 'Service is released, please open service again.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StorageBundleNotExist', + 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***\\\\\\",\\\\\\"directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}®ionId=cn-hangzhou#/buy\\",\\n \\"RequestId\\": \\"8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\",\\n \\"Message\\": \\"successful\\",\\n \\"GatewayId\\": \\"gw-0001xv7je357zm9u6***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayResponse>\\n <Message>successful</Message>\\n <RequestId>8E69E1A1-9076-4C8C-8ADF-ACD253886E22</RequestId>\\n <GatewayId>gw-0001xv7je357zm9u6m0u</GatewayId>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request=%7B%22gateway_id%22:%22gw-0007va9bnidei3s8a09e%22,%22directBuy%22:%22false%22,%22gateway_class%22:%22standard%22,%22cache_cloud_efficiency_size%22:0%7D®ionId=cn-hangzhou#/buy</BuyURL>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayResponse>","errorExample":""}]', + 'title' => '创建网关', + 'description' => '### 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'<props="china">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和[价格](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5&aly_as=C81M1m5N#/hcs_sgw/detail)。</props><props="intl">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和价格。'."\n" + .'</props>'."\n" + ."\n" + .'- 您已经注册阿里云账号，并完成实名认证。'."\n" + .'- 您已经开通云存储网关服务。'."\n" + .'- 您在需要创建云上网关的地域，已有可用的专有网络VPC和虚拟交换机vSwitch。'."\n" + .'- 您在需要创建云上网关的地域，已有可用的云服务器ECS，并将此服务器归属到已创建的专有网络VPC下。'."\n" + .'- 在创建网关前，确保您已创建网关集群，如果还未创建，可以通过[CreateStorageBundle](~~170260~~)接口完成网关集群的创建。'."\n" + .'- 如果您的网关付费类型为包年包月，完成网关创建后，您需要通过接口返回的购买链接进行网关购买，完成网关的创建。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpgradeGateway' => [ + 'summary' => '根据网关ID对指定的网关进行升级。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwDLQA4J', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031y***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je3580412***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB300009-3850-4107-B291-59BDB4EDA183', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => 'Code', + ], + 'Success' => [ + 'description' => '请求是否成功。可取值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayOperationNotAllowed', + 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je3580412***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CB300009-3850-4107-B291-59BDB4EDA183\\",\\n \\"Code\\": \\"Code\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpgradeGatewayResponse>\\n <TaskId>t-0001xv7je3580412***</TaskId>\\n <Message>successful</Message>\\n <RequestId>CB300009-3850-4107-B291-59BDB4EDA183</RequestId>\\n <Code>Code</Code>\\n <Success>true</Success>\\n</UpgradeGatewayResponse>","errorExample":""}]', + 'title' => '升级网关', + 'description' => '### 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'- 升级过程中，无法响应其他发送的请求。'."\n" + ."\n" + .'- 仅支持网关状态为运行中（Running）、已激活（Activated）时调用此接口。'."\n" + ."\n" + .'- 高可用网关的升级由系统内部自动管理，如果尝试对高可用网关进行手动升级，系统将返回 BadRequest 错误。'."\n" + ."\n" + .'><warning>升级网关会导致您的业务暂时中断，请谨慎操作。'."\n" + .'></warning></props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteGateway' => [ + 'summary' => '从所属集群上删除一个按量付费的网关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031****', + ], + ], + [ + 'name' => 'ReasonType', + 'in' => 'query', + 'schema' => [ + 'description' => '删除网关的原因，可能值如下：'."\n" + .'- REASON1：网关费用太高。'."\n" + .'- REASON2：网关测试需要，不再使用。'."\n" + .'- REASON3：网关特性或性能不满足业务需求。'."\n" + .'- REASON4：最希望网关新增功能。', + 'type' => 'string', + 'required' => false, + 'example' => 'REASON2', + ], + ], + [ + 'name' => 'ReasonDetail', + 'in' => 'query', + 'schema' => [ + 'description' => '删除网关的详细原因。', + 'type' => 'string', + 'required' => false, + 'example' => '"网关测试需要，不再使用"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0000iwdggbhaordh****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '151BB31D-571D-4BB9-9A02-D4210E5B****', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。可取值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayOperationNotAllowed', + 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'GatewayNotEmpty', + 'errorMessage' => 'There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0000iwdggbhaordh****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"151BB31D-571D-4BB9-9A02-D4210E5B****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayResponse>\\n <TaskId>t-0000iwdggbhaordhk***</TaskId>\\n <Message>successful</Message>\\n <RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayResponse>","errorExample":""}]', + 'title' => '删除网关', + 'description' => '### 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'- 仅支持删除按量付费的网关，即后付费网关。'."\n" + ."\n" + .'- 仅支持删除状态为已初始化（Initialized）、已激活（Activated）、运行中（Running）、未知状态（Unknown）、失败（Failed）、停止（Stopped）的网关。'."\n" + .'- 如果您已在云存储网关控制台删除实例，但资源管理控制台仍显示该实例，这可能是缓存信息或同步延迟引起的。请稍等片刻，系统将自动更新状态。若长时间未更新，您可尝试刷新页面或等待系统自动同步。'."\n" + ."\n" + .'><warning>删除网关会导致您的业务和数据同步中断，请谨慎操作。'."\n" + .'></warning></props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGateway' => [ + 'summary' => '根据指定网关ID查询网关的基本信息。包括网关状态、类型等详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '网关描述。', + 'type' => 'string', + 'example' => '测试使用', + ], + 'CreatedTime' => [ + 'description' => '网关创建时间。时间戳为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1532099461', + ], + 'PublicNetworkBandwidth' => [ + 'description' => '数据公网带宽，单位为Mbps。如果网关为线上网关返回数据公网带宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'DataLoadType' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => ' 废弃', + ], + 'Category' => [ + 'description' => '网关类别。默认值为`Aliyun`。', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0000iwdggbharrw6r***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'ExpireStatus' => [ + 'description' => '预付费情况下，网关是否过期的状态。可能值：'."\n" + ."\n" + .'- 0：正常'."\n" + ."\n" + .'- 1：将要过期'."\n" + .' '."\n" + .'- 2：已经过期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Ip' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '47.101.**.**', + ], + 'GatewayType' => [ + 'description' => '网关类型，可能值如下：'."\n" + ."\n" + .'- File：文件网关'."\n" + ."\n" + .'- Iscsi：块网关', + 'type' => 'string', + 'example' => 'File', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-000dt67z4ijqfocpy***', + ], + 'GatewayClass' => [ + 'description' => '网关规格。当网关为线上网关时会返回网关规格。可能值如下：'."\n" + ."\n" + .'- Basic：基础型'."\n" + ."\n" + .'- Standard：标准型'."\n" + ."\n" + .'- Enhanced：增强型'."\n" + ."\n" + .'- Advanced：性能型', + 'type' => 'string', + 'example' => 'Basic', + ], + 'Success' => [ + 'description' => '请求是否成功。可能值如下：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Name' => [ + 'description' => '网关名称。', + 'type' => 'string', + 'example' => 'alex***', + ], + 'IsPostPaid' => [ + 'description' => '是否为后付费网关。可能值如下：'."\n" + ."\n" + .'- true：后付费网关，即按量付费网关。'."\n" + ."\n" + .'- false：预付费网关，即包年包月网关。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Capacity' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'ExpiredTime' => [ + 'description' => '预付费情况下，网关的过期时间，时间戳为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1532530021', + ], + 'GatewayVersion' => [ + 'description' => '网关版本。', + 'type' => 'string', + 'example' => '1.0.39', + ], + 'IsReleaseAfterExpiration' => [ + 'description' => '预付费情况下，是否到期释放。可能值如下：'."\n" + ."\n" + .'- true：到期自动释放，直接收回。'."\n" + ."\n" + .'- false：预付费到期后自动转为按量付费模式。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Status' => [ + 'description' => '网关状态。可能值如下：'."\n" + ."\n" + .'- Initialized：已初始化'."\n" + ."\n" + .'- Deactivated：未激活'."\n" + ."\n" + .'- Activated：已激活'."\n" + ."\n" + .'- Deploying：部署中'."\n" + ."\n" + .'- Running：运行中'."\n" + ."\n" + .'- Stopping：停止中'."\n" + ."\n" + .'- Stopped：已停止'."\n" + ."\n" + .'- Starting：启动中'."\n" + ."\n" + .'- Rebooting：重启中'."\n" + ."\n" + .'- Deleting：删除中'."\n" + ."\n" + .'- Failed：失败'."\n" + ."\n" + .'- Upgrading：升级中'."\n" + ."\n" + .'- Modifying：修改中'."\n" + ."\n" + .'- Unknown：长时间没有心跳'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Initialized', + ], + 'BuyURL' => [ + 'description' => '未完成支付情况下，预付费的购买支付链接。', + 'type' => 'string', + 'example' => 'https://expense.console.aliyun.com/?returnExpense=true#/order/list/', + ], + 'MaxThroughput' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'DataLoadInterval' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'InnerIp' => [ + 'description' => '挂载IP。', + 'type' => 'string', + 'example' => '172.19.55.65', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '736C7733-FCED-4AFB-8407-C325F210CE03', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机vSwitch ID。', + 'type' => 'string', + 'example' => 'vsw-bp1b3mvml55ziekq7e***', + ], + 'ElasticNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ElasticNode' => [ + 'description' => '弹性网关节点IP信息。', + 'type' => 'array', + 'items' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => '172.16.0.23', + ], + ], + ], + ], + 'GatewayId' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'example' => 'gw-0000ewknguw5o96vn***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'EcsInstanceId' => [ + 'description' => 'ECS实例ID。', + 'type' => 'string', + 'example' => 'i-uf62406gy5vyao4y8***', + ], + 'Type' => [ + 'description' => '参见GatewayType参数。', + 'type' => 'string', + 'example' => 'File', + ], + 'RenewURL' => [ + 'description' => '预付费情况下的续费链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew', + ], + 'VpcId' => [ + 'description' => '专有网络VPC ID。', + 'type' => 'string', + 'example' => 'vpc-uf6j237kxmsw08auey***', + ], + 'ActivatedTime' => [ + 'description' => '网关激活时间。时间戳为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578986214', + ], + 'ElasticGateway' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CommonBuyInstanceId' => [ + 'description' => '包年包月网关在售卖系统中的实例ID。', + 'type' => 'string', + 'example' => 'gw-000fhosecoziy6ri****', + ], + 'InnerIpv6Ip' => [ + 'description' => 'IPv6地址。', + 'type' => 'string', + 'example' => '2408:4004::ffff:ffff:ffff:ffff:ffff:ffff', + ], + 'LastErrorKey' => [ + 'description' => '错误关键字。', + 'type' => 'string', + 'example' => 'InternalError', + ], + 'Location' => [ + 'description' => '网关位置。可能值如下：'."\n" + ."\n" + .'- Cloud：线上网关'."\n" + ."\n" + .'- On_Premise：线下网关', + 'type' => 'string', + 'example' => 'Cloud', + ], + 'GatewayRegionId' => [ + 'description' => '网关地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'UntrustedEnvInstanceType' => [ + 'description' => '<props="china">非授信（[云盒](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)）场景下网关的实际规格。</props>'."\n" + ."\n" + .'<props="intl">非授信（[云盒](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)）场景下网关的实际规格。</props>', + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + 'UntrustedEnvOssEndpoint' => [ + 'description' => '<props="china">非授信（[云盒](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)）场景下网关的OSS Endpoint。</props>'."\n" + ."\n" + .'<props="intl">非授信（[云盒](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)）场景下网关的OSS Endpoint。</props>', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou.aliyuncs.com', + ], + 'HighAvailability' => [ + 'description' => '是否为高可用网关。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SecondaryVSwitchId' => [ + 'description' => '高可用网关备节点虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1xw499jo5****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"测试使用\\",\\n \\"CreatedTime\\": 1532099461,\\n \\"PublicNetworkBandwidth\\": 5,\\n \\"DataLoadType\\": \\" 废弃\\",\\n \\"Category\\": \\"Aliyun\\",\\n \\"TaskId\\": \\"t-0000iwdggbharrw6r***\\",\\n \\"Message\\": \\"successful\\",\\n \\"ExpireStatus\\": 0,\\n \\"Ip\\": \\"47.101.**.**\\",\\n \\"GatewayType\\": \\"File\\",\\n \\"StorageBundleId\\": \\"sb-000dt67z4ijqfocpy***\\",\\n \\"GatewayClass\\": \\"Basic\\",\\n \\"Success\\": true,\\n \\"Name\\": \\"alex***\\",\\n \\"IsPostPaid\\": true,\\n \\"Capacity\\": 500,\\n \\"ExpiredTime\\": 1532530021,\\n \\"GatewayVersion\\": \\"1.0.39\\",\\n \\"IsReleaseAfterExpiration\\": false,\\n \\"Status\\": \\"Initialized\\",\\n \\"BuyURL\\": \\"https://expense.console.aliyun.com/?returnExpense=true#/order/list/\\",\\n \\"MaxThroughput\\": 30,\\n \\"DataLoadInterval\\": 120,\\n \\"InnerIp\\": \\"172.19.55.65\\",\\n \\"RequestId\\": \\"736C7733-FCED-4AFB-8407-C325F210CE03\\",\\n \\"VSwitchId\\": \\"vsw-bp1b3mvml55ziekq7e***\\",\\n \\"ElasticNodes\\": {\\n \\"ElasticNode\\": [\\n \\"172.16.0.23\\"\\n ]\\n },\\n \\"GatewayId\\": \\"gw-0000ewknguw5o96vn***\\",\\n \\"Code\\": \\"200\\",\\n \\"EcsInstanceId\\": \\"i-uf62406gy5vyao4y8***\\",\\n \\"Type\\": \\"File\\",\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew\\",\\n \\"VpcId\\": \\"vpc-uf6j237kxmsw08auey***\\",\\n \\"ActivatedTime\\": 1578986214,\\n \\"ElasticGateway\\": false,\\n \\"CommonBuyInstanceId\\": \\"gw-000fhosecoziy6ri****\\",\\n \\"InnerIpv6Ip\\": \\"2408:4004::ffff:ffff:ffff:ffff:ffff:ffff\\",\\n \\"LastErrorKey\\": \\"InternalError\\",\\n \\"Location\\": \\"Cloud\\",\\n \\"GatewayRegionId\\": \\"cn-hangzhou\\",\\n \\"UntrustedEnvInstanceType\\": \\"ecs.g6.large\\",\\n \\"UntrustedEnvOssEndpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"HighAvailability\\": false,\\n \\"SecondaryVSwitchId\\": \\"vsw-bp1xw499jo5****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayResponse>\\n <Description>测试使用</Description>\\n <CreatedTime>1532099461</CreatedTime>\\n <PublicNetworkBandwidth>50</PublicNetworkBandwidth>\\n <DataLoadType>once</DataLoadType>\\n <Category>Aliyun</Category>\\n <TaskId>t-0000iwdggbharrw6r***</TaskId>\\n <Message>successful</Message>\\n <ExpireStatus>0</ExpireStatus>\\n <Ip>47.101.**.**</Ip>\\n <GatewayType>File</GatewayType>\\n <StorageBundleId>sb-000dt67z4ijqfocpy***</StorageBundleId>\\n <GatewayClass>Basic</GatewayClass>\\n <Success>true</Success>\\n <Name>alex***</Name>\\n <IsPostPaid>true</IsPostPaid>\\n <Capacity>500</Capacity>\\n <ExpiredTime>1532530021</ExpiredTime>\\n <GatewayVersion>1.0.39</GatewayVersion>\\n <IsReleaseAfterExpiration>false</IsReleaseAfterExpiration>\\n <Status>Initialized</Status>\\n <BuyURL>https://expense.console.aliyun.com/?returnExpense=true#/order/list/</BuyURL>\\n <MaxThroughput>30</MaxThroughput>\\n <DataLoadInterval>120</DataLoadInterval>\\n <InnerIp>172.19.55.65</InnerIp>\\n <RequestId>736C7733-FCED-4AFB-8407-C325F210CE03</RequestId>\\n <VSwitchId>vsw-bp1b3mvml55ziekq7e***</VSwitchId>\\n <ElasticNodes>172.16.0.23</ElasticNodes>\\n <GatewayId>gw-0000ewknguw5o96vn***</GatewayId>\\n <Code>200</Code>\\n <EcsInstanceId>i-uf62406gy5vyao4y8***</EcsInstanceId>\\n <Type>File</Type>\\n <RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew</RenewURL>\\n <VpcId>vpc-uf6j237kxmsw08auey***</VpcId>\\n <ActivatedTime>1578986214</ActivatedTime>\\n <ElasticGateway>false</ElasticGateway>\\n <CommonBuyInstanceId>i-uf6gjr3lnwhyrd6hu***</CommonBuyInstanceId>\\n <InnerIpv6Ip>2408:4004::ffff:ffff:ffff:ffff:ffff:ffff</InnerIpv6Ip>\\n <LastErrorKey>InternalError</LastErrorKey>\\n <Location>Cloud</Location>\\n <GatewayRegionId>cn-hangzhou</GatewayRegionId>\\n <UntrustedEnvInstanceType>ecs.g6.large</UntrustedEnvInstanceType>\\n <UntrustedEnvOssEndpoint>oss-cn-hangzhou.aliyuncs.com</UntrustedEnvOssEndpoint>\\n <HighAvailability>false</HighAvailability>\\n</DescribeGatewayResponse>","errorExample":""}]', + 'title' => '查询网关基本信息', + 'description' => '### 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'<props="china">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和[价格](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5&aly_as=C81M1m5N#/hcs_sgw/detail)。</props>'."\n" + .'<props="intl">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和价格。</props>'."\n" + ."\n" + .'- 如果您需要购买网关，您可以通过该接口返回的购买链接或续费链接进行购买或续费。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyGateway' => [ + 'summary' => '对指定网关的基本信息进行修改。包括网关的名称和描述。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031y***', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的网关名称。长度限制1~60个字符，可以包含大小写字母，中文，数字，“.”，“_”或“-”，同时必须以大小写字母或者中文开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的网关描述。长度限制0~255个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '测试使用', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '220E7407-DF77-428D-8955-B02CF8F82D07', + ], + 'GatewayId' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'example' => 'gw-0001xv7je3580031y***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'EmptyGatewayName', + 'errorMessage' => 'You must enter a valid name for the gateway.', + ], + [ + 'errorCode' => 'InvalidGatewayName', + 'errorMessage' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', + ], + [ + 'errorCode' => 'DescriptionOverLimit', + 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'DuplicateGatewayName', + 'errorMessage' => 'The specified name of the gateway already exists. You must specify a valid name.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"220E7407-DF77-428D-8955-B02CF8F82D07\\",\\n \\"GatewayId\\": \\"gw-0001xv7je3580031y***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyGatewayResponse>\\n <Message>successful</Message>\\n <RequestId>220E7407-DF77-428D-8955-B02CF8F82D07</RequestId>\\n <GatewayId>gw-0001xv7je3580031***</GatewayId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyGatewayResponse>","errorExample":""}]', + 'title' => '修改网关基本信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeployGateway' => [ + 'summary' => '调用DeployGateway接口可以部署一个按量付费的网关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031y***', + ], + ], + [ + 'name' => 'GatewayClass', + 'in' => 'query', + 'schema' => [ + 'description' => '网关规格。取值范围：'."\n" + ."\n" + .'- Basic：基础型。'."\n" + ."\n" + .'- Standard：标准型。'."\n" + ."\n" + .'- Enhanced：增强型。'."\n" + ."\n" + .'- Advanced：性能型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Basic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je35800307***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8FEAFE9D-66C2-46AB-833B-35269EC7524C', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'InvalidGatewayLocation', + 'errorMessage' => 'The specified location of the gateway is invalid.', + ], + [ + 'errorCode' => 'InvalidGatewayClass', + 'errorMessage' => 'The specified specification of the gateway is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je35800307***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8FEAFE9D-66C2-46AB-833B-35269EC7524C\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeployGatewayResponse>\\n <TaskId>t-0001xv7je35800307***</TaskId>\\n <Message>successful</Message>\\n <RequestId>8FEAFE9D-66C2-46AB-833B-35269EC7524C</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeployGatewayResponse>","errorExample":""}]', + 'title' => '部署一个按量付费的网关', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'- 仅支持按量付费的云上文件网关。'."\n" + ."\n" + .'- 仅支持部署状态为已初始化（Initialized）的云上文件网关。'."\n" + ."\n" + .'- 部署完成后，您可以调用DescribeGateway接口查询网关状态，当状态为运行中（Running）时表示网关部署完成。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTasks' => [ + 'summary' => '查询指定任务对应的信息。包括任务的进度和任务名称等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务所属对象ID。网关ID或者极速同步组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sync-0001xv757xl9sn548***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '任务列表信息的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。'."\n" + .'- 最大值：50。'."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。如果为空，则枚举所有任务。', + 'type' => 'string', + 'required' => false, + 'example' => 't-0001xv7je357xl9n***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '任务的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SimpleTask' => [ + 'description' => '任务信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StateCode' => [ + 'description' => '任务状态码。可能值：'."\n" + .'- task.state.Initialized：初始化。'."\n" + .'- task.state.Running：运行中。'."\n" + .'- task.state.completed：已完成。'."\n" + .'- task.state.Failed：失败。', + 'type' => 'string', + 'example' => 'task.state.completed', + ], + 'Progress' => [ + 'description' => '任务进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'UpdatedTime' => [ + 'description' => '任务信息最后修改时间戳。单位为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578367230', + ], + 'MessageKey' => [ + 'description' => '任务出错时候的代码。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'task.name.operate_fast_sync.delete', + ], + 'CreatedTime' => [ + 'description' => '任务创建时间戳。单位为秒（s）。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578367229', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xl9n***', + ], + 'RelatedResourceId' => [ + 'description' => '关联的资源ID。', + 'type' => 'string', + 'example' => 'NFSnfstest', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8E9C6D43-4603-4F05-BE76-677A05EDFB7A', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '任务列表信息的每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '任务信息的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyTargetId', + 'errorMessage' => 'You must enter a valid ID for the target gateway.', + ], + [ + 'errorCode' => 'BadPageSize', + 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', + ], + [ + 'errorCode' => 'BadPageNumber', + 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"Tasks\\": {\\n \\"SimpleTask\\": [\\n {\\n \\"StateCode\\": \\"task.state.completed\\",\\n \\"Progress\\": 100,\\n \\"UpdatedTime\\": 1578367230,\\n \\"MessageKey\\": \\"xxx\\",\\n \\"Name\\": \\"task.name.operate_fast_sync.delete\\",\\n \\"CreatedTime\\": 1578367229,\\n \\"TaskId\\": \\"t-0001xv7je357xl9n***\\",\\n \\"RelatedResourceId\\": \\"NFSnfstest\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8E9C6D43-4603-4F05-BE76-677A05EDFB7A\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeTasksResponse>\\n <TotalCount>1</TotalCount>\\n <Tasks>\\n <StateCode>task.state.completed</StateCode>\\n <Progress>100</Progress>\\n <UpdatedTime>1578367230</UpdatedTime>\\n <MessageKey>xxx</MessageKey>\\n <Name>task.name.operate_fast_sync.delete</Name>\\n <CreatedTime>1578367229</CreatedTime>\\n <TaskId>t-0001xv7je357xl9n***</TaskId>\\n <RelatedResourceId>NFSnfstest</RelatedResourceId>\\n </Tasks>\\n <RequestId>8E9C6D43-4603-4F05-BE76-677A05EDFB7A</RequestId>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeTasksResponse>","errorExample":""}]', + 'title' => '查询任务信息', + ], + 'DescribeGateways' => [ + 'summary' => '查询网关列表信息。包括网关ID，网关名称等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17215', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'StorageBundleId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关集群ID。'."\n" + .'>'."\n" + .'> - 如果不指定 ResourceRegionId，则必须指定该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'sb-0001b2otnkdxrigeq***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '网关列表信息的页码。'."\n" + ."\n" + .'- 起始值：1。'."\n" + ."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。'."\n" + ."\n" + .'- 最大值：50。'."\n" + ."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '指定网关集群ID下的网关总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2C4A8287-66F4-45F9-84E3-866E4232C763', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '网关列表每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '网关列表信息的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Gateways' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Gateway' => [ + 'description' => '网关列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网关信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络VPC ID。', + 'type' => 'string', + 'example' => 'vpc-bp1p0usrgr5z9e7lwr***', + ], + 'Status' => [ + 'description' => '网关状态。可能值：'."\n" + ."\n" + .'- Initialized：已初始化。'."\n" + ."\n" + .'- Deactivated：未激活。'."\n" + ."\n" + .'- Activated：已激活。'."\n" + ."\n" + .'- Deploying：部署中。'."\n" + ."\n" + .'- Running：运行中。'."\n" + ."\n" + .'- Stopping：停止中。'."\n" + ."\n" + .'- Stopped：已停止。'."\n" + ."\n" + .'- Starting：启动中。'."\n" + ."\n" + .'- Rebooting：重启中。'."\n" + ."\n" + .'- Deleting：删除中。'."\n" + ."\n" + .'- Failed：失败。'."\n" + ."\n" + .'- Upgrading：升级中。'."\n" + ."\n" + .'- Modifying：修改中。'."\n" + ."\n" + .'- Unknown：长时间没有心跳。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Type' => [ + 'description' => '参见GatewayType参数', + 'type' => 'string', + 'example' => 'File', + ], + 'Capacity' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'GatewayId' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'example' => 'gw-0001b2odzvl3b1mhi***', + ], + 'IsReleaseAfterExpiration' => [ + 'description' => '当付费类型为包年包月时，网关是否到期释放。可能值：'."\n" + ."\n" + .'- true：到期释放，直接收回。创建的云存储网关到期7天后，停止云存储网关服务。'."\n" + ."\n" + .'- false：创建的云存储网关到期后，转按量付费模式。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GatewayType' => [ + 'description' => '网关类型'."\n" + ."\n" + .'- File：文件网关'."\n" + ."\n" + .'- Iscsi：块网关', + 'type' => 'string', + 'example' => 'File', + ], + 'BuyURL' => [ + 'description' => '付费类型为包年包月时，返回购买链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}®ionId=cn-hangzhou#/buy', + ], + 'EcsInstanceId' => [ + 'description' => 'ECS实例ID。', + 'type' => 'string', + 'example' => 'gw-0001b2onkdzvl3b***', + ], + 'MaxThroughput' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30。', + ], + 'GatewayClass' => [ + 'description' => '网关规格。可能值：'."\n" + .'- Basic：基础型。'."\n" + ."\n" + .'- Standard：标准型。'."\n" + ."\n" + .'- Enhanced：增强型。'."\n" + ."\n" + .'- Advanced：性能型。', + 'type' => 'string', + 'example' => 'Advanced', + ], + 'InnerIp' => [ + 'description' => '挂载IP。', + 'type' => 'string', + 'example' => '172.16.0.21', + ], + 'Description' => [ + 'description' => '网关描述。', + 'type' => 'string', + 'example' => '测试使用', + ], + 'Name' => [ + 'description' => '网关名称。', + 'type' => 'string', + 'example' => 'fio-weekly***', + ], + 'InnerIpv6Ip' => [ + 'description' => 'IPv6地址。', + 'type' => 'string', + 'example' => '2408:4004:110:6000:4656:f88e:1c14:e578', + ], + 'CreatedTime' => [ + 'description' => '网关创建时间。时间戳为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1577179604', + ], + 'ExpireStatus' => [ + 'description' => '网关是否过期状态。可能值：'."\n" + ."\n" + .'- 0：正常。'."\n" + ."\n" + .'- 1：将要过期。'."\n" + ."\n" + .'- 2：已经过期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DataLoadInterval' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'RenewURL' => [ + 'description' => '续费链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew', + ], + 'IsPostPaid' => [ + 'description' => '付费类型。可能值：'."\n" + ."\n" + .'- true：按量付费，即后付费。'."\n" + ."\n" + .'- false：包年包月，即预付费。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PublicNetworkBandwidth' => [ + 'description' => '数据公网带宽，单位为Mbps。仅线上网关支持。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-0001b2otrigeqkso***', + ], + 'Ip' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '47.111.145.66', + ], + 'LastErrorKey' => [ + 'description' => '错误关键字。', + 'type' => 'string', + 'example' => 'InternalError', + ], + 'ElasticNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ElasticNode' => [ + 'description' => '废弃。', + 'type' => 'array', + 'items' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => '172.16.0.23', + ], + ], + ], + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机vSwitch ID。', + 'type' => 'string', + 'example' => 'vsw-bp1krhkgnahkb9stp0***', + ], + 'CommonBuyInstanceId' => [ + 'description' => '付费类型为包年包月时，在售卖系统中的实例ID。', + 'type' => 'string', + 'example' => 'gw-0001b2onkdzvl3b***', + ], + 'ExpiredTime' => [ + 'description' => '到期时间。时间戳为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1532426471', + ], + 'GatewayVersion' => [ + 'description' => '网关版本。', + 'type' => 'string', + 'example' => '1.2.6', + ], + 'DataLoadType' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => 'once', + ], + 'ElasticGateway' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Category' => [ + 'description' => '网关类别。'."\n" + ."\n" + .'- 默认：Aliyun。', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'ActivatedTime' => [ + 'description' => '激活时间。时间戳为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1577179769', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000978oflgrd8ah6p***', + ], + 'Location' => [ + 'description' => '网关位置。可能值：'."\n" + ."\n" + .'- Cloud：线上网关。'."\n" + ."\n" + .'- On_Premise：线下网关。', + 'type' => 'string', + 'example' => 'Cloud', + ], + 'GatewayRegionId' => [ + 'description' => '网关地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'UntrustedEnvInstanceType' => [ + 'description' => '<props="china">非授信（[云盒](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)）场景下网关的实际规格。</props>'."\n" + ."\n" + .'<props="intl">非授信（[云盒](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)）场景下网关的实际规格。</props>', + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + 'HighAvailability' => [ + 'description' => '是否为跨可用区高可用网关，返回值如下：'."\n" + .'- true：是跨可用区高可用网关。'."\n" + .'- false：不是跨可用区高可用网关。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SecondaryVSwitchId' => [ + 'description' => '虚拟交换机vSwitch ID。仅高可用网关支持。', + 'type' => 'string', + 'example' => 'vsw-bp1krhkgnahkb8stp0***', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyStorageBundleId', + 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', + ], + [ + 'errorCode' => 'BadPageSize', + 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', + ], + [ + 'errorCode' => 'BadPageNumber', + 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StorageBundleNotExist', + 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"2C4A8287-66F4-45F9-84E3-866E4232C763\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Gateways\\": {\\n \\"Gateway\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1p0usrgr5z9e7lwr***\\",\\n \\"Status\\": \\"Running\\",\\n \\"Type\\": \\"File\\",\\n \\"Capacity\\": 500,\\n \\"GatewayId\\": \\"gw-0001b2odzvl3b1mhi***\\",\\n \\"IsReleaseAfterExpiration\\": false,\\n \\"GatewayType\\": \\"File\\",\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***”,”directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}®ionId=cn-hangzhou#/buy\\",\\n \\"EcsInstanceId\\": \\"gw-0001b2onkdzvl3b***\\",\\n \\"MaxThroughput\\": 0,\\n \\"GatewayClass\\": \\"Advanced\\",\\n \\"InnerIp\\": \\"172.16.0.21\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"Name\\": \\"fio-weekly***\\",\\n \\"InnerIpv6Ip\\": \\"2408:4004:110:6000:4656:f88e:1c14:e578\\",\\n \\"CreatedTime\\": 1577179604,\\n \\"ExpireStatus\\": 0,\\n \\"DataLoadInterval\\": 120,\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew\\",\\n \\"IsPostPaid\\": true,\\n \\"PublicNetworkBandwidth\\": 55,\\n \\"StorageBundleId\\": \\"sb-0001b2otrigeqkso***\\",\\n \\"Ip\\": \\"47.111.145.66\\",\\n \\"LastErrorKey\\": \\"InternalError\\",\\n \\"ElasticNodes\\": {\\n \\"ElasticNode\\": [\\n \\"172.16.0.23\\"\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1krhkgnahkb9stp0***\\",\\n \\"CommonBuyInstanceId\\": \\"gw-0001b2onkdzvl3b***\\",\\n \\"ExpiredTime\\": 1532426471,\\n \\"GatewayVersion\\": \\"1.2.6\\",\\n \\"DataLoadType\\": \\"once\\",\\n \\"ElasticGateway\\": false,\\n \\"Category\\": \\"Aliyun\\",\\n \\"ActivatedTime\\": 1577179769,\\n \\"TaskId\\": \\"t-000978oflgrd8ah6p***\\",\\n \\"Location\\": \\"Cloud\\",\\n \\"GatewayRegionId\\": \\"cn-hangzhou\\",\\n \\"UntrustedEnvInstanceType\\": \\"ecs.g6.large\\",\\n \\"HighAvailability\\": false,\\n \\"SecondaryVSwitchId\\": \\"vsw-bp1krhkgnahkb8stp0***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewaysResponse>\\n <TotalCount>2</TotalCount>\\n <RequestId>2C4A8287-66F4-45F9-84E3-866E4232C763</RequestId>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Gateways>\\n <VpcId>vpc-bp1p0usrgr5z9e7lwr***</VpcId>\\n <Status>Running</Status>\\n <Type>File</Type>\\n <Capacity>500</Capacity>\\n <GatewayId>gw-0001b2odzvl3b1mhi***</GatewayId>\\n <IsReleaseAfterExpiration>false</IsReleaseAfterExpiration>\\n <GatewayType>File</GatewayType>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\"gateway_id\\":\\"gw-0007va9bnidei3s8a***”,”directBuy\\":\\"false\\",\\"gateway_class\\":\\"standard\\",\\"cache_cloud_efficiency_size\\":0}&regionId=cn-hangzhou#/buy</BuyURL>\\n <EcsInstanceId>gw-0001b2onkdzvl3b***</EcsInstanceId>\\n <MaxThroughput>30</MaxThroughput>\\n <GatewayClass>Advanced</GatewayClass>\\n <InnerIp>172.16.0.21</InnerIp>\\n <Description>测试使用</Description>\\n <Name>fio-weekly***</Name>\\n <InnerIpv6Ip>2408:4004:110:6000:4656:f88e:1c14:e578</InnerIpv6Ip>\\n <CreatedTime>1577179604</CreatedTime>\\n <ExpireStatus>0</ExpireStatus>\\n <DataLoadInterval>120</DataLoadInterval>\\n <RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew</RenewURL>\\n <IsPostPaid>true</IsPostPaid>\\n <PublicNetworkBandwidth>55</PublicNetworkBandwidth>\\n <StorageBundleId>sb-0001b2otrigeqkso***</StorageBundleId>\\n <Ip>47.111.145.66</Ip>\\n <LastErrorKey>InternalError</LastErrorKey>\\n <ElasticNodes>172.16.0.23</ElasticNodes>\\n <VSwitchId>vsw-bp1krhkgnahkb9stp0***</VSwitchId>\\n <CommonBuyInstanceId>gw-0001b2onkdzvl3b***</CommonBuyInstanceId>\\n <ExpiredTime>1532426471</ExpiredTime>\\n <GatewayVersion>1.2.6</GatewayVersion>\\n <DataLoadType>once</DataLoadType>\\n <ElasticGateway>false</ElasticGateway>\\n <Category>Aliyun</Category>\\n <ActivatedTime>1577179769</ActivatedTime>\\n <TaskId>t-000978oflgrd8ah6p***</TaskId>\\n <Location>Cloud</Location>\\n <GatewayRegionId>cn-hangzhou</GatewayRegionId>\\n <UntrustedEnvInstanceType>ecs.g6.large</UntrustedEnvInstanceType>\\n <HighAvailability>false</HighAvailability>\\n <SecondaryVSwitchId>vsw-bp1krhkgnahkb8stp0***</SecondaryVSwitchId>\\n </Gateways>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewaysResponse>","errorExample":""}]', + 'title' => '查询网关列表信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayCategories' => [ + 'summary' => '查询网关类别。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17200', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '<notice>'."\n" + ."\n" + .'- 必须指定该参数'."\n" + ."\n" + .'></notice>'."\n" + .'网关位置。取值范围：'."\n" + ."\n" + .'- Cloud：线上网关。'."\n" + ."\n" + .'- On_Premise：线下网关。', + 'type' => 'string', + 'required' => false, + 'example' => 'On_Premise', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => ' 请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DA9D8E2-2C27-5FD8-83D7-F0AA00C1****', + ], + 'Categories' => [ + 'description' => '网关类别。返回值如下：'."\n" + .'- Aliyun：阿里云云存储网关。'."\n" + .'- Apsara：混合云阵列网关 。', + 'type' => 'string', + 'example' => 'Aliyun,Apsara', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + .'- true：请求成功。 '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4DA9D8E2-2C27-5FD8-83D7-F0AA00C1****\\",\\n \\"Categories\\": \\"Aliyun,Apsara\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询网关类别', + ], + 'DescribeGatewayTypes' => [ + 'summary' => '根据网关位置，查询网关可用类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17222', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '网关位置。取值范围：'."\n" + ."\n" + .'- Cloud：线上网关。'."\n" + ."\n" + .'- On_Premise：线下网关。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Cloud', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Types' => [ + 'description' => '网关可用类型。网关类型之间以逗号分隔。可能值：'."\n" + ."\n" + .'- File：文件网关。'."\n" + ."\n" + .'- Iscsi：块网关。', + 'type' => 'string', + 'example' => 'File,Iscsi', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '787ECFD0-5F30-44C0-BB8F-56A964F66D01', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'InvalidGatewayLocation', + 'errorMessage' => 'The specified location of the gateway is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Types\\": \\"File,Iscsi\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"787ECFD0-5F30-44C0-BB8F-56A964F66D01\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayTypesResponse>\\n <code>200</code>\\n <message>successful</message>\\n <requestId>787ECFD0-5F30-44C0-BB8F-56A964F66D01</requestId>\\n <success>true</success>\\n <types>File,Iscsi</types>\\n</DescribeGatewayTypesResponse>","errorExample":""}]', + 'title' => '查询网关可用类型', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccountConfig' => [ + 'summary' => '查询账号配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '已弃用。', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-000hy2wefifsxau8****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ADBBF2E5-3B01-54D3-B2CA-F09EBD48****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'IsSupportServerSideEncryption' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsSupportClientSideEncryption' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'string', + 'example' => '200', + ], + 'IsSupportGatewayLogging' => [ + 'description' => '账户是否支持网关日志监控，可能取值如下：'."\n" + .'- true：支持。'."\n" + .'- false：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + ."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsSupportElasticGatewayBeta' => [ + 'description' => '废弃。', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADBBF2E5-3B01-54D3-B2CA-F09EBD48****\\",\\n \\"Message\\": \\"successful\\",\\n \\"IsSupportServerSideEncryption\\": false,\\n \\"IsSupportClientSideEncryption\\": true,\\n \\"Code\\": \\"200\\",\\n \\"IsSupportGatewayLogging\\": true,\\n \\"Success\\": true,\\n \\"IsSupportElasticGatewayBeta\\": true\\n}","type":"json"}]', + 'title' => '查询账号的配置信息', + ], + 'DescribeGatewayImages' => [ + 'summary' => '查询线下网关镜像信息。包括线下网关镜像的名称、描述等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17206', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '网关类型。取值范围：'."\n" + ."\n" + .'- File：文件网关。'."\n" + ."\n" + .'- Iscsi：块网关。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'File', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30DFF66156-3672-4204-B708-24389F01FC77', + ], + 'Images' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Image' => [ + 'description' => '线下网关镜像信息。', + 'type' => 'array', + 'items' => [ + 'description' => '线下网关镜像信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '镜像类型。', + 'type' => 'string', + 'example' => 'application/octet-stream', + ], + 'Description' => [ + 'description' => '镜像描述。可能值：'."\n" + ."\n" + .'- sgw.file.ova.description：用这个ova镜像在VMWare vSphere（支持6.0版本及以上）上安装云存储文件网关服务。'."\n" + ."\n" + .'- sgw.file.vhd.description：用这个vhd镜像在Microsoft HyperV上安装云存储文件网关服务。'."\n" + ."\n" + .'- sgw.file.kvm.description：用这个qcow2镜像在KVM上安装云存储文件网关服务。', + 'type' => 'string', + 'example' => 'sgw.file.kvm.description', + ], + 'Version' => [ + 'description' => '镜像版本。', + 'type' => 'string', + 'example' => '1.0.40', + ], + 'Size' => [ + 'description' => '镜像大小。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1063744588', + ], + 'Url' => [ + 'description' => '线下网关的下载地址。有效时间为1小时。', + 'type' => 'string', + 'example' => 'http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAI****************&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFv****', + ], + 'Title' => [ + 'description' => '线下网关镜像名字的i18n key。可能值：'."\n" + ."\n" + .'- sgw.file.ova.title：云存储性能型文件网关 vSphere（v6.0及以上）镜像。'."\n" + ."\n" + .'- sgw.file.vhd.title：云存储性能型文件网关HyperV镜像。'."\n" + ."\n" + .'- sgw.file.kvm.title：云存储性能型文件网关KVM镜像。', + 'type' => 'string', + 'example' => 'sgw.file.kvm.title', + ], + 'MD5' => [ + 'description' => '线下网关镜像文件的MD5SUM。', + 'type' => 'string', + 'example' => '48f43e6a906b28ed30ec40d****', + ], + 'Name' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'aliyun/file/1.0.40/image/sgw-file-1.0.39.v***', + ], + 'ModifiedDate' => [ + 'description' => '镜像修改日期。', + 'type' => 'string', + 'example' => '2019-07-24', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidGatewayType', + 'errorMessage' => 'The specified type of the gateway is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'OSSResourceAccountAccessFail', + 'errorMessage' => 'Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"30DFF66156-3672-4204-B708-24389F01FC77\\",\\n \\"Images\\": {\\n \\"Image\\": [\\n {\\n \\"Type\\": \\"application/octet-stream\\",\\n \\"Description\\": \\"sgw.file.kvm.description\\",\\n \\"Version\\": \\"1.0.40\\",\\n \\"Size\\": 1063744588,\\n \\"Url\\": \\"http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAI****************&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFv****\\",\\n \\"Title\\": \\"sgw.file.kvm.title\\",\\n \\"MD5\\": \\"48f43e6a906b28ed30ec40d****\\",\\n \\"Name\\": \\"aliyun/file/1.0.40/image/sgw-file-1.0.39.v***\\",\\n \\"ModifiedDate\\": \\"2019-07-24\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayImagesResponse>\\n <Message>successful</Message>\\n <RequestId>6BF67960-7782-4542-98AF-1E4B3B6E514B</RequestId>\\n <Images>\\n <Image>\\n <Type>application/octet-stre**</Type>\\n <Description>sgw.file.kvm.description</Description>\\n <Version>1.0.40</Version>\\n <Size>1063744512</Size>\\n <Title>sgw.file.kvm.title</Title>\\n <ModifiedDate>2019-07-24</ModifiedDate>\\n <Url>http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAISMVqr8***&Signature=%2BoTNVCxis8GMpv5NIRkFvE***%3D</Url>\\n <Name>aliyun/file/1.0.40/image/sgw-file-1.0.40.qc***</Name>\\n <MD5>76069b6a745dd360cd54064b***</MD5>\\n </Image>\\n <Image>\\n <Type>application/x-virtualbox-v***</Type>\\n <Description>sgw.file.vhd.description</Description>\\n <Version>1.0.39</Version>\\n <Size>1819893760</Size>\\n <Title>sgw.file.vhd.title</Title>\\n <ModifiedDate>2019-07-24</ModifiedDate>\\n <Url>http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.39.vhd?Expires=1564045229&OSSAccessKeyId=LTAINaSMVqr8***&Signature=MUfa0layij2ofNWzUAoSxg%3D***</Url>\\n <Name>aliyun/file/1.0.40/image/sgw-file-1.0.39.v***</Name>\\n <MD5>48f3ce6a906b30ec40d84bf***</MD5>\\n </Image>\\n </Images>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayImagesResponse>","errorExample":""}]', + 'title' => '查询线下网关镜像信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TriggerGatewayRemoteSync' => [ + 'summary' => '主动触发文件网关对指定路径进行一次反向同步。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwSTR2C0', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-0004wacp5e4ll1542****', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'NFSshare_12012112****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '触发反向同步的路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/dirchild24120121****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求错误代号，正确时为200。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '29BD52E7-CF30-418F-A240-E15A9351****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000avsri6tlyddgf****', + ], + 'Success' => [ + 'description' => '请求结果，返回值如下：'."\n" + ."\n" + .'- true：请求成功。 '."\n" + .' '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"29BD52E7-CF30-418F-A240-E15A9351****\\",\\n \\"TaskId\\": \\"t-000avsri6tlyddgf****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '触发网关反向同步指定路径', + ], + 'DescribeRegions' => [ + 'summary' => '调用DescribeRegions可以查询网关有效的地域信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17228', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E09C421A-A175-4D21-8928-ADF5643D15F8', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E09C421A-A175-4D21-8928-ADF5643D15F8\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <code>200</code>\\n <message>successful</message>\\n <regions>\\n <regionId>cn-hangzhou</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-shanghai</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-qingdao</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-beijing</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-zhangjiakou</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-huhehaote</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-shenzhen</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-chengdu</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-hongkong</regionId>\\n </regions>\\n <regions>\\n <regionId>ap-southeast-1</regionId>\\n </regions>\\n <regions>\\n <regionId>ap-southeast-2</regionId>\\n </regions>\\n <regions>\\n <regionId>ap-southeast-5</regionId>\\n </regions>\\n <regions>\\n <regionId>eu-central-1</regionId>\\n </regions>\\n <requestId>E09C421A-A175-4D21-8928-ADF5643D15F8</requestId>\\n <success>true</success>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => '查看可选的地域和可用区', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayClasses' => [ + 'summary' => '调用DescribeGatewayClasses可查询网关的所有可用规格。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17201', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Classes' => [ + 'description' => '网关规格。网关规格之间以逗号分隔。规格含义：'."\n" + ."\n" + .'- Basic：基础型。'."\n" + ."\n" + .'- Standard：标准型。'."\n" + ."\n" + .'- Enhanced：增强型。'."\n" + ."\n" + .'- Advanced：性能型。', + 'type' => 'string', + 'example' => 'Basic,Standard,Enhanced,Advanced', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Classes\\": \\"Basic,Standard,Enhanced,Advanced\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayClassesResponse>\\n <classes>Basic,Standard,Enhanced,Advanced</classes>\\n <code>200</code>\\n <message>successful</message>\\n <requestId>EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50</requestId>\\n <success>true</success>\\n</DescribeGatewayClassesResponse>","errorExample":""}]', + 'title' => '查询网关的所有可用规格', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ExpandGatewayNetworkBandwidth' => [ + 'summary' => '扩容网关数据公网带宽。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbv****', + ], + ], + [ + 'name' => 'NewNetworkBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '新设置的网络带宽。单位：mbps。取值范围：大于当前值~200。'."\n" + .'> '."\n" + .'> - 必须指定该参数'."\n" + .'> - 带宽峰值不作为业务承诺指标，仅作为参考值和带宽上限峰值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BuyURL' => [ + 'description' => '预付费网关支付链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xv4s****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4s****\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8****\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '扩容网关数据公网带宽', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'当网关所在地域与目标 OSS Bucket 所在地域不一致时，需通过此接口完成扩容操作以实现跨地域挂载。', + ], + 'CreateGatewayBlockVolume' => [ + 'summary' => '在块网关下创建一个块卷（iSCSI）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwJLV9QR', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000dt67z4ijngqvh1***', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷名称。长度限制1~32个字符，可以包含小写字母，数字，同时必须以小写字母开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'Recovery', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷是否启用恢复。如果启用恢复并且OSS Bucket之前被作为块卷的云存储，那么网关会尝试使用其中的元数据集进行块卷恢复。'."\n" + ."\n" + .'默认值：false，即会使用OSS Bucket创建新的块卷。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'VolumeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷协议。唯一取值：iSCSI。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'iSCSI', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷的容量大小。单位：GB。取值范围：'."\n" + ."\n" + .'1~262144。'."\n" + ."\n" + .'默认值：100。'."\n" + ."\n" + .'> 启用恢复情况下，该参数无效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'ChunkSize', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷存储分配单元。块卷的最小分配单位，为达到最佳的存储效率，建议与应用的存储分配单元一致。单位：Byte。取值范围：'."\n" + ."\n" + .'- 8192。'."\n" + ."\n" + .'- 16384。'."\n" + ."\n" + .'- 32768。'."\n" + ."\n" + .'- 65536。'."\n" + ."\n" + .'- 131072。'."\n" + ."\n" + .'默认值：32768。'."\n" + ."\n" + .'> 启用恢复情况下，该参数无效。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '32768', + ], + ], + [ + 'name' => 'CacheMode', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷缓存模式，默认值：Cache。取值范围：'."\n" + ."\n" + .'- Cache：缓存模式。'."\n" + ."\n" + .'- WriteThrough：写透模式。'."\n" + ."\n" + .'> '."\n" + .'> - 必须指定该参数。'."\n" + .'> - 缓存模式下，读写会优先访问网关本地缓存；写透模式下读写会直接访问云上OSS Bucket，通常情况下缓存模式读写性能更好。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cache', + ], + ], + [ + 'name' => 'ChapEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷是否启用iSCSI访问的CHAP认证，目前支持CHAP入站验证。'."\n" + ."\n" + .' 默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ChapInUser', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷启用iSCSI访问CHAP认证时，入站验证的用户名。长度限制1~32个字符，包含英文字母、数字。'."\n" + ."\n" + .'> 未开启Chap认证时该参数无效。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'chapInUser', + ], + ], + [ + 'name' => 'ChapInPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷启用iSCSI访问CHAP认证时，入站验证的密码。长度限制12-16个字符，可以包含英文、字母、数字或者符号“!”，“@”，“#”，“$”，“%”，“^”，“&”，“*”。'."\n" + ."\n" + .'> 未开启Chap认证时该参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'chapInPassword', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷对应的对象存储（OSS）Bucket名称。'."\n" + ."\n" + .'> 块卷不支持“回源特性”OSS Bucket。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bucketName', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷对应的对象存储（OSS）Bucket所在地域节点。'."\n" + ."\n" + .'> 区分内网及外网Endpoint，建议如果OSS Bucket和网关处于相同Region则使用内网Endpoint：oss-cn-shanghai-internal.aliyuncs.com。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss-cn-shanghai-internal.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucketSsl', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷是否启用SSL访问OSS Bucket。'."\n" + ."\n" + .'默认值：true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'LocalFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷使用的缓存盘内部设备名。可以通过DescribeGatewayCaches接口得到。'."\n" + ."\n" + .'> '."\n" + .'> - 当CacheMode为缓存模式时，LocalFilePath必须指定。'."\n" + .'> - 当CacheMode为写透模式时，该参数值无效。', + 'type' => 'string', + 'required' => false, + 'example' => '/dev/vdb', + ], + ], + [ + 'name' => 'OssBucketRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷对应的对象存储（OSS）Bucket所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000c6hshwukkbtxrb***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9083F167-95B1-4B40-B2CD-70DE068EC3**', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.BlockVolume.%s', + 'errorMessage' => 'The specified field %s for block volume is invalid. Please check it again.', + ], + [ + 'errorCode' => 'VersionNotSupported.BlockVolume.%s', + 'errorMessage' => 'The specified field %s for block volume is not supported by current gateway version. Please check it again.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkbtxrb***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9083F167-95B1-4B40-B2CD-70DE068EC3**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayBlockVolumeResponse>\\n <TaskId>t-000c6hshwukkbtxrb***</TaskId>\\n <Message>successful</Message>\\n <RequestId>9083F167-95B1-4B40-B2CD-70DE068EC3**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayBlockVolumeResponse>","errorExample":""}]', + 'title' => '创建块卷', + 'description' => '使用该接口时，需要注意如下事项：'."\n" + ."\n" + .'- 您已经创建部署完成块网关，如果采用缓存模式，需要该网关拥有未被使用的缓存盘；采用写透模式，可无需缓存盘。'."\n" + ."\n" + .'- 您拥有对象存储(OSS)的Bucket。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayBlockVolumes' => [ + 'summary' => '查询块网关卷详情，例如：操作状态、传输数据、地址、容量、端口、CHAP、OSS Bucket SSL、LUN ID、卷状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwJLV9QR', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000dt67z4ijngqvh***', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '索引ID。如果该字段为空，则枚举该网关上的所有块网关卷的配置信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'alex-or2020010816***', + ], + ], + [ + 'name' => 'Refresh', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制刷新缓存。取值范围入下：'."\n" + ."\n" + .'- true（默认）：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BlockVolumes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BlockVolume' => [ + 'description' => '块网关卷信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '操作状态。可能值：'."\n" + ."\n" + .'- 0：成功'."\n" + ."\n" + .'- 1：创建卷失败'."\n" + ."\n" + .'- 2：删除卷失败'."\n" + ."\n" + .'- 3：启用目标失败'."\n" + ."\n" + .'- 4：禁用目标失败'."\n" + ."\n" + .'- 5：数据库错误'."\n" + ."\n" + .'- 6：启用缓存失败'."\n" + ."\n" + .'- 7：禁用缓存失败'."\n" + ."\n" + .'- 8：系统错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ChunkSize' => [ + 'description' => '存储分配单元，单位为Byte。存储分配单元包括8 k、16 k、32 k、64 k、128 k，默认为32 K。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32768', + ], + 'TotalUpload' => [ + 'description' => '总上传数据量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123214564', + ], + 'DiskType' => [ + 'description' => '缓存盘类型。', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'DiskId' => [ + 'description' => '缓存盘ID。', + 'type' => 'string', + 'example' => 'd-bp1a8athxvwbja18***', + ], + 'Port' => [ + 'description' => '端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IndexId' => [ + 'description' => '索引ID。', + 'type' => 'string', + 'example' => 'alex-or2020010816***', + ], + 'TotalDownload' => [ + 'description' => '总下载数据量。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '56342324', + ], + 'ChapEnabled' => [ + 'description' => '是否启用CHAP。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Enabled' => [ + 'description' => '块卷是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Address' => [ + 'description' => '服务IP地址。', + 'type' => 'string', + 'example' => '172.16.0.22', + ], + 'Name' => [ + 'description' => '块卷名称。', + 'type' => 'string', + 'example' => 'alex', + ], + 'Target' => [ + 'description' => '卷目标。', + 'type' => 'string', + 'example' => 'iqn**************', + ], + 'OssEndpoint' => [ + 'description' => '块卷对应的对象存储（OSS） Bucket所在地域节点。'."\n" + .'<note>区分内网及外网Endpoint。建议如果OSS Bucket和网关处于相同Region则使用内网Endpoint：oss-cn-hangzhou-internal.aliyuncs.com。</note>', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', + ], + 'OssBucketName' => [ + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'example' => 'random***', + ], + 'CacheMode' => [ + 'description' => '缓存模式。可能值：'."\n" + ."\n" + .'- Cache：缓存模式。'."\n" + ."\n" + .'- WriteThrough：写透模式。', + 'type' => 'string', + 'example' => 'Cache', + ], + 'State' => [ + 'description' => '缓存状态。可能值：'."\n" + .' '."\n" + .'- clean：同步完成'."\n" + ."\n" + .'- dirty：同步未完成', + 'type' => 'string', + 'example' => 'clean', + ], + 'Protocol' => [ + 'description' => '协议。', + 'type' => 'string', + 'example' => 'iSCSI', + ], + 'LunId' => [ + 'description' => 'LUN ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OssBucketSsl' => [ + 'description' => '是否使用OSS BUCKET SSL。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VolumeState' => [ + 'description' => '卷状态。可能值：'."\n" + ."\n" + .'- 0：失败'."\n" + ."\n" + .'- 1：完成'."\n" + ."\n" + .'- 2：创建中'."\n" + ."\n" + .'- 3：删除中'."\n" + ."\n" + .'- 4：启用中'."\n" + ."\n" + .'- 5：禁用中'."\n" + ."\n" + .'- 6：运行中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LocalPath' => [ + 'description' => '缓存盘本地路径。', + 'type' => 'string', + 'example' => '/dev/vdb', + ], + 'ChapInUser' => [ + 'description' => '入站CHAP用户。', + 'type' => 'string', + 'example' => 'alex***', + ], + 'Size' => [ + 'description' => '容量。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107374182400', + ], + 'OssBucketRegionId' => [ + 'description' => '块卷对应的对象存储（OSS）Bucket所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '787D4AD4-5536-4C36-9FB0-D74C0554D344', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInUpgrading', + 'errorMessage' => 'The gateway is upgrading. Try again later.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BlockVolumes\\": {\\n \\"BlockVolume\\": [\\n {\\n \\"Status\\": 0,\\n \\"ChunkSize\\": 32768,\\n \\"TotalUpload\\": 123214564,\\n \\"DiskType\\": \\"cloud_efficiency\\",\\n \\"DiskId\\": \\"d-bp1a8athxvwbja18***\\",\\n \\"Port\\": 0,\\n \\"IndexId\\": \\"alex-or2020010816***\\",\\n \\"TotalDownload\\": 56342324,\\n \\"ChapEnabled\\": true,\\n \\"Enabled\\": true,\\n \\"Address\\": \\"172.16.0.22\\",\\n \\"Name\\": \\"alex\\",\\n \\"Target\\": \\"iqn**************\\",\\n \\"OssEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"OssBucketName\\": \\"random***\\",\\n \\"CacheMode\\": \\"Cache\\",\\n \\"State\\": \\"clean\\",\\n \\"Protocol\\": \\"iSCSI\\",\\n \\"LunId\\": 0,\\n \\"OssBucketSsl\\": true,\\n \\"VolumeState\\": 1,\\n \\"LocalPath\\": \\"/dev/vdb\\",\\n \\"ChapInUser\\": \\"alex***\\",\\n \\"Size\\": 107374182400,\\n \\"OssBucketRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"787D4AD4-5536-4C36-9FB0-D74C0554D344\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayBlockVolumesResponse>\\n <BlockVolumes>\\n <BlockVolume>\\n <TotalDownload>0</TotalDownload>\\n <Address>172.16.0.40</Address>\\n <TotalUpload>0</TotalUpload>\\n <ChapOutUser/>\\n <LunId>0</LunId>\\n <Size>107374182400</Size>\\n <ChapEnabled>false</ChapEnabled>\\n <Port>0</Port>\\n <CacheMode>Cache</CacheMode>\\n <LocalPath>/dev/vdb</LocalPath>\\n <Name>alex</Name>\\n <DiskType>cloud_efficiency</DiskType>\\n <Target/>\\n <OssEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</OssEndpoint>\\n <Protocol>iSCSI</Protocol>\\n <Status>0</Status>\\n <IndexId>alex-or20200108161***</IndexId>\\n <Enabled>false</Enabled>\\n <VolumeState>1</VolumeState>\\n <OssBucketSsl>true</OssBucketSsl>\\n <ChunkSize>32768</ChunkSize>\\n <State>clean</State>\\n <OssBucketName>random***</OssBucketName>\\n <ChapInUser/>\\n <DiskId>d-bp1a8athxvwbja18h***</DiskId>\\n </BlockVolume>\\n </BlockVolumes>\\n <Message>successful</Message>\\n <RequestId>787D4AD4-5536-4C36-9FB0-D74C0554D185</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayBlockVolumesResponse>","errorExample":""}]', + 'title' => '查询块卷', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateGatewayBlockVolume' => [ + 'summary' => '在块网关下更新块卷配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwJLV9QR', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '索引ID。可以通过DescribeGatewayBlockVolumes接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFSalex***', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷的容量大小，单位为GB。取值范围为1~262144，默认值为100。'."\n" + .'>启用恢复情况下，该参数无效。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'ChapEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷是否启用iSCSI访问的CHAP认证，目前支持CHAP入站验证。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否'."\n" + ."\n" + .'- true：是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ChapInUser', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷启用iSCSI访问CHAP认证时，入站验证的用户名。长度限制1~32个字符，包含英文字母和数字。'."\n" + .'>未开启Chap认证时该参数无效。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'ChapInPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '块卷启用iSCSI访问CHAP认证时，入站验证的密码。长度限制12~16个字符，可以包含英文字母，数字，或者符号"!"、"@"、"#"、"$"、"%"、"^"、"&"、"*"。'."\n" + .'>未开启Chap认证时该参数无效。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ChapInPassword', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000avsri6tlyddgfe***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EBAF769F-2E88-4D81-AF1E-A34FAACF9***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果描述。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.BlockVolume.%s', + 'errorMessage' => 'The specified field %s for block volume is invalid. Please check it again.', + ], + [ + 'errorCode' => 'VersionNotSupported.BlockVolume.%s', + 'errorMessage' => 'The specified field %s for block volume is not supported by current gateway version. Please check it again.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000avsri6tlyddgfe***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateGatewayBlockVolumeResponse>\\n <TaskId>t-000avsri6tlyddgfe***</TaskId>\\n <Message>successful</Message>\\n <RequestId>EBAF769F-2E88-4D81-AF1E-A34FAACF9***</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateGatewayBlockVolumeResponse>","errorExample":""}]', + 'title' => '更新块卷', + 'description' => '使用该接口时，需要注意如下事项：'."\n" + ."\n" + .'- 您已经创建部署完成块网关，并已经完成一个块卷的配置。'."\n" + ."\n" + .'- 该更新接口会更新块卷对应的所有暴露参数，如果您不想更新某个参数，请调用时务必传入该参数原值，否则该块卷参数会被设置成默认值。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteGatewayBlockVolumes' => [ + 'summary' => '删除指定的块网关块卷。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwJLV9QR', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwb***', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '索引ID。可以通过DescribeGatewayBlockVolumes接口获得。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFSalex-gx***', + ], + ], + [ + 'name' => 'IsSourceDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除源数据。可能值：'."\n" + ."\n" + .'- true：删除块网关卷时同时删除云上OSS Bucket中的数据，请谨慎操作。'."\n" + ."\n" + .'- false：删除块网关卷时不删除云上OSS Bucket中的数据。'."\n" + .'默认false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务id。', + 'type' => 'string', + 'example' => 't-0000iwdggbhaordhk***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successsful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '151BB31D-571D-4BB9-9A02-D4210E5BF5DB', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'EmptyVolumeIndexId', + 'errorMessage' => 'You must enter an index ID for the block volume.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0000iwdggbhaordhk***\\",\\n \\"Message\\": \\"successsful\\",\\n \\"RequestId\\": \\"151BB31D-571D-4BB9-9A02-D4210E5BF5DB\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TaskId>t-0000iwdggbhaordhk***</TaskId>\\n<RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>\\n<Message>successsful</Message>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '删除块卷', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGatewayFileShare' => [ + 'summary' => '在文件网关下创建文件共享。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17169', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享名称。长度限制1~255个字符，可以包含大小写字母，数字，“.”，“_”或“-”。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex***', + ], + ], + [ + 'name' => 'ShareProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享协议。取值范围：'."\n" + ."\n" + .'- NFS。'."\n" + ."\n" + .'- SMB。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFS', + ], + ], + [ + 'name' => 'RemoteSync', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否打开反向同步。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否'."\n" + ."\n" + .'- true：是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PollingInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享反向同步时间间隔。取值范围为15~36000。'."\n" + ."\n" + .'>在复制模式+反向同步启用下载文件数据时，取值范围为3600~36000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4500', + ], + ], + [ + 'name' => 'IgnoreDelete', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否忽略删除。启用后网关侧删除文件不会删除云上（OSS）对应文件。'."\n" + ."\n" + .'- false（默认）：否'."\n" + .'- true：是'."\n" + ."\n" + .'>网关版本大于等于1.0.40支持。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FrontendLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享最大写入速度，单位为MB/s。取值范围为0~1280，默认值为0，表示无限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'BackendLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享最大上传速度，单位为MB/s。取值范围为0~1280，默认值为0，表示无限制。'."\n" + .'>同时如果已限制最大写入速度，最大上传速度不能小于最大写入速度。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'InPlace', + 'in' => 'query', + 'schema' => [ + 'description' => '已废弃，不建议设置。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CacheMode', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享缓存模式。取值范围如下：'."\n" + ."\n" + .'- Cache：缓存模式'."\n" + ."\n" + .'- Sync：复制模式', + 'type' => 'string', + 'required' => false, + 'example' => 'Cache', + ], + ], + [ + 'name' => 'Browsable', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下是否可浏览（即网络邻居中是否可发现），取值范围如下：'."\n" + ."\n" + .'- true（默认）：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'> '."\n" + .'> - 该参数在NFS协议下无效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Squash', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下用户映射。取值范围如下：'."\n" + ."\n" + .'- none（默认）'."\n" + ."\n" + .'- root_squash'."\n" + ."\n" + .'- all_squash'."\n" + ."\n" + .'- all_anonymous', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + [ + 'name' => 'ReadWriteUserList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下读写用户列表。多个用户使用逗号“,”分隔。'."\n" + .'>'."\n" + .'> - 该参数在NFS协议下无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1，user2', + ], + ], + [ + 'name' => 'ReadOnlyUserList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下只读用户列表。多个用户使用逗号“,”分隔。'."\n" + ."\n" + .'> '."\n" + .'> - 该参数在NFS协议下无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'userA，userB', + ], + ], + [ + 'name' => 'ReadWriteClientList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下读写客户端列表（可以是IP地址或者IP地址范围）。多个客户端使用逗号“,”分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '12.12.12.12', + ], + ], + [ + 'name' => 'ReadOnlyClientList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下只读客户端列表（可以是IP地址或者IP地址范围）。多个客户端使用“,”分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '12.12.12.12', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享对应的对象存储（OSS）Bucket名称。'."\n" + ."\n" + .'>'."\n" + .'> - 文件共享不支持“冷归档类型”和“回源特性”的OSS桶。'."\n" + .'> - 开启多Bucket聚合功能时，多个OssBucketName请用逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testbucket', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享对应的对象存储（OSS）Bucket所在地域节点。'."\n" + .'>区分内网及外网Endpoint。建议如果OSS Bucket和网关处于相同Region则使用内网Endpoint：oss-cn-hangzhou-internal.aliyuncs.com。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucketSsl', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否启用SSL访问OSS Bucket。取值范围如下：'."\n" + ."\n" + .'- true（默认）：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'LagPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '同步延迟，即网关本地缓存同步到云上OSS的延迟时间。单位为秒。取值范围为5~120，默认值为5。'."\n" + .'>网关版本大于等于1.0.40支持。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'DirectIO', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LocalFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享使用的缓存盘内部设备名，可以通过DescribeGatewayCaches接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/dev/vdb', + ], + ], + [ + 'name' => 'ServerSideEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServerSideCmk', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + ], + [ + 'name' => 'ClientSideEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientSideCmk', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + ], + [ + 'name' => 'KmsRotatePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PathPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享对应的对象存储（OSS）Bucket下的子目录路径。为空则代表对应的是Bucket的根目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'FastReclaim', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否开启上传优化，适合数据纯备份上云场景。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否'."\n" + .'- true：是'."\n" + ."\n" + .'>网关版本大于等于1.0.39支持。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SupportArchive', + 'in' => 'query', + 'schema' => [ + 'description' => '已废弃，不建议设置。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'WindowsAcl', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下，是否开启通过Windows访问列表（需要AD域）进行权限控制。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否'."\n" + .'- true：是'."\n" + ."\n" + .'>网关版本大于等于1.0.45支持。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AccessBasedEnumeration', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下，是否启用Windows ABE，需要windowsAcl参数设置为true情况下生效。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否'."\n" + .'- true：是'."\n" + ."\n" + .'>网关版本大于等于1.0.45支持。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NfsV4Optimization', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下，是否启用NFS v4优化，提升挂载上传效率。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'>开启后将不支持NFS v3形式挂载。网关版本大于等于1.2.0支持。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TransferAcceleration', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否开启传输加速功能，需要对应OSS Bucket已开启传输加速。'."\n" + .'>网关版本大于等于1.3.0支持。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RemoteSyncDownload', + 'in' => 'query', + 'schema' => [ + 'description' => '复制模式情况下，是否下载文件数据。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否'."\n" + .'- true：是'."\n" + ."\n" + .'>只有当该共享打开了反向同步或者加入极速同步组时候，此参数才生效。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DownloadLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享最大下载速度，单位为MB/s。取值范围为0~1280，0表示无限制。'."\n" + .'>- 只在复制模式且开启下载文件数据的情况下才可设置。- 只有当该共享打开了反向同步或者加入极速同步组时候，此参数才生效。- 网关版本大于等于1.3.0支持。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PartialSyncPaths', + 'in' => 'query', + 'schema' => [ + 'description' => '复制模式下，通过设置目录路径集合，指定仅有这些目录采用复制模式。'."\n" + .'>需要联系我们开启白名单后才可进行相关设置。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'ServerSideAlgorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'AES256', + ], + ], + [ + 'name' => 'BypassCacheRead', + 'in' => 'query', + 'schema' => [ + 'description' => '是否直读OSS。取值范围如下：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false（默认）：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BindIPAddr', + 'in' => 'query', + 'schema' => [ + 'description' => '仅高可用网关使用，设置共享绑定的虚拟挂载IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.10', + ], + ], + [ + 'name' => 'OssBucketRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享对应的对象存储（OSS）Bucket所在地域。'."\n" + .'> '."\n" + .'> - 当网关版本大于等于2.0.0，并正确传入该参数，网关会使用OSS v4签名算法访问OSS桶中的数据。'."\n" + .'> - 当网关版本小于2.0.0，或未正确传入该参数，网关会使用OSS v1签名算法访问OSS桶中的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BucketInfos', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-aliyun', + ], + 'Endpoint' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-cn-hangzhou.aliyuncs.com', + ], + 'PathPrefix' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'BucketStub', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8B59F29-453D-49BF-8673-EEB8F9F2D5C6', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 't-000eg44nmxbsh3qk***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.FileShare.%s', + 'errorMessage' => 'The specified field %s for file share is invalid. Please check it again.', + ], + [ + 'errorCode' => 'VersionNotSupported.FileShare.%s', + 'errorMessage' => 'The specified field %s for file share is not supported by current gateway version. Please check it again.', + ], + [ + 'errorCode' => 'FileShareArchiveSupportConflict', + 'errorMessage' => 'You can configure the ArchiveSupport parameter only with NFS protocol and when the user mapping value is "none".', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"t-000eg44nmxbsh3qk***\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayFileShareResponse>\\n <TaskId>t-000eg44nmxbsh3qk***</TaskId>\\n <Message>successful</Message>\\n <RequestId>F8B59F29-453D-49BF-8673-EEB8F9F2D5C6</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayFileShareResponse>","errorExample":""}]', + 'title' => '创建文件共享', + 'description' => '使用该接口时，需要注意如下事项：'."\n" + ."\n" + .'- 您已经创建部署完成文件网关，并且该网关拥有未被使用的缓存盘。'."\n" + ."\n" + .'- 您拥有对象存储(OSS)的Bucket。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayFileStatus' => [ + 'summary' => '查询文件网关某个共享下单个文件的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17205', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0004wacp5e4ll1542****', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享ID。可以通过DescribeGatewayFileShares接口获得。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFSalex-gx-nfs-1201****', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sub/cptestfile****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '查询文件网关某个共享下某个文件的状态，返回值如下：'."\n" + .'- Not found：文件路径不存在。'."\n" + .'- Clean:文件已同步。'."\n" + .'- Waiting to upload：文件待上传。'."\n" + .'- Uploading：文件上传中。'."\n" + .'- Waiting to download：文件待下载。'."\n" + .'- Downloading：文件下载中。'."\n" + .'- Unknown status：文件状态未知, 建议重试。', + 'type' => 'string', + 'example' => 'Clean', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA****', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + .'- true：请求成功。 '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Clean\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询文件共享下文件的状态', + ], + 'DescribeGatewayFileShares' => [ + 'summary' => '获取文件网关上共享的配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17204', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享的ID。如果该字段为空，则枚举该网关上的所有文件共享的配置信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'NFSd-million', + ], + ], + [ + 'name' => 'Refresh', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制刷新缓存。默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'FileShares' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileShare' => [ + 'description' => '共享配置信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccessBasedEnumeration' => [ + 'description' => '是否基于访问权限的枚举。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ActiveMessages' => [ + 'description' => '活跃的消息数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Address' => [ + 'description' => '共享的VPC内网地址。', + 'type' => 'string', + 'example' => '172.16.0.44', + ], + 'BeLimit' => [ + 'description' => '最大上传速度。0代表无限制。单位：B/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BindIPAddr' => [ + 'description' => '共享绑定的挂载IP。', + 'type' => 'string', + 'example' => '192.0.0.0', + ], + 'Browsable' => [ + 'description' => '共享是否可浏览。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BucketInfos' => [ + 'description' => '多Bucket信息。', + 'type' => 'string', + 'example' => '[{\\"Endpoint\\":\\"oss-cn-hangzhou.aliyuncs.com\\",\\"Name\\":\\"bucket1\\",\\"PathPrefix\\":\\"\\"},{\\"Endpoint\\":\\"oss-cn-hangzhou.aliyuncs.com\\",\\"Name\\":\\"bucket2\\",\\"PathPrefix\\":\\"\\"}]', + ], + 'BucketsStub' => [ + 'description' => '是否已启用多Bucket聚合。false表示未启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BypassCacheRead' => [ + 'description' => '是否已启用直读OSS功能。false表示未启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CacheMode' => [ + 'description' => '文件共享缓存模式。可能值：'."\n" + .'- Cache：缓存模式。'."\n" + .'- Sync：复制模式。', + 'type' => 'string', + 'example' => 'Cache', + ], + 'ClientSideCmk' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ClientSideEncryption' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DirectIO' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DiskId' => [ + 'description' => '文件共享对应缓存盘的ID。仅线上网关返回该值。', + 'type' => 'string', + 'example' => 'd-bp1cvy8o2569jij31***', + ], + 'DiskType' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'DownloadLimit' => [ + 'description' => '最大下载速度。0代表无限制。单位：B/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DownloadQueue' => [ + 'description' => '下载队列', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'DownloadRate' => [ + 'description' => '下载速率。单位：B/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Enabled' => [ + 'description' => '共享是否生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExpressSyncId' => [ + 'description' => '极速同步组ID。', + 'type' => 'string', + 'example' => 'sync-0001xv7je357xn8tr***', + ], + 'FastReclaim' => [ + 'description' => '是否已启用上传优化功能。false表示未启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FeLimit' => [ + 'description' => '最大写入速度。0代表无限制。单位：B/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FileNumLimit' => [ + 'description' => '文件系统支持的文件数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10200202', + ], + 'FsSizeLimit' => [ + 'description' => '文件系统容量。单位：B。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70368744177664', + ], + 'HighWatermark' => [ + 'description' => '最高水位设定值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'IgnoreDelete' => [ + 'description' => '是否已启用忽略删除功能。false表示未启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InPlace' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InRate' => [ + 'description' => '缓存增速。单位：B/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IndexId' => [ + 'description' => '文件共享ID。', + 'type' => 'string', + 'example' => 'NFSale***', + ], + 'KmsRotatePeriod' => [ + 'description' => '密钥轮转周期。单位为秒。', + 'type' => 'string', + 'example' => '0', + ], + 'LagPeriod' => [ + 'description' => '上传延时。单位：s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'LocalPath' => [ + 'description' => '缓存盘内部设备名。', + 'type' => 'string', + 'example' => '/dev/vdb', + ], + 'LowWatermark' => [ + 'description' => '最低水位设定值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'MnsHealth' => [ + 'description' => '消息队列健康状态。可能值：'."\n" + .'- TopicAndQueueFailure: 消息队列消息主题无法访问。'."\n" + .'- TopicFailure: 消息主题无法访问。'."\n" + .'- MNSFullSyncInit: 全量同步等待中。'."\n" + .'- MNSFullSyncing: 全量同步进行中 。'."\n" + .'- QueueFailure: 消息队列无法访问。'."\n" + .'- MNSNotEnabled: 极速同步未开启。'."\n" + .'- MNSHealthy: 同步正常。', + 'type' => 'string', + 'example' => 'MNSNotEnabled', + ], + 'Name' => [ + 'description' => '共享名称。', + 'type' => 'string', + 'example' => 'alex***', + ], + 'NfsV4Optimization' => [ + 'description' => '是否已启用NFS V4优化。false表示未启用。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'NoPartition' => [ + 'description' => '是否有分区。true表示没有。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ObsoleteBuckets' => [ + 'description' => '多Bucket聚合下，正在移除的Bucket。', + 'type' => 'string', + 'example' => 'bucket1', + ], + 'OssBucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'bucketA', + ], + 'OssBucketSsl' => [ + 'description' => '是否使用SSL连接OSS Bucket。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OssEndpoint' => [ + 'description' => '连接OSS Bucket的地域节点。', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', + ], + 'OssHealth' => [ + 'description' => 'OSS Bucket的健康状态。可能值：'."\n" + .'- BucketHealthy：OSS连接正常。'."\n" + .'- BucketAccessDenied : OSS访问权限异常。'."\n" + .'- BucketMiscFailure： OSS访问其他异常。'."\n" + .'- BucketNetworkFailure： OSS访问网络异常。'."\n" + .'- BucketNotExist： OSS Bucket不存在。'."\n" + .'- 什么都没返回：未知。', + 'type' => 'string', + 'example' => 'BucketHealthy', + ], + 'OssUsed' => [ + 'description' => '云端数据量。单位：B。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OutRate' => [ + 'description' => '上传速度。单位：B/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PartialSyncPaths' => [ + 'description' => '部分复制模式下，目录路径组，JSON格式。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'PathPrefix' => [ + 'description' => 'OSS子目录。', + 'type' => 'string', + 'example' => 'testprefix', + ], + 'PollingInterval' => [ + 'description' => '反向同步时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900', + ], + 'Protocol' => [ + 'description' => '共享类型。可能值：'."\n" + .'- SMB。'."\n" + .'- NFS。', + 'type' => 'string', + 'example' => 'SMB', + ], + 'RemainingMetaSpace' => [ + 'description' => '可使用元数据空间。单位：B。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21308227584', + ], + 'RemoteSync' => [ + 'description' => '是否已启用反向同步。false表示未启用。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'RemoteSyncDownload' => [ + 'description' => '反向同步下是否下载文件数据。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RoClientList' => [ + 'description' => '只读客户端列表。当Protocol为NFS时返回。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'RoUserList' => [ + 'description' => '只读用户列表。当Protocol为SMB时返回。', + 'type' => 'string', + 'example' => 'user1', + ], + 'RwClientList' => [ + 'description' => '读写客户端列表。当Protocol为NFS时返回。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'RwUserList' => [ + 'description' => '读写用户列表。当Protocol为SMB时返回。', + 'type' => 'string', + 'example' => 'user2', + ], + 'ServerSideAlgorithm' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => 'AES256', + ], + 'ServerSideCmk' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ServerSideEncryption' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Size' => [ + 'description' => '缓存容量。单位：B。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '85899345920', + ], + 'Squash' => [ + 'description' => '用户映射。', + 'type' => 'string', + 'example' => 'root_squash', + ], + 'State' => [ + 'description' => '文件同步状态。可能值：'."\n" + .'- clean：同步完成。'."\n" + .'- dirty：同步未完成。', + 'type' => 'string', + 'example' => 'clean', + ], + 'Status' => [ + 'description' => '共享的启停状态。可能值：'."\n" + .'- started'."\n" + .'- stopped', + 'type' => 'string', + 'example' => 'started', + ], + 'SupportArchive' => [ + 'description' => '是否支持归档透明读取。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SyncProgress' => [ + 'description' => '全量同步进度。'."\n" + .'- 当共享已加入同步组的情况下，该返回参数有效， 表明共享全量同步进度(0 ~ 100)。'."\n" + .'- -2：表示共享所在网关版本不支持该功能。'."\n" + .'- -1：表示共享并未发生全量同步。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-2', + ], + 'Throttling' => [ + 'description' => '共享是否限流。false表示未限流。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TotalDownload' => [ + 'description' => '从OSS Bucket到网关总下载量。单位：B。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalUpload' => [ + 'description' => '从OSS Bucket到网关总上传量。单位：B。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TransferAcceleration' => [ + 'description' => '是否开启传输加速。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'UploadQueue' => [ + 'description' => '上传队列。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Used' => [ + 'description' => '已使用缓存。单位：B。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'WindowsAcl' => [ + 'description' => '是否已启用Windows权限支持。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OssBucketRegionId' => [ + 'description' => '文件共享对应的对象存储（OSS）Bucket所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A3C3C32-3F37-4658-9D38-945D0799CA0E', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + .'- true：请求成功。 '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInUpgrading', + 'errorMessage' => 'The gateway is upgrading. Try again later.', + ], + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"FileShares\\": {\\n \\"FileShare\\": [\\n {\\n \\"AccessBasedEnumeration\\": false,\\n \\"ActiveMessages\\": 0,\\n \\"Address\\": \\"172.16.0.44\\",\\n \\"BeLimit\\": 0,\\n \\"BindIPAddr\\": \\"192.0.0.0\\",\\n \\"Browsable\\": true,\\n \\"BucketInfos\\": \\"[{\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bucket1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PathPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bucket2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PathPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}]\\",\\n \\"BucketsStub\\": false,\\n \\"BypassCacheRead\\": false,\\n \\"CacheMode\\": \\"Cache\\",\\n \\"ClientSideCmk\\": \\"xxx\\",\\n \\"ClientSideEncryption\\": false,\\n \\"DirectIO\\": false,\\n \\"DiskId\\": \\"d-bp1cvy8o2569jij31***\\",\\n \\"DiskType\\": \\"cloud_efficiency\\",\\n \\"DownloadLimit\\": 0,\\n \\"DownloadQueue\\": 5,\\n \\"DownloadRate\\": 0,\\n \\"Enabled\\": true,\\n \\"ExpressSyncId\\": \\"sync-0001xv7je357xn8tr***\\",\\n \\"FastReclaim\\": false,\\n \\"FeLimit\\": 0,\\n \\"FileNumLimit\\": 10200202,\\n \\"FsSizeLimit\\": 70368744177664,\\n \\"HighWatermark\\": 80,\\n \\"IgnoreDelete\\": false,\\n \\"InPlace\\": false,\\n \\"InRate\\": 0,\\n \\"IndexId\\": \\"NFSale***\\",\\n \\"KmsRotatePeriod\\": \\"0\\",\\n \\"LagPeriod\\": 5,\\n \\"LocalPath\\": \\"/dev/vdb\\",\\n \\"LowWatermark\\": 60,\\n \\"MnsHealth\\": \\"MNSNotEnabled\\",\\n \\"Name\\": \\"alex***\\",\\n \\"NfsV4Optimization\\": false,\\n \\"NoPartition\\": true,\\n \\"ObsoleteBuckets\\": \\"bucket1\\",\\n \\"OssBucketName\\": \\"bucketA\\",\\n \\"OssBucketSsl\\": false,\\n \\"OssEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"OssHealth\\": \\"BucketHealthy\\",\\n \\"OssUsed\\": 0,\\n \\"OutRate\\": 0,\\n \\"PartialSyncPaths\\": \\"xxx\\",\\n \\"PathPrefix\\": \\"testprefix\\",\\n \\"PollingInterval\\": 900,\\n \\"Protocol\\": \\"SMB\\",\\n \\"RemainingMetaSpace\\": 21308227584,\\n \\"RemoteSync\\": false,\\n \\"RemoteSyncDownload\\": false,\\n \\"RoClientList\\": \\"1.1.1.1\\",\\n \\"RoUserList\\": \\"user1\\",\\n \\"RwClientList\\": \\"1.1.1.1\\",\\n \\"RwUserList\\": \\"user2\\",\\n \\"ServerSideAlgorithm\\": \\"AES256\\",\\n \\"ServerSideCmk\\": \\"xxx\\",\\n \\"ServerSideEncryption\\": false,\\n \\"Size\\": 85899345920,\\n \\"Squash\\": \\"root_squash\\",\\n \\"State\\": \\"clean\\",\\n \\"Status\\": \\"started\\",\\n \\"SupportArchive\\": false,\\n \\"SyncProgress\\": -2,\\n \\"Throttling\\": false,\\n \\"TotalDownload\\": 0,\\n \\"TotalUpload\\": 0,\\n \\"TransferAcceleration\\": false,\\n \\"UploadQueue\\": 5,\\n \\"Used\\": 0,\\n \\"WindowsAcl\\": false,\\n \\"OssBucketRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9A3C3C32-3F37-4658-9D38-945D0799CA0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayFileSharesResponse>\\n <Message>successful</Message>\\n <RequestId>9A3C3C32-3F37-4658-9D38-945D0799CA0E</RequestId>\\n <FileShares>\\n <ClientSideCmk>xxx</ClientSideCmk>\\n <PartialSyncPaths>xxx</PartialSyncPaths>\\n <PathPrefix>testprefix</PathPrefix>\\n <BucketsStub>false</BucketsStub>\\n <UploadQueue>5</UploadQueue>\\n <DiskId>d-bp1cvy8o2569jij31***</DiskId>\\n <OssUsed>0</OssUsed>\\n <DownloadQueue>5</DownloadQueue>\\n <ActiveMessages>0</ActiveMessages>\\n <IndexId>NFSale***</IndexId>\\n <MnsHealth>MNSNotEnabled</MnsHealth>\\n <AccessBasedEnumeration>false</AccessBasedEnumeration>\\n <DownloadRate>0</DownloadRate>\\n <FeLimit>0</FeLimit>\\n <SupportArchive>false</SupportArchive>\\n <OssEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</OssEndpoint>\\n <OssHealth>BucketHealthy</OssHealth>\\n <OutRate>0</OutRate>\\n <ServerSideCmk>xxx</ServerSideCmk>\\n <RwClientList>1.1.1.1</RwClientList>\\n <State>clean</State>\\n <Protocol>SMB</Protocol>\\n <OssBucketSsl>false</OssBucketSsl>\\n <DownloadLimit>0</DownloadLimit>\\n <InPlace>false</InPlace>\\n <RemoteSync>false</RemoteSync>\\n <FileNumLimit>10200202</FileNumLimit>\\n <Squash>root_squash</Squash>\\n <RemainingMetaSpace>21308227584</RemainingMetaSpace>\\n <TransferAcceleration>false</TransferAcceleration>\\n <Size>85899345920</Size>\\n <ServerSideEncryption>false</ServerSideEncryption>\\n <WindowsAcl>false</WindowsAcl>\\n <RemoteSyncDownload>false</RemoteSyncDownload>\\n <ClientSideEncryption>false</ClientSideEncryption>\\n <BucketInfos>[{\\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"bucket1\\\\\\",\\\\\\"PathPrefix\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"bucket2\\\\\\",\\\\\\"PathPrefix\\\\\\":\\\\\\"\\\\\\"}]</BucketInfos>\\n <NfsV4Optimization>false</NfsV4Optimization>\\n <TotalUpload>0</TotalUpload>\\n <DiskType>cloud_efficiency</DiskType>\\n <Used>0</Used>\\n <IgnoreDelete>false</IgnoreDelete>\\n <RoUserList>user1</RoUserList>\\n <FsSizeLimit>70368744177664</FsSizeLimit>\\n <TotalDownload>0</TotalDownload>\\n <Enabled>true</Enabled>\\n <HighWatermark>80</HighWatermark>\\n <KmsRotatePeriod>0</KmsRotatePeriod>\\n <Address>172.16.0.44</Address>\\n <PollingInterval>900</PollingInterval>\\n <Name>alex***</Name>\\n <OssBucketName>bucketA</OssBucketName>\\n <ExpressSyncId>sync-0001xv7je357xn8tr***</ExpressSyncId>\\n <LagPeriod>5</LagPeriod>\\n <DirectIO>false</DirectIO>\\n <CacheMode>Cache</CacheMode>\\n <InRate>0</InRate>\\n <LowWatermark>60</LowWatermark>\\n <SyncProgress>-2</SyncProgress>\\n <ServerSideAlgorithm>AES256</ServerSideAlgorithm>\\n <ObsoleteBuckets>bucket1</ObsoleteBuckets>\\n <BeLimit>0</BeLimit>\\n <LocalPath>/dev/vdb</LocalPath>\\n <RoClientList>1.1.1.1</RoClientList>\\n <RwUserList>user2</RwUserList>\\n <FastReclaim>false</FastReclaim>\\n <Browsable>true</Browsable>\\n <Throttling>false</Throttling>\\n <BypassCacheRead>false</BypassCacheRead>\\n <NoPartition>true</NoPartition>\\n <Status>started</Status>\\n <BindIPAddr>192.0.0.0</BindIPAddr>\\n </FileShares>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayFileSharesResponse>","errorExample":""}]', + 'title' => '获取文件网关上共享的配置信息', + ], + 'UpdateGatewayFileShare' => [ + 'summary' => '在文件网关下更新文件共享配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000c6hshwukkbryp****', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享ID。可以通过DescribeGatewayFileShares接口获得。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFStest', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享名称。可以通过DescribeGatewayFileShares接口获得。不支持修改。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'RemoteSync', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否打开反向同步。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RemoteSyncDownload', + 'in' => 'query', + 'schema' => [ + 'description' => '复制模式情况下，是否下载文件数据。网关版本1.2.0及以上支持此参数。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'>只有当该共享打开了反向同步或者加入极速同步组时候，这个参数才生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PollingInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享反向同步时间间隔。单位秒，在启用反向同步情况下必传。取值范围为15~36000。'."\n" + ."\n" + .'> 在复制模式和反向同步启用下载文件数据时，取值范围为3600~36000。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '36000', + ], + ], + [ + 'name' => 'IgnoreDelete', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否忽略删除。启用后网关侧删除文件不会删除云上(OSS)对应文件。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'>网关版本1.0.40及以上支持此参数。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FrontendLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享最大写入速度，单位为MB/s。取值范围为0~1280，0为默认值，表示无限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BackendLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享最大上传速度，单位为MB/s。0代表无限制。取值范围为0~1280，0为默认值，表示无限制。'."\n" + ."\n" + .'>如果同时已限制最大写入速度，最大上传速度不能小于最大写入速度。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'DownloadLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享最大下载速度，单位为MB/s。取值范围为0~12800，0表示无限制，只在复制模式且开启下载文件数据时才可设置。网关版本1.3.0及以上支持此参数。'."\n" + .'> 只有当该共享打开了反向同步或者加入极速同步组时，此参数才生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'InPlace', + 'in' => 'query', + 'schema' => [ + 'description' => '已废弃，不建议设置。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CacheMode', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享缓存模式。可以通过DescribeGatewayFileShares接口获得。不支持修改。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cache', + ], + ], + [ + 'name' => 'Browsable', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下是否可浏览（即网络邻居中是否可发现）。取值范围如下：'."\n" + ."\n" + .'- true（默认）：是。'."\n" + ."\n" + .'- false：否。'."\n" + ."\n" + .'> '."\n" + .'> - 该参数在NFS协议下无效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Squash', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下用户映射，默认值为none。取值范围如下：'."\n" + ."\n" + .'- none。'."\n" + ."\n" + .'- root_squash。'."\n" + ."\n" + .'- all_squash。'."\n" + ."\n" + .'- all_anonymous。', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + [ + 'name' => 'ReadWriteUserList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下读写用户列表。多个用户使用“,”分隔。'."\n" + .'>'."\n" + .' >- 该参数在NFS协议下无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1,user2', + ], + ], + [ + 'name' => 'ReadOnlyUserList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下只读用户列表。多个用户使用“,”分隔。'."\n" + .'> '."\n" + .'> - 该参数在NFS协议下无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1,user2', + ], + ], + [ + 'name' => 'ReadWriteClientList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下读写客户端列表（可以是IP地址或者IP地址范围)。多个客户端使用“,”分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.146.100', + ], + ], + [ + 'name' => 'ReadOnlyClientList', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下只读客户端列表（可以是IP地址或者IP地址范围）。多个客户端使用“,”分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.146.100', + ], + ], + [ + 'name' => 'LagPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '同步延迟，即网关本地缓存同步到云上OSS的延迟时间。单位为秒。取值范围为5~120，5为默认值。'."\n" + ."\n" + .'>'."\n" + .'>- 网关版本1.0.40及以上支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'DirectIO', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否启用DirectIO（直接I/O方式进行数据传输）。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServerSideEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServerSideCmk', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***', + ], + ], + [ + 'name' => 'ClientSideEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientSideCmk', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***', + ], + ], + [ + 'name' => 'KmsRotatePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FastReclaim', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否开启上传优化，适合数据纯备份上云场景。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'>网关版本1.0.39及以上支持此参数。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'WindowsAcl', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下，是否开启通过Windows访问列表（需要AD域）进行权限控制。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'>网关版本1.0.45及以上支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AccessBasedEnumeration', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享SMB协议下，是否启用Windows ABE。需要windowsAcl参数设置为true情况下生效。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'>'."\n" + .'>- 网关版本1.0.45及以上支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NfsV4Optimization', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享NFS协议下，是否启用NFS v4优化，提升挂载上传效率。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'>'."\n" + .'> - 开启后将不支持NFS v3形式挂载，网关版本1.2.0及以上支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TransferAcceleration', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否开启传输加速功能，需要对应OSS Bucket已开启传输加速。'."\n" + ."\n" + .'>'."\n" + .'>- 网关版本1.3.0及以上支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BypassCacheRead', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享是否启用直读OSS功能，不通过网关缓存直接读OSS数据。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'>'."\n" + .'>- 不建议开启此功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServerSideAlgorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'AES256', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000avsri6tlyddgf****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EBAF769F-2E88-4D81-AF1E-A34FAACF9***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.FileShare.%s', + 'errorMessage' => 'The specified field %s for file share is invalid. Please check it again.', + ], + [ + 'errorCode' => 'VersionNotSupported.FileShare.%s', + 'errorMessage' => 'The specified field %s for file share is not supported by current gateway version. Please check it again.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000avsri6tlyddgf****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateGatewayFileShareResponse>\\n <TaskId>t-000avsri6tlyddgf****</TaskId>\\n <Message>successful</Message>\\n <RequestId>EBAF769F-2E88-4D81-AF1E-A34FAACF9***</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateGatewayFileShareResponse>","errorExample":""}]', + 'title' => '更新文件共享配置', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'- 您已经创建部署完成文件网关，并已经完成一个文件共享的配置。'."\n" + ."\n" + .'- 该更新接口会更新文件共享对应的所有暴露参数，如果您不想更新某个参数，请调用时务必传入该参数原值，否则该文件共享参数会被设置成默认值。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteGatewayFileShares' => [ + 'summary' => '删除指定文件网关中的指定文件共享。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbv****', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享在网关内部的ID。可以通过DescribeGatewayFileShares接口获得。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFSalex***', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除。可能值：'."\n" + ."\n" + .'- true：强制删除同步未完成的文件共享，请谨慎操作。'."\n" + ."\n" + .'- false（默认）：不删除同步未完成的文件共享。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000c6hshwukkcfn****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 't-000czaedx5koz578vk**', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyShareIndexId', + 'errorMessage' => 'You must enter a valid file sharing ID.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"t-000czaedx5koz578vk**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayFileSharesResponse>\\n <TaskId>t-000c6hshwukkcfn****</TaskId>\\n <Message>successful</Message>\\n <RequestId>D3205DCC-D32B-497D-BB49-E212C608AD**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayFileSharesResponse>","errorExample":""}]', + 'title' => '删除文件共享', + 'description' => '### 接口说明'."\n" + .'><warning>'."\n" + ."\n" + .'- 删除共享会导致您的业务和数据同步中断，请谨慎操作。'."\n" + .'- 当删除NFS共享时，建议您先在客户端执行卸载操作。若客户端未先执行卸载操作，而直接删除共享或网关，会导致挂载点无法正常卸载。此后对挂载目录的任何操作均会出现卡住或长时间无响应的情况。'."\n" + .'- 删除共享并不会终止网关计费，如果您无需使用网关，可以通过调用[DeleteGateway](https://help.aliyun.com/zh/csg/developer-reference/api-sgw-2018-05-11-deletegateway?spm=a2c4g.11186623.help-menu-53923.d_5_1_3_1_3.15947491Vl7Ja9&scm=20140722.H_2874297._.OR_help-T_cn~zh-V_1)接口删除网关以避免持续产生费用。'."\n" + .'></warning></props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayNFSClients' => [ + 'summary' => '查询文件网关中NFS挂载客户端列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000gchoknplv4f27****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '网关列表信息的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页显示时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Version40Enabled' => [ + 'description' => '判断网关是否支持NFS v4.0挂载，返回值如下：'."\n" + .'- true：支持NFS v4.0挂载。'."\n" + .'- false：不支持NFS v4.0挂载。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Version41Enabled' => [ + 'description' => '判断网关是否支持NFS v4.1挂载，返回值如下：'."\n" + .'- true：支持NFS v4.1挂载。'."\n" + .'- false：不支持NFS v4.1挂载。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TotalCount' => [ + 'description' => '客户端总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F694EBF3-59AB-1DDD-B5B4-87CB7D6A****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '网关列表每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '网关列表信息的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Version3Enabled' => [ + 'description' => '判断网关是否支持NFS v3挂载，返回值如下：'."\n" + .'- true：支持NFS v3挂载。'."\n" + .'- false：不支持NFS v3挂载。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClientInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClientInfo' => [ + 'description' => '客户端信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HasNFSv40' => [ + 'description' => '判断客户端是否使用NFS v4.0挂载，返回值如下：'."\n" + .'- true：客户端使用的是NFS v4.0挂载。'."\n" + .'- false：客户端使用的不是NFS v4.0挂载。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HasNFSv41' => [ + 'description' => '判断客户端是否使用NFS v4.1挂载，返回值如下：'."\n" + .'- true：客户端使用的是NFS v4.1挂载。'."\n" + .'- false：客户端使用的不是NFS v4.1挂载。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HasNFSv3' => [ + 'description' => '判断客户端是否使用NFS v3挂载，返回值如下：'."\n" + .'- true：客户端使用的是NFS v3挂载。'."\n" + .'- false：客户端使用的不是NFS v3挂载。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClientIpAddr' => [ + 'description' => 'NFS客户端IP地址。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果，返回值如下：'."\n" + ."\n" + .'- true：请求成功。 '."\n" + .' '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadPageSize', + 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'BadPageNumber', + 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Version40Enabled\\": true,\\n \\"Version41Enabled\\": false,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"F694EBF3-59AB-1DDD-B5B4-87CB7D6A****\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Version3Enabled\\": true,\\n \\"ClientInfoList\\": {\\n \\"ClientInfo\\": [\\n {\\n \\"HasNFSv40\\": true,\\n \\"HasNFSv41\\": false,\\n \\"HasNFSv3\\": true,\\n \\"ClientIpAddr\\": \\"172.16.XX.XX\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询NFS挂载客户端列表', + ], + 'ModifyGatewayFileShareWatermark' => [ + 'summary' => '调整网关文件共享淘汰水位。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031****', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享ID。可以通过DescribeGatewayFileShares接口获得。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFSalex****', + ], + ], + [ + 'name' => 'Watermark', + 'in' => 'query', + 'schema' => [ + 'description' => '淘汰水位。取值范围如下：'."\n" + .'- 最小值：40。'."\n" + .'- 最大值：90。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '90', + 'minimum' => '40', + 'example' => '40'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xr6q****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + ."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CacheNotExist', + 'errorMessage' => 'The specified cache disk does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6q****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '调整网关文件共享淘汰水位', + ], + 'ExpandGatewayFileShare' => [ + 'summary' => '线下网关扩容文件共享。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '22312', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '仅线下网关(用户idc环境)支持该操作', + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。'."\n" + .'> '."\n" + .'> - 必须指定该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-000eg44nmxbsfwbv****', + ], + ], + [ + 'name' => 'IndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享ID。可以通过DescribeGatewayFileShares接口获得。'."\n" + .'> '."\n" + .'> - 必须指定该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMBpapcn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8****', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + ."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果描述', + 'type' => 'string', + 'example' => 'successful', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xv4s***', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4s***\\"\\n}","type":"json"}]', + 'title' => '线下网关扩容文件共享', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'请先在安装线下网关的虚拟化环境中，对需要扩容的文件共享对应的缓存盘进行扩容操作。', + ], + 'CreateGatewaySMBUser' => [ + 'summary' => '在文件网关添加一个SMB用户。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq2**', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => 'SMB用户名。长度限制1~32个字符，可以是英文、数字或符号中划线（-），下划线（_）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'SMB密码。密码不能为空，可以是英文、数字或符号："!","@","#","$","%","^","&","*"。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000c6hshwukkbtxrb***', + ], + 'Message' => [ + 'description' => '请求结果描述。'."\n", + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9083F167-95B1-4B40-B2CD-70DE068EC3**', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSMBUserName', + 'errorMessage' => 'You must enter a valid SMB username.', + ], + [ + 'errorCode' => 'EmptySMBPassword', + 'errorMessage' => 'You must enter a valid SMB password.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'EmptySMBUserName', + 'errorMessage' => 'You must enter a valid SMB username.', + ], + [ + 'errorCode' => 'InvalidSMBPassword', + 'errorMessage' => 'The specified SMB password is invalid. You must enter a valid password.', + ], + [ + 'errorCode' => 'CouldNotCreateSMBUser', + 'errorMessage' => 'The gateway has linked an AD or LDAP service. You cannot create an SMB user on the gateway. We recommend that you create an SMB user in the AD or LDAP service.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StorageBundleNotExist', + 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkbtxrb***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9083F167-95B1-4B40-B2CD-70DE068EC3**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewaySMBUserResponse>\\n <TaskId>t-000c6hshwukkbtxrb***</TaskId>\\n <Message>successful</Message>\\n <RequestId>9083F167-95B1-4B40-B2CD-70DE068EC3**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewaySMBUserResponse>","errorExample":""}]', + 'title' => '添加SMB用户', + 'description' => '使用该接口时，需要注意如下事项：'."\n" + .'- 如果您的云存储网关链接AD服务器，该接口会失败，在这种情况下，您可以在AD服务器上创建SMB用户。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteGatewaySMBUser' => [ + 'summary' => '删除文件网关中指定的SMB用户。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000c6hshwukkbrypj***', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => 'SMB用户名。长度限制为1~32个字符，可以是英文、数字或符号短划线（-）、下划线（_）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'username', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000c6hshwukkcfn3k**', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptySMBUserName', + 'errorMessage' => 'You must enter a valid SMB username.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInUpgrading', + 'errorMessage' => 'The gateway is upgrading. Try again later.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'GatewayStatusRunningRequired', + 'errorMessage' => 'The gateway is not in the Running state. Try again later.', + ], + [ + 'errorCode' => 'InvalidSMBUserName', + 'errorMessage' => 'You must enter a valid SMB username.', + ], + [ + 'errorCode' => 'CouldNotDeleteSMBUser', + 'errorMessage' => 'The gateway is already linked with an AD or LDAP service. You cannot delete an SMB user on the gateway. We recommend that you delete an SMB user in the AD or LDAP service.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn3k**\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewaySMBUserResponse>\\n <TaskId>t-000c6hshwukkcfn3k**</TaskId>\\n <Message>successful</Message>\\n <RequestId>89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewaySMBUserResponse>","errorExample":""}]', + 'title' => '删除SMB用户', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'- 请确认您已经创建了一个云存储网关，如果还未创建，可以通过CreateGateway接口创建一个云存储网关。'."\n" + .' '."\n" + .'- 如果您的云存储网关链接AD服务器，该接口将会失败，在这种情况下，您可以在AD服务器上删除SMB用户。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewaySMBUsers' => [ + 'summary' => '获取文件网关上SMB用户名列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbv***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的页码。'."\n" + ."\n" + .'- 起始值：1。'."\n" + ."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。'."\n" + ."\n" + .'- 最大值：50。'."\n" + ."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回SMB用户名的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C02F482-FC2E-45BF-88C5-8D40134D11**', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '分页显示时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Users' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'User' => [ + 'description' => 'SMB用户名列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Username' => [ + 'description' => 'SMB用户名。', + 'type' => 'string', + 'example' => 'alex***', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ActiveDirectory' => [ + 'description' => '网关是否加入Windows活动目录（AD）。'."\n" + ."\n" + .'- false（默认）：未加入。'."\n" + ."\n" + .'- true：加入。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadPageSize', + 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', + ], + [ + 'errorCode' => 'BadPageNumber', + 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"4C02F482-FC2E-45BF-88C5-8D40134D11**\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"Username\\": \\"alex***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"ActiveDirectory\\": false\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewaySMBUsersResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>4C02F482-FC2E-45BF-88C5-8D40134D11**</RequestId>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Users>\\n <Username>alex***</Username>\\n </Users>\\n <Code>200</Code>\\n <Success>true</Success>\\n <ActiveDirectory>false</ActiveDirectory>\\n</DescribeGatewaySMBUsersResponse>","errorExample":""}]', + 'title' => '获取SMB用户名列表', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'- 如果您的云存储网关上已经添加了AD服务器，该接口会返回对应服务器上的SMB用户列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetGatewayDNS' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000c6hshwukkbryp****', + ], + ], + [ + 'name' => 'DnsServer', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNS服务器的IP列表。如果有多个DNS服务IP，请用逗号分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100.100.XX.XX,100.100.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000czaedx5koz578****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDNS', + 'errorMessage' => 'The specified parameter includes one or more invalid IP addresses. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000czaedx5koz578****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetGatewayDNSResponse>\\n <TaskId>t-000czaedx5koz578****</TaskId>\\n <RequestId>C5A78764-05A4-4E57-87E6-70C6657698**</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetGatewayDNSResponse>","errorExample":""}]', + 'title' => '添加DNS服务器信息', + 'summary' => '向文件网关添加NDS服务器信息。', + 'description' => '调用该接口时，您需要注意：'."\n" + .'- 如果云储存网关原来配置有DNS服务器信息，那么该信息会被传入的DNS服务器信息覆盖。'."\n" + ."\n" + .'- 请确认您传入的DNS服务器信息有效。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayDNS' => [ + 'summary' => '调用DescribeGatewayDNS获取网关上配置的DNS服务器信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwYT4X0O', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'DnsServer' => [ + 'description' => 'DNS服务IP列表。IP之间用逗号分隔。', + 'type' => 'string', + 'example' => '100.100.2.136,100.100.2.188', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GatewayInUpgrading', + 'errorMessage' => 'The gateway is upgrading. Try again later.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'GatewayStatusRunningRequired', + 'errorMessage' => 'The gateway is not in the Running state. Try again later.', + ], + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"DnsServer\\": \\"100.100.2.136,100.100.2.188\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayDNSResponse>\\n <RequestId>ACB4BBBB-9046-4D46-BA93-0737DE78B735</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <DnsServer>100.100.2.136,100.100.2.188</DnsServer>\\n</DescribeGatewayDNSResponse>","errorExample":""}]', + 'title' => '获取网关上配置的DNS服务器信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetGatewayADInfo' => [ + 'summary' => '为网关设置或清除AD服务器信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwYT4X0O', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbv****', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '连接AD服务器的用户名。可能值：'."\n" + ."\n" + .'- enabled为false，请忽略该字段。'."\n" + ."\n" + .'- enabled为true，该字段必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'ale****', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '连接AD服务器的密码。可能值：'."\n" + ."\n" + .'- enabled为false，请忽略该字段。'."\n" + ."\n" + .'- enabled为true，该字段必传。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12****', + ], + ], + [ + 'name' => 'ServerIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'AD服务器的IP。可能值：'."\n" + .'- enabled为false，请忽略该字段。'."\n" + ."\n" + .'- enabled为true，该字段必传，并输入有效的IP，只能由数字和半角句号（.）组成。', + 'type' => 'string', + 'required' => false, + 'example' => '12.12.x.x', + ], + ], + [ + 'name' => 'IsEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '设置AD服务器的开关。可能值：'."\n" + ."\n" + .'- true：设置AD服务器信息。'."\n" + ."\n" + .'- false（默认）：清理AD服务器信息。'."\n" + ."\n" + .' ><notice>'."\n" + ."\n" + .'- 需要开启AD时，所有参数都必填。'."\n" + .'- 需要关闭AD时，只需要指定IsEnabled为false即可。'."\n" + ."\n" + .'></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000c6hshwukkcfn****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyADUserName', + 'errorMessage' => 'You must enter a valid username.', + ], + [ + 'errorCode' => 'EmptyADPassword', + 'errorMessage' => 'You must enter a valid password.', + ], + [ + 'errorCode' => 'InvalidADServerIp', + 'errorMessage' => 'The specified IP address for the server is invalid. You must enter a valid IP address.', + ], + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetGatewayADInfoResponse>\\n <TaskId>t-000c6hshwukkcfn****</TaskId>\\n <Message>successful</Message>\\n <RequestId>0F069495-0184-41B9-9D1E-6E4E921D2**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetGatewayADInfoResponse>","errorExample":""}]', + 'title' => '添加或清除AD服务器信息', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'- 如果您要添加一个AD服务器，请确保该AD服务信息有效，并可以被网关的DNS解析访问，您可以通过SetGateWayDNS接口设置云存储网关的DNS。'."\n" + ."\n" + .'- 如果您要添加一个AD服务器信息，且已经存在一个AD服务器信息，那么原来的AD服务器信息会被新的AD服务器信息覆盖。'."\n" + ."\n" + .'- 如果您要清除AD服务器信息，请把enabled参数设置为false。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayADInfo' => [ + 'summary' => '获取网关上配置的AD服务器信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwYT4X0O', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB2D3121-8271-5DD7-9957-D52433FF****', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'DomainName' => [ + 'description' => ' 连接AD服务器的域名。', + 'type' => 'string', + 'example' => 'ad.aliyundoc.com', + ], + 'IsEnabled' => [ + 'description' => 'AD服务器是否生效。可能值：'."\n" + ."\n" + .'- true：AD服务器生效。'."\n" + ."\n" + .'- false：AD服务器没有生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Username' => [ + 'description' => '域管理员用户。', + 'type' => 'string', + 'example' => ' administrator', + ], + 'ServerIp' => [ + 'description' => 'AD服务器的IP。', + 'type' => 'string', + 'example' => '47.101.**.***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用结果，返回值如下：'."\n" + .'- true：请求成功。 '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInUpgrading', + 'errorMessage' => 'The gateway is upgrading. Try again later.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'GatewayStatusRunningRequired', + 'errorMessage' => 'The gateway is not in the Running state. Try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2D3121-8271-5DD7-9957-D52433FF****\\",\\n \\"Message\\": \\"successful\\",\\n \\"DomainName\\": \\"ad.aliyundoc.com\\",\\n \\"IsEnabled\\": true,\\n \\"Username\\": \\" administrator\\",\\n \\"ServerIp\\": \\"47.101.**.***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取网关上配置的AD服务器信息', + ], + 'CreateGatewayCacheDisk' => [ + 'summary' => '在网关下创建一个缓存盘。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '17168', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwLTSLKH', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'CacheDiskCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存盘的类型。仅支持ESSD云盘，取值为cloud_essd。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + ], + [ + 'name' => 'CacheDiskSizeInGB', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存盘的容量大小。单位：GB。缓存盘容量要求：'."\n" + .'- 基础型网关缓存盘容量区间为40 GB~4096 GB。'."\n" + .'- 标准型网关缓存盘容量区间为40 GB~8192 GB。'."\n" + .'- 增强型和性能型网关缓存盘容量区间为40 GB~32768 GB。'."\n" + .'- 当CacheDiskCategory取值为cloud_essd且PerformanceLevel取值为PL2时，缓存盘容量下限为461 GB。'."\n" + .'- 当CacheDiskCategory取值为cloud_essd且PerformanceLevel取值为PL3时，缓存盘容量下限为1261 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'PerformanceLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'ESSD云盘性能等级。当CacheDiskCategory取值为cloud_essd时需要传入此参数。取值范围：'."\n" + .'- PL1'."\n" + .'- PL2'."\n" + .'- PL3', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BuyURL' => [ + 'description' => '预付费情况下, 售卖链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***","directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}®ionId=cn-hangzhou#/buy', + ], + 'TaskId' => [ + 'description' => '按量付费情况下，创建缓存盘的任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xv4st***', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8E69E1A1-9076-4C8C-8ADF-ACD253886E22', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LocationCloudRequired', + 'errorMessage' => 'You must specify a cloud gateway. Try again later.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'GatewayOperationNotAllowed', + 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', + ], + [ + 'errorCode' => 'InvalidCacheDiskCategory', + 'errorMessage' => 'The category that you specified for the cache disk is invalid. You must specify a valid category.', + ], + [ + 'errorCode' => 'CacheSizeLimitForBasic', + 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Basic gateway is 4 TB.', + ], + [ + 'errorCode' => 'CacheSizeLimitForStandard', + 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Standard gateway is 8 TB.', + ], + [ + 'errorCode' => 'CacheSizeLimit', + 'errorMessage' => 'The maximum size of cache disks for the gateway is 32 TB.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***\\\\\\",\\\\\\"directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}®ionId=cn-hangzhou#/buy\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4st***\\",\\n \\"RequestId\\": \\"8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayCacheDiskResponse>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\"gateway_id\\":\\"gw-0007va9bnidei3s8a***\\",\\"directBuy\\":\\"false\\",\\"gateway_class\\":\\"standard\\",\\"cache_cloud_efficiency_size\\":0}&regionId=cn-hangzhou#/buy</BuyURL>\\n <TaskId>t-0001xv7je357xv4st***</TaskId>\\n <RequestId>8E69E1A1-9076-4C8C-8ADF-ACD253886E22</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayCacheDiskResponse>","errorExample":""}]', + 'title' => '创建缓存盘', + 'description' => '### 接口说明'."\n" + .'使用该接口时，需要注意如下事项：'."\n" + .'- 仅对线上网关有效'."\n" + .'- 如果网关是预付费，该接口会返回一个buyURL， 需要完成支付后，缓存盘会被自动创建完成。'."\n" + .'- 如果网关是后付费，该接口会返回对应创建缓存盘的任务ID。', + ], + 'DescribeGatewayCaches' => [ + 'summary' => '查询缓存盘信息，包括缓存盘大小、类型等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwLTSLKH', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '40797B4D-09D9-482E-B163-CCB568BADE35', + ], + 'Caches' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Cache' => [ + 'description' => '缓存盘信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceLevel' => [ + 'description' => 'ESSD云盘性能等级。可能值：'."\n" + .'- PL1'."\n" + .'- PL2'."\n" + .'- PL3', + 'type' => 'string', + 'example' => 'PL1', + ], + 'SizeInGB' => [ + 'description' => '缓存盘大小。单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'BuyURL' => [ + 'description' => '缓存盘购买链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy', + ], + 'Iops' => [ + 'description' => '缓存盘IOPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2605', + ], + 'CacheId' => [ + 'description' => '缓存盘ID。', + 'type' => 'string', + 'example' => 'd-bp1dcnq8zldree6ok***', + ], + 'CacheType' => [ + 'description' => '缓存盘类型。可能值：'."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD云盘。'."\n" + .'- cloud_essd：ESSD云盘。', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'IsUsed' => [ + 'description' => '是否被使用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExpiredTime' => [ + 'description' => '到期时间戳，单位为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1532510649', + ], + 'LocalFilePath' => [ + 'description' => '缓存盘内部设备名。', + 'type' => 'string', + 'example' => '/dev/vdb', + ], + 'IsNoPartition' => [ + 'description' => '是否有分区。true表示没有。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SubscriptionInstanceId' => [ + 'description' => '付费实例ID。', + 'type' => 'string', + 'example' => 'ca-000bq2fkzol56575***', + ], + 'ExpireStatus' => [ + 'description' => '是否过期状态。可能值：'."\n" + .'- 0：正常。'."\n" + .'- 1：将要过期。'."\n" + .'- 2：已经过期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RenewURL' => [ + 'description' => '续费链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew', + ], + 'IsDirectExpand' => [ + 'description' => '是否支持在线扩容。true表示支持。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInUpgrading', + 'errorMessage' => 'The gateway is upgrading. Try again later.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"40797B4D-09D9-482E-B163-CCB568BADE35\\",\\n \\"Caches\\": {\\n \\"Cache\\": [\\n {\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"SizeInGB\\": 100,\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy\\",\\n \\"Iops\\": 2605,\\n \\"CacheId\\": \\"d-bp1dcnq8zldree6ok***\\",\\n \\"CacheType\\": \\"cloud_efficiency\\",\\n \\"IsUsed\\": false,\\n \\"ExpiredTime\\": 1532510649,\\n \\"LocalFilePath\\": \\"/dev/vdb\\",\\n \\"IsNoPartition\\": true,\\n \\"SubscriptionInstanceId\\": \\"ca-000bq2fkzol56575***\\",\\n \\"ExpireStatus\\": 0,\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew\\",\\n \\"IsDirectExpand\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayCachesResponse>\\n <Message>successful</Message>\\n <RequestId>40797B4D-09D9-482E-B163-CCB568BADE35</RequestId>\\n <Caches>\\n <PerformanceLevel>PL1</PerformanceLevel>\\n <SizeInGB>100</SizeInGB>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy</BuyURL>\\n <Iops>2605</Iops>\\n <CacheId>d-bp1dcnq8zldree6ok***</CacheId>\\n <CacheType>cloud_efficiency</CacheType>\\n <IsUsed>false</IsUsed>\\n <ExpiredTime>1532510649</ExpiredTime>\\n <LocalFilePath>/dev/vdb</LocalFilePath>\\n <IsNoPartition>true</IsNoPartition>\\n <SubscriptionInstanceId>ca-000bq2fkzol56575***</SubscriptionInstanceId>\\n <ExpireStatus>0</ExpireStatus>\\n <RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew</RenewURL>\\n <IsDirectExpand>true</IsDirectExpand>\\n </Caches>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayCachesResponse>","errorExample":""}]', + 'title' => '查询缓存盘', + 'description' => '### 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'<props="china">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和[价格](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5&aly_as=C81M1m5N#/hcs_sgw/detail)。</props>'."\n" + .'<props="intl">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和价格。</props>'."\n" + ."\n" + .'- 如果您的网关需要续费，可通过接口返回的续费链接进行续费。', + ], + 'ExpandCacheDisk' => [ + 'summary' => '扩容云上网关缓存盘。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '17242', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwLTSLKH', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'NewSizeInGB', + 'in' => 'query', + 'schema' => [ + 'description' => '扩容后的缓存容量。单位为GB。扩容要求如下：'."\n" + ."\n" + .'- 扩容后的缓存盘容量不能比原先缓存盘的容量小，即不支持缩减缓存盘。'."\n" + ."\n" + .'- 基础型网关扩容缓存盘上限为4 TB，标准型网关扩容缓存盘上限为8 TB，增强型和性能型网关扩容缓存盘上限为32 TB。'."\n" + ."\n" + .'- 文件网关缓存盘扩容下限为40 GB，块网关缓存盘扩容下限为20 GB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '101', + ], + ], + [ + 'name' => 'LocalFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存盘内部设备名。您可以通过DescribeGatewayCaches接口获得缓存盘内部设备名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/dev/vdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BuyURL' => [ + 'description' => '缓存盘为预付费情况下的购买支付链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}®ionId=cn-hangzhou#/buy', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000eg44nmxbsh3qk3***', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8B59F29-453D-49BF-8673-EEB8F9F2D5C6', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。可取值如下：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayOperationNotAllowed', + 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'CacheNotExist', + 'errorMessage' => 'The specified cache disk does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'EmptyLocalFilePath', + 'errorMessage' => 'You must enter an local file path for the cache disk.', + ], + [ + 'errorCode' => 'InvalidNewSizeInGB', + 'errorMessage' => 'The scale-up size that you specified for the cache disk is invalid. You must specify a valid size.', + ], + [ + 'errorCode' => 'CacheSizeLimit', + 'errorMessage' => 'The maximum size of cache disks for the gateway is 32 TB.', + ], + [ + 'errorCode' => 'CacheSizeLimitForBasic', + 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Basic gateway is 4 TB.', + ], + [ + 'errorCode' => 'CacheSizeLimitForStandard', + 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Standard gateway is 8 TB.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***”,”directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}®ionId=cn-hangzhou#/buy\\",\\n \\"TaskId\\": \\"t-000eg44nmxbsh3qk3***\\",\\n \\"RequestId\\": \\"F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ExpandCacheDiskResponse>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\"gateway_id\\":\\"gw-0007va9bnidei3s8a***”,”directBuy\\":\\"false\\",\\"gateway_class\\":\\"standard\\",\\"cache_cloud_efficiency_size\\":0}&regionId=cn-hangzhou#/buy</BuyURL>\\n <TaskId>t-000eg44nmxbsh3qk3***</TaskId>\\n <RequestId>F8B59F29-453D-49BF-8673-EEB8F9F2D5C6</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ExpandCacheDiskResponse>","errorExample":""}]', + 'title' => '扩容缓存盘', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .' <props="china"> 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和[价格](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5&aly_as=C81M1m5N#/hcs_sgw/detail)。</props>'."\n" + .'<props="intl"> 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和价格。</props>'."\n" + ."\n" + .'- 请确认您已创建缓存盘，并通过接口返回的购买链接进行购买，完成缓存盘的扩容。'."\n" + ."\n" + .' - 基础型网关扩容缓存盘上限为4 TB，标准型网关扩容缓存盘上限为8 TB，增强型和性能型网关扩容缓存盘上限为32 TB。'."\n" + ."\n" + .' - 云存储网关支持扩容缓存盘，但不支持缩减缓存盘。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteGatewayCacheDisk' => [ + 'summary' => '在文件网关下删除缓存盘。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwLTSLKH', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031y***', + ], + ], + [ + 'name' => 'CacheId', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存盘ID。可以通过DescribeGatewayCaches接口获得。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd-bp1dcnq8zldree6ok***', + ], + ], + [ + 'name' => 'LocalFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存盘内部设备名。 可以通过DescribeGatewayCaches接口获得。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/dev/vdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xv4s***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEFC9927-B097-446D-8FDA-F848C8B2C9E3', + ], + 'Code' => [ + 'description' => ' 状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LocationCloudRequired', + 'errorMessage' => 'You must specify a cloud gateway. Try again later.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + [ + 'errorCode' => 'GatewayOperationNotAllowed', + 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', + ], + [ + 'errorCode' => 'CacheInUse', + 'errorMessage' => 'The cache disk is in use.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xv4s***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEFC9927-B097-446D-8FDA-F848C8B2C9E3\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayCacheDiskResponse>\\n <Message>successful</Message>\\n <RequestId>EEFC9927-B097-446D-8FDA-F848C8B2C9E3</RequestId>\\n <TaskId>t-0001xv7je357xv4s***</TaskId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayCacheDiskResponse>","errorExample":""}]', + 'title' => '删除缓存盘', + 'description' => '使用该接口时，需要注意如下事项：'."\n" + ."\n" + .'- 仅对线上网关有效。'."\n" + ."\n" + .'- 仅支持删除按量付费的缓存盘。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => '为指定的网关创建并绑定标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw7Q12RI', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，可以通过接口DescribeRegions查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型定义。唯一取值：GATEWAY。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GATEWAY', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。可以同时创建N个标签键，N的取值范围为1~20。不允许传入空字符串。', + 'type' => 'string', + 'required' => true, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。可以同时创建N个标签值，N的取值范围为1~20。允许传入空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '网关ID列表。可以同时对N个实例绑定标签，N的取值范围为1~50。 ', + 'type' => 'array', + 'items' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-uf6wjk5xxxxxxx', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'The parameter - Tags should not be null.', + ], + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is blank.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.N.Value parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contain duplicate key.', + ], + [ + 'errorCode' => 'MissingParameter.TagOrResourceId', + 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The tags per resource number is exceed, Valid: 20', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied.Scope', + 'errorMessage' => 'The specified operator not have permission to set Scope value.', + ], + [ + 'errorCode' => 'PermissionDenied.TagOwnerUid', + 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.', + ], + [ + 'errorCode' => 'PermissionDenied.TagOwnerBid', + 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'These keys are not permission for this operator.', + ], + [ + 'errorCode' => 'NoPermissionKey.Scope', + 'errorMessage' => 'These keys are not permission for this scope.', + ], + [ + 'errorCode' => 'NoPermissionKey.Category', + 'errorMessage' => 'These keys are not permission for this category.', + ], + [ + 'errorCode' => 'NoPermission.SystemTag', + 'errorMessage' => 'The operator is not permission for the system tag.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The operator is not permission for this operate.', + ], + ], + [ + [ + 'errorCode' => 'InvalidResourceType.NotFound', + 'errorMessage' => 'The ResourceType provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceId is not found in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>224DB9F7-3100-4899-AB9C-C938BCCB43E7</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => '创建并绑定标签', + 'description' => '在实例数量较多的情况下，您可以创建多个标签，为实例绑定不同的标签对其进行分类，之后通过标签进行实例筛选。'."\n" + .'- 标签由一对键（key）值（value）组成，键在同账号同地域下唯一，值无此限制。'."\n" + .'- 若设置的标签不存在，则自动创建该标签并绑定到目标实例。'."\n" + .'- 若实例已经绑定了有相同键的标签，则进行覆盖绑定。'."\n" + .'- 每个实例最多可以绑定20个标签。'."\n" + .'- 每次调用最多设置50个实例进行批量标签绑定。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => '查询一个或多个网关已经绑定的标签列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17247', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw7Q12RI', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，可以通过接口DescribeRegions查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源区域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型定义。唯一取值：GATEWAY。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GATEWAY', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '网关ID列表, 可以同时查询N个网关的标签，'."\n" + .'> '."\n" + .'> - ResourceId 和 Tag 不能同时为空，请至少填写其中一项。', + 'type' => 'array', + 'items' => [ + 'description' => '网关ID列表, 可以同时查询N个网关的标签，N的取值范围：1~50。'."\n" + ."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-uf6wjk5xxxxxxx', + ], + 'required' => false, + 'example' => 'gw-uf6wjk5xxxxxxx', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。'."\n" + ."\n" + .'> '."\n" + .'> - ResourceId 和 Tag 不能同时为空，请至少填写其中一项。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。可以同时查询N个标签键，N的取值范围：1~20。不允许传入空字符串。'."\n" + ."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。可以同时查询N个标签值，N的取值范围：1~20。允许传入空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '查询到的网关和标签的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。ALIYUN::HCS_SGW::GATEWAY 即云存储网关。', + 'type' => 'string', + 'example' => 'ALIYUN::HCS_SGW::GATEWAY', + ], + 'TagValue' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'example' => 'testvalue1', + ], + 'ResourceId' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD ', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'testkey1 ', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'The parameter - Tags should not be null.', + ], + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is blank.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.N.Value parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contain duplicate key.', + ], + [ + 'errorCode' => 'MissingParameter.TagOrResourceId', + 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied.Scope', + 'errorMessage' => 'The specified operator not have permission to set Scope value.', + ], + [ + 'errorCode' => 'PermissionDenied.TagOwnerUid', + 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.', + ], + [ + 'errorCode' => 'PermissionDenied.TagOwnerBid', + 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'These keys are not permission for this operator.', + ], + [ + 'errorCode' => 'NoPermissionKey.Scope', + 'errorMessage' => 'These keys are not permission for this scope.', + ], + [ + 'errorCode' => 'NoPermissionKey.Category', + 'errorMessage' => 'These keys are not permission for this category.', + ], + [ + 'errorCode' => 'NoPermission.SystemTag', + 'errorMessage' => 'The operator is not permission for the system tag.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The operator is not permission for this operate.', + ], + ], + [ + [ + 'errorCode' => 'InvalidResourceType.NotFound', + 'errorMessage' => 'The ResourceType provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceId is not found in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"RequestId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650B3FD\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::HCS_SGW::GATEWAY\\",\\n \\"TagValue\\": \\"testvalue1\\",\\n \\"ResourceId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650B3FD\\\\t\\",\\n \\"TagKey\\": \\"testkey1\\\\t\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken>212db86sca4384811e0b5e8707ec21345</NextToken>\\n <RequestId>47A514A1-4B77-4E30-B4C5-2A880650B3FD</RequestId>\\n <TagResources>\\n <ResourceType>ALIYUN::HCS_SGW::GATEWAY</ResourceType>\\n <TagValue>testvalue1</TagValue>\\n <ResourceId>47A514A1-4B77-4E30-B4C5-2A880650B3FD\\t</ResourceId>\\n <TagKey>testkey1\\t</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => '查询一个或多个网关已经绑定的标签列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => '为指定的网关解绑标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw7Q12RI', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，可以通过接口DescribeRegions查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型定义。唯一取值：GATEWAY。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GATEWAY', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除实例的全部标签，默认值为false。取值范围：'."\n" + .'- true。'."\n" + .'- false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网关ID列表。可以同时对N个实例绑定标签，N的取值范围：1~50。', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-uf6wjk5xxxxxxx', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键。'."\n" + .'> '."\n" + .'> - 如果 All 字段未传递或设置为 false，则 TagKey 必须填写。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。可以同时删除N个标签键，N的取值范围：1~20。不允许传入空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '601B6F25-21E7-4484-99D5-3EF2625C0088', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'The parameter - Tags should not be null.', + ], + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is blank.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.N.Value parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contain duplicate key.', + ], + [ + 'errorCode' => 'The specified ResourceId is not found in our records.', + 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied.Scope', + 'errorMessage' => 'The specified operator not have permission to set Scope value.', + ], + [ + 'errorCode' => 'PermissionDenied.TagOwnerUid', + 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.', + ], + [ + 'errorCode' => 'PermissionDenied.TagOwnerBid', + 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'These keys are not permission for this operator.', + ], + [ + 'errorCode' => 'NoPermissionKey.Scope', + 'errorMessage' => 'These keys are not permission for this scope.', + ], + [ + 'errorCode' => 'NoPermissionKey.Category', + 'errorMessage' => 'These keys are not permission for this category.', + ], + [ + 'errorCode' => 'NoPermission.SystemTag', + 'errorMessage' => 'The operator is not permission for the system tag.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The operator is not permission for this operate.', + ], + ], + [ + [ + 'errorCode' => 'InvalidResourceType.NotFound', + 'errorMessage' => 'The ResourceType provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceId is not found in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"601B6F25-21E7-4484-99D5-3EF2625C0088\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>601B6F25-21E7-4484-99D5-3EF2625C0088</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => '解绑标签', + 'description' => '调用该接口时，您需要注意：'."\n" + .'- 每次解绑的标签数量不能超过20个。'."\n" + .'- 标签从一个实例解绑后，如果没有绑定到其它实例，则该标签自动被删除。', + ], + 'CreateGatewayLogging' => [ + 'summary' => '创建网关日志监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwR40N8S', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfw****', + ], + ], + [ + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务(SLS) Project。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex****', + ], + ], + [ + 'name' => 'SlsLogstore', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务(SLS) Logstore。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'logs****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。'."\n", + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '76109369-5729-467D-D4A3-1131A8DA****', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用结果，返回值如下：'."\n" + .'- true：请求成功。 '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'EmptySlsProject', + 'errorMessage' => 'You must specify a valid project of Log Service.', + ], + [ + 'errorCode' => 'EmptySlsLogstore', + 'errorMessage' => 'You must specify a valid Logstore of Log Service.', + ], + [ + 'errorCode' => 'GatewayVersionNotAllowed', + 'errorMessage' => 'The specified version for the gateway is invalid. You must specify a valid version.', + ], + [ + 'errorCode' => 'GatewayLoggingStatusNotAllowed', + 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'InvalidLogstore', + 'errorMessage' => 'You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.', + ], + [ + 'errorCode' => 'AssumeRoleFail', + 'errorMessage' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + [ + [ + 'errorCode' => 'StorageBundleNotExist', + 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'RoleNotExist', + 'errorMessage' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"76109369-5729-467D-D4A3-1131A8DA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建网关日志监控', + ], + 'DescribeGatewayLogging' => [ + 'summary' => '查询网关日志监控，包括日志监控的状态及日志项目(Project)名称和日志库(Logstore)。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwR40N8S', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwb***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SlsProject' => [ + 'description' => '日志服务(SLS) Project。', + 'type' => 'string', + 'example' => '123***', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '17D08346-BD08-4107-BFBC-01A6AAD5F5FB', + ], + 'Message' => [ + 'description' => ' 请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'GatewayLoggingStatus' => [ + 'description' => '网关日志状态。可能值：'."\n" + ."\n" + .'- None：无网关日志监控'."\n" + ."\n" + .'- Enabled：启用中'."\n" + ."\n" + .'- Disabled：禁用中'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'SlsLogstore' => [ + 'description' => '日志服务(SLS) Logstore。', + 'type' => 'string', + 'example' => 'alex***', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SlsProject\\": \\"123***\\",\\n \\"RequestId\\": \\"17D08346-BD08-4107-BFBC-01A6AAD5F5FB\\",\\n \\"Message\\": \\"successful\\",\\n \\"GatewayLoggingStatus\\": \\"Enabled\\",\\n \\"SlsLogstore\\": \\"alex***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayLoggingResponse>\\n <SlsProject>alex***</SlsProject>\\n <Message>successful</Message>\\n <RequestId>17D08346-BD08-4107-BFBC-01A6AAD5F5FB</RequestId>\\n <GatewayLoggingStatus>Enabled</GatewayLoggingStatus>\\n <SlsLogstore>123***</SlsLogstore>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayLoggingResponse>","errorExample":""}]', + 'title' => '查询网关日志监控', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableGatewayLogging' => [ + 'summary' => '启用网关日志监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwR40N8S', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbv***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayLoggingStatusNotAllowed', + 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<EnableGatewayLoggingResponse>\\n <Message>successful</Message>\\n <RequestId>CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</EnableGatewayLoggingResponse>","errorExample":""}]', + 'title' => '启用网关日志监控', + 'description' => '### 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'- 如果您想启用日志监控功能，您可以通过此接口启用指定的网关日志监控。'."\n" + ."\n" + .'- 请确保您已创建云存储网关及网关日志监控，并且网关日志监控处于禁用(Disabled)状态。'."\n" + ."\n" + .'- 您可以通过DescribeGatewayLogging接口查询网关日志监控的状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableGatewayLogging' => [ + 'summary' => '禁用网关日志监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwR40N8S', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwb***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25288205-A591-4AA9-ACF8-427E8727A9D3', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayLoggingStatusNotAllowed', + 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"25288205-A591-4AA9-ACF8-427E8727A9D3\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DisableGatewayLoggingResponse>\\n <Message>successful</Message>\\n <RequestId>25288205-A591-4AA9-ACF8-427E8727A9D3</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DisableGatewayLoggingResponse>","errorExample":""}]', + 'title' => '禁用网关日志监控', + 'description' => '### 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'- 如果您想暂时禁用日志监控功能，您可以通过此接口禁用已创建的网关日志监控。'."\n" + ."\n" + .'- 请确保您已创建云存储网关及网关日志监控，并且网关日志监控处于启用(Enabled)状态。'."\n" + ."\n" + .'- 您可以通过DescribeGatewayLogging接口查询网关日志监控的状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteGatewayLogging' => [ + 'summary' => '删除网关日志监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwR40N8S', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E66BF56E-068D-4308-A2D8-7FBBCE22E812', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayLoggingStatusNotAllowed', + 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E66BF56E-068D-4308-A2D8-7FBBCE22E812\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayLoggingResponse>\\n <Message>successful</Message>\\n <RequestId>E66BF56E-068D-4308-A2D8-7FBBCE22E812</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayLoggingResponse>","errorExample":""}]', + 'title' => '删除网关日志监控', + 'description' => '### 接口说明'."\n" + ."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'- 如果您不想再使用日志监控功能，您可以通过此接口删除指定的日志监控。'."\n" + ."\n" + .'- 请确保您已创建云存储网关，并创建网关日志监控。'."\n" + ."\n" + .' - 只有网关日志监控状态为启用中(Enabled)或禁用中(Disabled)时，才可以删除网关日志监控。'."\n" + ."\n" + .' <props="china">- 您可以通过[DescribeGatewayLogging](https://help.aliyun.com/zh/csg/developer-reference/api-describegatewaylogging)接口查询网关日志监控的状态。</props><props="intl">- 您可以通过[DescribeGatewayLogging](https://www.alibabacloud.com/help/zh/csg/developer-reference/api-describegatewaylogging?spm=a2c63.p38356.0.0.19107582L1BU5t)接口查询网关日志监控的状态。</props>'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateExpressSync' => [ + 'summary' => '创建极速同步组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwNGMQUV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '极速同步组名称。同步组名称长度限制1~128个字符，可以包含大小写字母、中文、数字、半角句号（.）、下划线（_）或短划线（-），同时必须以大小写字母或者中文开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alex-tb***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '极速同步组描述。长度限制为255个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '同步组测试', + ], + ], + [ + 'name' => 'BucketRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket所在地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket名称。请注意：'."\n" + ."\n" + .'- 一个同步组只能设定一个OSS Bucket，所有对该Bucket内数据进行的改动都会被同步至本地。'."\n" + ."\n" + .'- 如果您还未创建任何连接至OSS Bucket的共享，请先创建文件网关与OSS Bucket之间的共享。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sgw-test***', + ], + ], + [ + 'name' => 'BucketPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket子目录。如果您要对Bucket特定子目录内的数据改动进行同步，可以填写您需要的子目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'test***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEFC9927-B097-446D-8FDA-F848C8B2C9E0', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'ExpressSyncId' => [ + 'description' => '极速同步组ID。', + 'type' => 'string', + 'example' => 'sync-0001xv7je357xn8tr***', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyExpressSyncName', + 'errorMessage' => 'You must enter a valid name for the sync group.', + ], + [ + 'errorCode' => 'EmptyBucketName', + 'errorMessage' => 'You must enter a valid name for the bucket.', + ], + [ + 'errorCode' => 'EmptyBucketRegion', + 'errorMessage' => 'You must specify a valid region for the bucket.', + ], + [ + 'errorCode' => 'InvalidExpressSyncName', + 'errorMessage' => 'The specified name for the sync group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', + ], + [ + 'errorCode' => 'DescriptionOverLimit', + 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.', + ], + [ + 'errorCode' => 'DuplicateExpressSyncName', + 'errorMessage' => 'The specified name of the sync group already exists. Try again later after you specify a valid parameter.', + ], + [ + 'errorCode' => 'ConflictExpressSyncConfig', + 'errorMessage' => 'The parameter you specified for the sync group is invalid. Try again later after you specify a valid parameter.', + ], + [ + 'errorCode' => 'ExpressSyncNotificationEventLimitExceed', + 'errorMessage' => 'The number of sync groups exceeds the maximum limit. If you want to add more sync groups, we recommend that you submit a ticket to apply for the whitelist permission.', + ], + [ + 'errorCode' => 'InvalidRegionId', + 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.', + ], + [ + 'errorCode' => 'InvalidBucketName', + 'errorMessage' => 'The specified bucket name is invalid. You must enter a valid bucket name.', + ], + [ + 'errorCode' => 'ExpressSyncNotificationEventConflict', + 'errorMessage' => 'The express sync configuration of bucket and prefix conflicts with existing notification events in MNS.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.', + ], + [ + 'errorCode' => 'AssumeRoleFail', + 'errorMessage' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + [ + [ + 'errorCode' => 'RoleNotExist', + 'errorMessage' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEFC9927-B097-446D-8FDA-F848C8B2C9E0\\",\\n \\"Code\\": \\"200\\",\\n \\"ExpressSyncId\\": \\"sync-0001xv7je357xn8tr***\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateExpressSyncResponse>\\n <Message>successful</Message>\\n <RequestId>EEFC9927-B097-446D-8FDA-F848C8B2C9E0</RequestId>\\n <ExpressSyncId>sync-0001xv7je357xn8tr***</ExpressSyncId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateExpressSyncResponse>","errorExample":""}]', + 'title' => '创建极速同步组', + 'description' => '### 接口说明'."\n" + ."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'<props="china">- 请确保在使用该接口前，已充分了解阿里云轻量消息队列（原 MNS）产品的收费方式和[价格](https://help.aliyun.com/zh/mns/product-overview/pricing-1?spm=a2c4g.11186623.0.0.2a806f7cOKw4LV)。轻量消息队列（原 MNS）费用由主题（Topic）和队列（Queue）两部分组成，并按天进行计费。每个极速同步组按照一个Topic进行计费，每个加入同步组的共享都会按一个Queue进行计费。</props><props="intl">- 请确保在使用该接口前，已充分了解阿里云轻量消息队列（原 MNS）产品的收费方式和价格。轻量消息队列（原 MNS）费用由主题（Topic）和队列（Queue）两部分组成，并按天进行计费。每个极速同步组按照一个Topic进行计费，每个加入同步组的共享都会按一个Queue进行计费。</props>'."\n" + ."\n" + .'- 极速同步功能依赖于阿里云轻量消息队列（原 MNS）实现，因此使用极速同步会产生相应服务的费用。'."\n" + ."\n" + .'- 使用极速同步功能，您可以将一个或多个连接至同一个OSS Bucket的共享加入一个同步组。对该Bucket中数据进行的任何改动都会同步至该同步组中所有共享的本地客户端，从而无需单独对每个共享进行反向同步，提高数据同步的效率和准确性。'."\n" + ."\n" + .'- 目前只有标准型、增强型及性能型的云存储网关支持极速同步功能。'."\n" + ."\n" + .'- 请确认您已创建文件网关并添加缓存，如果没有请创建文件网关及添加缓存。'."\n" + ."\n" + .'- 请确认您已创建OSS Bucket，并配置了文件网关与OSS Bucket之间的NFS或SMB共享。'."\n" + ."\n" + .'- 可加入极速同步组的相关Bucket信息可以通过DescribeSharesBucketInfoForExpressSync接口查询。'."\n" + ."\n" + .'- 请确认您已开通阿里云轻量消息队列（原 MNS）并授权。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddSharesToExpressSync' => [ + 'summary' => '添加共享到极速同步组中，可以添加多个共享。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwNGMQUV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ExpressSyncId', + 'in' => 'query', + 'schema' => [ + 'description' => '极速同步组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sync-0001xv7je357xn8tr***', + ], + ], + [ + 'name' => 'GatewayShares', + 'in' => 'query', + 'schema' => [ + 'description' => '网关共享名称。可以添加多个共享，JSON格式为：{"网关ID1":"共享1，共享2","网关ID2":"共享1，共享2"}'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xr6ql***', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA3887', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'MnsTopic' => [ + 'description' => '极速同步组使用的轻量消息队列（原 MNS）主题。', + 'type' => 'string', + 'example' => 'sgw-express-sync-topic-sync-0009e51kabuou08***', + ], + 'MnsQueues' => [ + 'description' => '极速同步组使用的轻量消息队列（原 MNS）队列。', + 'type' => 'string', + 'example' => 'sgw-express-sync-queue-gw-0009e51kabuoty9***-341604', + ], + 'MnsFullSyncDelay' => [ + 'description' => '首次全量同步延迟时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '719', + ], + 'MnsPublicEndpoint' => [ + 'description' => '极速同步组使用的轻量消息队列（原 MNS）公网访问Endpoint。', + 'type' => 'string', + 'example' => 'http://123.mns.cn-hangzhou.aliyuncs.com/', + ], + 'MnsInnerEndpoint' => [ + 'description' => '极速同步组使用的轻量消息队列（原 MNS）内网访问Endpoint。', + 'type' => 'string', + 'example' => 'http://123.mns.cn-hangzhou-internal.aliyuncs.com/', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyExpressSyncId', + 'errorMessage' => 'You must specify a valid ID for the sync group.', + ], + [ + 'errorCode' => 'ExpressSyncNotExist', + 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'ExpressSyncInOperation', + 'errorMessage' => 'The sync group is busy. Try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6ql***\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA3887\\",\\n \\"Message\\": \\"successful\\",\\n \\"MnsTopic\\": \\"sgw-express-sync-topic-sync-0009e51kabuou08***\\",\\n \\"MnsQueues\\": \\"sgw-express-sync-queue-gw-0009e51kabuoty9***-341604\\",\\n \\"MnsFullSyncDelay\\": 719,\\n \\"MnsPublicEndpoint\\": \\"http://123.mns.cn-hangzhou.aliyuncs.com/\\",\\n \\"MnsInnerEndpoint\\": \\"http://123.mns.cn-hangzhou-internal.aliyuncs.com/\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddSharesToExpressSyncResponse>\\n <TaskId>t-0001xv7je357xr6ql***</TaskId>\\n <RequestId>1EDBC004-6B1C-4511-ACF5-0B4875BA3887</RequestId>\\n <Message>successful</Message>\\n <MnsTopic>sgw-express-sync-topic-sync-0009e51kabuou08***</MnsTopic>\\n <MnsQueues>sgw-express-sync-queue-gw-0009e51kabuoty9***-341604</MnsQueues>\\n <MnsFullSyncDelay>719</MnsFullSyncDelay>\\n <MnsPublicEndpoint>http://123.mns.cn-hangzhou.aliyuncs.com/</MnsPublicEndpoint>\\n <MnsInnerEndpoint>http://123.mns.cn-hangzhou-internal.aliyuncs.com/</MnsInnerEndpoint>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddSharesToExpressSyncResponse>","errorExample":""}]', + 'title' => '添加共享到极速同步组中', + 'description' => '调用该接口时，您需要注意：'."\n" + .'- 请确认您已创建极速同步组。如果还未创建，您可以通过CreateExpressSync创建极速同步组，且同步组的Bucket必须与共享的Bucket相同。'."\n" + .'- 如果您传入的共享名称为空，请求将被忽略。', + ], + 'DescribeExpressSyncs' => [ + 'summary' => '查询极速同步组，包括极速同步组名称、极速同步组ID、Bucket名称等详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwNGMQUV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket 名称。未传递参数时，默认查询该用户下的所有极速同步组。', + 'type' => 'string', + 'required' => false, + 'example' => 'sgw****', + ], + ], + [ + 'name' => 'BucketPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket 子目录。未传递参数时，查询该Bucket的极速同步组；传入空字符串时，默认查询该Bucket根目录的极速同步组。'."\n" + .'> 不支持Bucket名称为空，只查询Bucket子目录的场景。', + 'type' => 'string', + 'required' => false, + 'example' => 'test****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ExpressSyncs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExpressSync' => [ + 'description' => '极速同步组信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpressSyncId' => [ + 'description' => '极速同步组ID。', + 'type' => 'string', + 'example' => 'sync-0002xetjdlxne2sd****', + ], + 'Description' => [ + 'description' => '极速同步组描述。', + 'type' => 'string', + 'example' => '测试使用', + ], + 'BucketName' => [ + 'description' => 'Bucket 名称。', + 'type' => 'string', + 'example' => 'sgw-mns****', + ], + 'Name' => [ + 'description' => '极速同步组名称。', + 'type' => 'string', + 'example' => 'wptest****', + ], + 'BucketPrefix' => [ + 'description' => 'Bucket 子目录。', + 'type' => 'string', + 'example' => 'test****', + ], + 'MnsTopic' => [ + 'description' => '该同步组在阿里云轻量消息队列（原 MNS）中对应的消息主题（Topic）名称。', + 'type' => 'string', + 'example' => 'sgw-express-sync-0002xetjdlxne2sd****', + ], + 'BucketRegion' => [ + 'description' => 'OSS 地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '50DE1383-D4A1-433C-98A6-459C1830A888', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果。可能值：'."\n" + .' - true：是。'."\n" + .' - false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ExpressSyncs\\": {\\n \\"ExpressSync\\": [\\n {\\n \\"ExpressSyncId\\": \\"sync-0002xetjdlxne2sd****\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"BucketName\\": \\"sgw-mns****\\",\\n \\"Name\\": \\"wptest****\\",\\n \\"BucketPrefix\\": \\"test****\\",\\n \\"MnsTopic\\": \\"sgw-express-sync-0002xetjdlxne2sd****\\",\\n \\"BucketRegion\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"50DE1383-D4A1-433C-98A6-459C1830A888\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeExpressSyncsResponse>\\n <ExpressSyncs>\\n <ExpressSyncId>sync-0002xetjdlxne2sd****</ExpressSyncId>\\n <Description>测试使用</Description>\\n <BucketName>sgw-mns****</BucketName>\\n <Name>wptest****</Name>\\n <BucketPrefix>test****</BucketPrefix>\\n <MnsTopic>sgw-express-sync-0002xetjdlxne2sd****</MnsTopic>\\n <BucketRegion>cn-hangzhou</BucketRegion>\\n </ExpressSyncs>\\n <Message>successful</Message>\\n <RequestId>50DE1383-D4A1-433C-98A6-459C1830A888</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeExpressSyncsResponse>","errorExample":""}]', + 'title' => '查询极速同步组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExpressSyncShares' => [ + 'summary' => '查询极速同步组对应的共享信息或可加入极速同步组的共享信息。包括极速同步组对应共享的网关名称、集群ID、共享名称等详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwNGMQUV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ExpressSyncIds', + 'in' => 'query', + 'schema' => [ + 'description' => '同步组的ID列表。同步组ID之间以逗号进行分割。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sync-0002xetjdlxne2sd***,sync-0004agfrbke1l39p***', + ], + ], + [ + 'name' => 'IsExternal', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询已加入的共享。取值范围：'."\n" + ."\n" + .'- true：查询可加入该同步组的共享信息。'."\n" + ."\n" + .'- false：查询已在同步组的共享信息。'."\n" + ."\n" + .'默认值：false。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EA258616-36AD-4609-A0A6-2B17C28CBF88', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Shares' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Share' => [ + 'description' => '极速同步组共享信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MnsQueue' => [ + 'description' => '该共享在阿里云轻量消息队列（原 MNS）中对应的消息队列（Queue）名称。', + 'type' => 'string', + 'example' => 'sgw-express-sync-queue-gw-000245alq48e7ytgxq03***', + ], + 'ExpressSyncId' => [ + 'description' => '极速同步ID。', + 'type' => 'string', + 'example' => 'sb-0003c7qh5yuc1z6b8***', + ], + 'GatewayId' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'example' => 'gw-000245alq48e7ytg***', + ], + 'ExpressSyncState' => [ + 'description' => '极速同步组健康状态。可能值：'."\n" + ."\n" + .'- TopicAndQueueFailure：消息队列消息主题无法访问。'."\n" + ."\n" + .'- TopicFailure：消息主题无法访问。'."\n" + ."\n" + .'- MNSFullSyncInit：全量同步等待中。'."\n" + ."\n" + .'- MNSFullSyncing：全量同步进行中。'."\n" + ."\n" + .'- QueueFailure：消息队列无法访问。'."\n" + ."\n" + .'- MNSNotEnabled：极速同步未开启。'."\n" + ."\n" + .'- MNSHealthy:：同步正常。', + 'type' => 'string', + 'example' => 'MNSHealthy', + ], + 'GatewayName' => [ + 'description' => '网关名称。', + 'type' => 'string', + 'example' => 'file-升级***', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-0003c7qh5yuc1z6b8***', + ], + 'SyncProgress' => [ + 'description' => '共享全量同步进度。当共享已加入同步组的情况下, 该返回参数有效。可能值：'."\n" + ."\n" + .'- 0~100：共享全量同步进度，百分比。'."\n" + ."\n" + .'- -1：表示共享并未发生全量同步。'."\n" + ."\n" + .'- -2：表示共享所在网关版本不支持该功能。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'GatewayRegion' => [ + 'description' => '网关所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ShareName' => [ + 'description' => '共享名称。', + 'type' => 'string', + 'example' => 'ji***', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyExpressSyncId', + 'errorMessage' => 'You must specify a valid ID for the sync group.', + ], + [ + 'errorCode' => 'ExpressSyncNotExist', + 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EA258616-36AD-4609-A0A6-2B17C28CBF88\\",\\n \\"Code\\": \\"200\\",\\n \\"Shares\\": {\\n \\"Share\\": [\\n {\\n \\"MnsQueue\\": \\"sgw-express-sync-queue-gw-000245alq48e7ytgxq03***\\",\\n \\"ExpressSyncId\\": \\"sb-0003c7qh5yuc1z6b8***\\",\\n \\"GatewayId\\": \\"gw-000245alq48e7ytg***\\",\\n \\"ExpressSyncState\\": \\"MNSHealthy\\",\\n \\"GatewayName\\": \\"file-升级***\\",\\n \\"StorageBundleId\\": \\"sb-0003c7qh5yuc1z6b8***\\",\\n \\"SyncProgress\\": 100,\\n \\"GatewayRegion\\": \\"cn-hangzhou\\",\\n \\"ShareName\\": \\"ji***\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeExpressSyncSharesResponse>\\n <Message>successful</Message>\\n <RequestId>EA258616-36AD-4609-A0A6-2B17C28CBF88</RequestId>\\n <Shares>\\n <Share>\\n <ExpressSyncState>MNSHealthy</ExpressSyncState>\\n <ShareName>ji***</ShareName>\\n <GatewayRegion>cn-hangzhou</GatewayRegion>\\n <StorageBundleId>sb-0003c7qh5yuc1z6b8***</StorageBundleId>\\n <GatewayName>file-升级***</GatewayName>\\n <GatewayId>gw-000245alq48e7ytg***</GatewayId>\\n <ExpressSyncId>sync-000ip92hqkvu0gbxi***</ExpressSyncId>\\n <SyncProgress>100</SyncProgress>\\n <MnsQueue>sgw-express-sync-queue-gw-000245alq48e7ytgxq03***</MnsQueue>\\n </Share>\\n <Share>\\n <ExpressSyncState>MNSHealthy</ExpressSyncState>\\n <ShareName>cifs12***</ShareName>\\n <GatewayRegion>cn-hangzhou</GatewayRegion>\\n <StorageBundleId>sb-000gxdrndxrm50gtl***</StorageBundleId>\\n <GatewayName>file122***</GatewayName>\\n <GatewayId>gw-000hqr50529yvycly***</GatewayId>\\n <ExpressSyncId>sync-000jf2sbjhfatey3***</ExpressSyncId>\\n <SyncProgress>100</SyncProgress>\\n <MnsQueue>sgw-express-sync-queue-gw-000hqr5052cly5xa***</MnsQueue>\\n </Share>\\n </Shares>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeExpressSyncSharesResponse>","errorExample":""}]', + 'title' => '查询极速同步组的共享信息或可加入的共享信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteExpressSync' => [ + 'summary' => '删除指定极速同步组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17175', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwNGMQUV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ExpressSyncId', + 'in' => 'query', + 'schema' => [ + 'description' => '极速同步组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sync-0001xv7je357xn8tr***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xv4st***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A870C702-C3AC-4FC9-91E4-053D3E599A24', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyExpressSyncId', + 'errorMessage' => 'You must specify a valid ID for the sync group.', + ], + [ + 'errorCode' => 'ExpressSyncNotExist', + 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'ExpressSyncInOperation', + 'errorMessage' => 'The sync group is busy. Try again later.', + ], + [ + 'errorCode' => 'ExpressSyncNotEmpty', + 'errorMessage' => 'Failed to delete the express sync because a file share or a CSD mount point is attached. We recommend that you remove all attached before you delete the express sync.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xv4st***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A870C702-C3AC-4FC9-91E4-053D3E599A24\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteExpressSyncResponse>\\n <TaskId>t-0001xv7je357xv4st***</TaskId>\\n <Message>successful</Message>\\n <RequestId>A870C702-C3AC-4FC9-91E4-053D3E599A24</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteExpressSyncResponse>","errorExample":""}]', + 'title' => '删除极速同步组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveSharesFromExpressSync' => [ + 'summary' => '调用RemoveSharesFromExpressSync可以删除极速同步组对应的共享。可删除多个共享。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17259', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwNGMQUV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ExpressSyncId', + 'in' => 'query', + 'schema' => [ + 'description' => '极速同步组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sync-0001xv7je357xn8tr***', + ], + ], + [ + 'name' => 'GatewayShares', + 'in' => 'query', + 'schema' => [ + 'description' => '网关共享名称。可以删除多个共享，JSON格式为：'."\n" + ."\n" + .'- {"网关ID1":"共享1，共享2","网关ID2":"共享1，共享2"}', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je357xr6ql***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA3B22', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ExpressSyncNotExist', + 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'ExpressSyncInOperation', + 'errorMessage' => 'The sync group is busy. Try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6ql***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA3B22\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RemoveSharesFromExpressSyncResponse>\\n <TaskId>t-0001xv7je357xr6ql***</TaskId>\\n <Message>successful</Message>\\n <RequestId>1EDBC004-6B1C-4511-ACF5-0B4875BA3B22</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RemoveSharesFromExpressSyncResponse>","errorExample":""}]', + 'title' => '删除极速同步组对应的共享', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGatewayLocations' => [ + 'summary' => '查询网关位置列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17209', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C85521C5-AB12-52E0-8541-76E582C1DA2C', + ], + 'Locations' => [ + 'description' => '网关位置列表。', + 'type' => 'string', + 'example' => 'Cloud,On_Premise', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果。返回值如下：'."\n" + .'- true：请求成功。 '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C85521C5-AB12-52E0-8541-76E582C1DA2C\\",\\n \\"Locations\\": \\"Cloud,On_Premise\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询网关位置列表', + ], + 'DescribeGatewaySMBClients' => [ + 'summary' => '查询文件网关中SMB挂载客户端列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219649', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页显示时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213A***', + ], + 'Success' => [ + 'description' => '请求是否成功。可能值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '分页显示时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'SMB客户端总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ClientInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClientInfo' => [ + 'description' => 'SMB客户端信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'SMB客户端信息。', + 'type' => 'object', + 'properties' => [ + 'Signing' => [ + 'description' => '签名。', + 'type' => 'string', + 'example' => 'required', + ], + 'ProtocolVersion' => [ + 'description' => '协议版本。', + 'type' => 'string', + 'example' => '2.1', + ], + 'Group' => [ + 'description' => '用户组。', + 'type' => 'string', + 'example' => 'guest', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'guest', + ], + 'ClientIpAddr' => [ + 'description' => 'SMB客户端IP地址。', + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213A***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"ClientInfoList\\": {\\n \\"ClientInfo\\": [\\n {\\n \\"Signing\\": \\"required\\",\\n \\"ProtocolVersion\\": \\"2.1\\",\\n \\"Group\\": \\"guest\\",\\n \\"Username\\": \\"guest\\",\\n \\"ClientIpAddr\\": \\"192.168.xx.xx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询SMB挂载客户端列表', + ], + 'DescribeGatewaySMBSecurityStrategy' => [ + 'summary' => '查询网关SMB安全级别配置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-000c6hshwukkbryp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E', + ], + 'Success' => [ + 'description' => '请求是否成功。可能值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SecurityStrategy' => [ + 'description' => '安全级别。可能值如下：'."\n" + .'- ClientNegotiated：客户端协商。'."\n" + .'- EnforceSigning：强制签署。', + 'type' => 'string', + 'example' => 'ClientNegotiated', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Success\\": true,\\n \\"SecurityStrategy\\": \\"ClientNegotiated\\"\\n}","type":"json"}]', + 'title' => '查询网关SMB安全级别配置', + ], + 'ListAlertEvents' => [ + 'summary' => '列出网关告警事件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191531', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'ShareIndexId', + 'in' => 'query', + 'schema' => [ + 'description' => '共享名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'nfs_share', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '网关列表信息的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '网关列表每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'FirstTriggerTimestampStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1761559501337', + ], + ], + [ + 'name' => 'FirstTriggerTimestampEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1761570323090', + ], + ], + [ + 'name' => 'GatewayRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关所在地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '列出全部告警事件或正在告警中的事件。'."\n" + .'- 当取值为**alerting**时，表示列出正在告警中的事件。'."\n" + .'- 当取值为空时，表示列出全部告警事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'alerting', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '网关列表每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '网关列表信息的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '告警事件总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AlertEvents' => [ + 'description' => '告警事件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '告警类型。可能值：'."\n" + .'- throttling：限流。'."\n" + .'- uploadQueueFull：上传队列堆积。'."\n" + .'- lowMetaSpace：元数据空间不足。', + 'type' => 'string', + 'example' => 'uploadQueueFull', + ], + 'FirstTriggerTimestamp' => [ + 'description' => '首次触发告警的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761559501337', + ], + 'GatewayId' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'example' => 'gw-000dx594q3j5o663s8nx', + ], + 'LastTriggerTimestamp' => [ + 'description' => '最后一次触发告警的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761570323090', + ], + 'StorageBundleId' => [ + 'description' => '网关集群ID。', + 'type' => 'string', + 'example' => 'sb-000iymnht76bdwsho0lm', + ], + 'ShareIndexId' => [ + 'description' => '共享IndexId。', + 'type' => 'string', + 'example' => 'NFSnfs_share', + ], + 'Level' => [ + 'description' => '告警级别。取值为warn。', + 'type' => 'string', + 'example' => 'warn', + ], + 'AccountId' => [ + 'description' => '废弃。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '”“', + ], + 'Status' => [ + 'description' => '告警事件的状态。可能值：'."\n" + .'- alerting：正在告警中。'."\n" + .'- restored：已恢复正常。'."\n" + .'- gatewayDeleted：网关已删除。'."\n" + .'- shareDeleted：共享已删除。', + 'type' => 'string', + 'example' => 'alerting', + ], + 'RegionId' => [ + 'description' => '网关地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Display' => [ + 'description' => '废弃。', + 'type' => 'boolean', + 'example' => '”“', + ], + 'ShareStatus' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => '”“', + ], + 'GatewayStatus' => [ + 'description' => '废弃。', + 'type' => 'string', + 'example' => '”“', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 20,\\n \\"AlertEvents\\": [\\n {\\n \\"Type\\": \\"uploadQueueFull\\",\\n \\"FirstTriggerTimestamp\\": 1761559501337,\\n \\"GatewayId\\": \\"gw-000dx594q3j5o663s8nx\\",\\n \\"LastTriggerTimestamp\\": 1761570323090,\\n \\"StorageBundleId\\": \\"sb-000iymnht76bdwsho0lm\\",\\n \\"ShareIndexId\\": \\"NFSnfs_share\\",\\n \\"Level\\": \\"warn\\",\\n \\"AccountId\\": 0,\\n \\"Status\\": \\"alerting\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Display\\": true,\\n \\"ShareStatus\\": \\"”“\\",\\n \\"GatewayStatus\\": \\"”“\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列出网关告警事件', + ], + 'SetGatewaySMBSecurityStrategy' => [ + 'summary' => '配置SMB安全级别。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-0001xv7je3580031***', + ], + ], + [ + 'name' => 'SecurityStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '安全级别。取值范围：'."\n" + .'- ClientNegotiated：客户端协商。'."\n" + .'- EnforceSigning：强制签署。', + 'type' => 'string', + 'required' => false, + 'example' => 'EnforceSigning', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '735B642E-6564-4A87-99A0-3609F67C787E', + ], + 'Success' => [ + 'description' => '请求结果，返回值如下：'."\n" + ."\n" + .'- true：请求成功。 '."\n" + .' '."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"735B642E-6564-4A87-99A0-3609F67C787E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '配置SMB安全级别', + ], + 'DescribeGatewayModificationClasses' => [ + 'summary' => '调用DescribeGatewayModificationClasses接口可查询线上网关的可升配规格信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwQHP82G', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3580031***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FA8951CC-A534-425D-8705-F9A5CF9FD555', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TargetGatewayClasses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetGatewayClass' => [ + 'description' => '可升配规格信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GatewayClass' => [ + 'description' => '可以升配的网关规格。可能值：'."\n" + .'- Basic：基础型。'."\n" + ."\n" + .'- Standard：标准型。'."\n" + ."\n" + .'- Enhanced：增强型。'."\n" + ."\n" + .'- Advanced：性能型。', + 'type' => 'string', + 'example' => 'Enhanced', + ], + 'IsAvailable' => [ + 'description' => '规格是否可用。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'LocationCloudRequired', + 'errorMessage' => 'You must specify a cloud gateway. Try again later.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FA8951CC-A534-425D-8705-F9A5CF9FD555\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"TargetGatewayClasses\\": {\\n \\"TargetGatewayClass\\": [\\n {\\n \\"GatewayClass\\": \\"Enhanced\\",\\n \\"IsAvailable\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayModificationClassesResponse>\\n <Message>successful</Message>\\n <RequestId>FA8951CC-A534-425D-8705-F9A5CF9FD555</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <TargetGatewayClasses>\\n <TargetGatewayClass>\\n <IsAvailable>true</IsAvailable>\\n <GatewayClass>Enhanced</GatewayClass>\\n </TargetGatewayClass>\\n <TargetGatewayClass>\\n <IsAvailable>true</IsAvailable>\\n <GatewayClass>Advanced</GatewayClass>\\n </TargetGatewayClass>\\n </TargetGatewayClasses>\\n</DescribeGatewayModificationClassesResponse>","errorExample":""}]', + 'title' => '查询线上网关的可升配规格信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyGatewayClass' => [ + 'summary' => '可对线上网关的网关规格进行升配。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw1K8DWI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7580031yzun***', + ], + ], + [ + 'name' => 'GatewayClass', + 'in' => 'query', + 'schema' => [ + 'description' => '升配的网关规格。可升配的规格可以通过DescribeGatewayModificationClasses接口查询。可能值：'."\n" + ."\n" + .'- Basic：基础型。'."\n" + ."\n" + .'- Standard：标准型。'."\n" + ."\n" + .'- Enhanced：增强型。'."\n" + ."\n" + .'- Advanced：性能型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enhanced', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BuyURL' => [ + 'description' => '付费类型为包年包月时，网关升配的购买链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je3580bx6v***', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'InvalidGatewayClass', + 'errorMessage' => 'The specified specification of the gateway is invalid.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'LocationCloudRequired', + 'errorMessage' => 'You must specify a cloud gateway. Try again later.', + ], + [ + 'errorCode' => 'GatewayStatusRunningRequired', + 'errorMessage' => 'The gateway is not in the Running state. Try again later.', + ], + [ + 'errorCode' => 'GatewayClassUpgradeOnly', + 'errorMessage' => 'You can upgrade only the specification of the gateway.', + ], + [ + 'errorCode' => 'NoAvailableOnlineResource', + 'errorMessage' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade\\",\\n \\"TaskId\\": \\"t-0001xv7je3580bx6v***\\",\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyGatewayClassResponse>\\n <TaskId>t-0001xv7je3580bx6v***</TaskId>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade</BuyURL>\\n <Message>successful</Message>\\n <RequestId>395B1136-982E-4F95-BDCE-7323FFEF499E</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyGatewayClassResponse>","errorExample":""}]', + 'title' => '网关升配', + 'description' => '### 接口说明'."\n" + ."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'<props="china">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和[价格](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5&aly_as=C81M1m5N#/hcs_sgw/detail)。</props>'."\n" + .'<props="intl">- 请确保在使用该接口前，已充分了解云存储网关产品的收费方式。</props>'."\n" + ."\n" + .'- 如果您的网关为包年包月类型，即预付费时，您必须通过接口返回的购买链接进行购买，才能完成网关升配。'."\n" + ."\n" + .'- 你可以通过DescribeGatewayModificationClasses接口查询指定线上网关可升配的规格信息。'."\n" + ."\n" + .'- 只能升级线上网关可升配规格的规格，且线上网关只能升配不能降配。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestartFileShares' => [ + 'summary' => '调用RestartFileShares可以重启云存储网关上的文件共享。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgw64A0KV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-000eg44nmxbsfwbvq***', + ], + ], + [ + 'name' => 'ShareProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '文件共享的类型。可取值如下：'."\n" + ."\n" + .'- SMB。'."\n" + ."\n" + .'- NFS。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NFS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-000czaedx5koz578v***', + ], + 'Message' => [ + 'description' => ' 请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** ', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。可取值如下：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidShareProtocol', + 'errorMessage' => 'The specified file sharing type is invalid. Valid values include SMB and NFS. Try again later.', + ], + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayInOperation', + 'errorMessage' => 'The gateway is processing requests . Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000czaedx5koz578v***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** \\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RestartFileSharesResponse>\\n <TaskId>t-000czaedx5koz578v***</TaskId>\\n <Message>successful</Message>\\n <RequestId>89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** </RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RestartFileSharesResponse>","errorExample":""}]', + 'title' => '重启云存储网关上的文件共享', + 'description' => '### 接口说明'."\n" + .'><warning>重启共享会导致您的业务暂时中断，请谨慎操作。'."\n" + .'></warning></props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UploadGatewayLog' => [ + 'summary' => '调用UploadGatewayLog上传网关支持信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17280', + 'abilityTreeNodes' => [ + 'FEATUREhcs_sgwR40N8S', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '网关ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0001xv7je3031yzun***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0001xv7je3580412f***', + ], + 'Message' => [ + 'description' => '请求结果描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB300009-3850-4107-B291-59BDB4EDA183', + ], + 'Code' => [ + 'description' => '状态码。状态码为200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求还是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EmptyGatewayId', + 'errorMessage' => 'You must enter a valid ID for the gateway.', + ], + [ + 'errorCode' => 'GatewayNotExist', + 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', + ], + [ + 'errorCode' => 'GatewayOperationNotAllowed', + 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je3580412f***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CB300009-3850-4107-B291-59BDB4EDA183\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadGatewayLogResponse>\\n <TaskId>t-0001xv7je3580412f***</TaskId>\\n <Message>successful</Message>\\n <RequestId>CB300009-3850-4107-B291-59BDB4EDA183</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadGatewayLogResponse>","errorExample":""}]', + 'title' => '上传网关支持信息', + 'description' => '调用该接口时，您需要注意：'."\n" + ."\n" + .'- 仅支持网关状态为运行中（Running）、已激活（Activated）时调用此接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'sgw.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'sgw.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'sgw.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'sgw.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'sgw.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'sgw.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'sgw.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'sgw.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'sgw.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'sgw.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'sgw.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'sgw.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'sgw.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'sgw.ap-northeast-2.aliyuncs.com', + ], + ], +]; |