'1.0',
'info' => [
'style' => 'RPC',
'product' => 'DBFS',
'version' => '2020-04-18',
],
'directories' => [
[
'id' => 134159,
'title' => null,
'type' => 'directory',
'children' => [
'CreateDbfs',
'UpdateDbfs',
'DeleteDbfs',
'AttachDbfs',
'DetachDbfs',
'RenameDbfs',
'ResizeDbfs',
'ListDbfs',
'GetDbfs',
'ListDbfsAttachableEcsInstances',
'ListDbfsAttachedEcsInstances',
],
],
[
'id' => 134170,
'title' => null,
'type' => 'directory',
'children' => [
'CreateSnapshot',
'DeleteSnapshot',
'ModifySnapshotAttribute',
'ListSnapshot',
'GetSnapshotLink',
'ListSnapshotLinks',
[
'id' => 177098,
'title' => null,
'type' => 'directory',
'children' => [
'CreateAutoSnapshotPolicy',
'CancelAutoSnapshotPolicy',
'ApplyAutoSnapshotPolicy',
'DeleteAutoSnapshotPolicy',
'ModifyAutoSnapshotPolicy',
'GetAutoSnapshotPolicy',
'ListAutoSnapshotPolicies',
'ListAutoSnapshotPolicyUnappliedDbfs',
'ListAutoSnapshotPolicyAppliedDbfs',
],
],
],
],
[
'id' => 134174,
'title' => null,
'type' => 'directory',
'children' => [
'DeleteTagsBatch',
'TagDbfs',
'AddTagsBatch',
'ListTagKeys',
'ListTagValues',
],
],
[
'id' => 134180,
'title' => null,
'type' => 'directory',
'children' => [
'CreateServiceLinkedRole',
'GetServiceLinkedRole',
],
],
[
'id' => 169510,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeDbfsSpecifications',
'DescribeInstanceTypes',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '15800',
'abilityTreeNodes' => [
'FEATUREdbfsUCP4CQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FsName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testdbfs-001',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'standard',
],
],
[
'name' => 'SizeG',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '20',
'example' => '200',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-i',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 's-y2vZ3********vvMilZ2hQ',
],
],
[
'name' => 'DeleteSnapshot',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'PerformanceLevel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PL1',
'default' => 'PL1',
],
],
[
'name' => 'EnableRaid',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'RaidStripeUnitNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '0',
'example' => '',
'default' => '0',
],
],
[
'name' => 'KMSKeyId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0e478b7a-4262-4802-b8cb-00d3fb40826X',
],
],
[
'name' => 'Encryption',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'UsedScene',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PostgreSQL',
],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dbfs.small',
],
],
[
'name' => 'AdvancedFeatures',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'FsId' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidCategory.DBFS',
'errorMessage' => 'The category is not supported.',
],
[
'errorCode' => 'InvalidName.DBFS',
'errorMessage' => 'Invalid DBFS instance name.',
],
[
'errorCode' => 'InvalidPerformanceLevel.DBFS',
'errorMessage' => 'The performance level is not supported.',
],
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'InvalidSize.DBFS',
'errorMessage' => 'The size of DBFS is invalid.',
],
[
'errorCode' => 'InvalidZone.DBFS',
'errorMessage' => 'The zone is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.Snapshot',
'errorMessage' => 'The snapshot does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"FsId\\": \\"dbfs-GOrr********Yd0VLOyBpg\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n dbfs-GOrr********Yd0VLOyBpg\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDbfs' => [
'summary' => '修改DBFS实例,包括使用场景、实例规格等。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '150809',
'abilityTreeNodes' => [
'FEATUREdbfsS28E99',
'FEATUREdbfsQMJ6C8',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
],
[
'name' => 'UsedScene',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'MySQL 5.7',
],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dbfs.medium',
'enum' => [
'dbfs.small',
'dbfs.medium',
'dbfs.large',
],
],
],
[
'name' => 'AdvancedFeatures',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'title' => 'AccessDeniedDetail',
'type' => 'object',
'properties' => [
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'InvalidStatus.DBFS',
'errorMessage' => 'The current state of the DBFS instance does not support this operation.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'DeleteDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '15803',
'abilityTreeNodes' => [
'FEATUREdbfs3MBLW2',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd-bp131n0q38u3a4zi*****',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => [
'title' => '是否强制删除。',
'description' => '是否强制删除数据库文件系统。'."\n"
.'默认值:false。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'InvalidStatus.DBFS',
'errorMessage' => 'The current state of the DBFS instance does not support this operation.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AttachDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ECSInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'i-bp1ecr********5go2go',
],
],
[
'name' => 'ServerUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dbfs-pkg-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dbfs-v0WvA********tVEVcgJLg',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'AttachMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'create_new_mount_point',
],
],
[
'name' => 'AttachPoint',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '/mnt/dbfs/dbfs-001',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.ECS',
'errorMessage' => 'The ECS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'title' => 'AttachDbfs',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DetachDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd-bp131n0q38u3a4zi*****',
],
],
[
'name' => 'ECSInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'i-bp67acfmxazb4ph***',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.ECS',
'errorMessage' => 'The ECS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'title' => 'DetachDbfs',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RenameDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '15818',
'abilityTreeNodes' => [
'FEATUREdbfs3HYCOJ',
],
],
'parameters' => [
[
'name' => 'FsName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'NewDbfsName',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidName.DBFS',
'errorMessage' => 'Invalid DBFS instance name.',
],
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AE8A242-E12D-55AC-A75D-F707020AD0D6\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => 'RenameDbfs',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResizeDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
],
[
'name' => 'NewSizeG',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '20',
'example' => '40',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'InvalidSize.DBFS',
'errorMessage' => 'The size of DBFS is invalid.',
],
[
'errorCode' => 'InvalidStatus.DBFS',
'errorMessage' => 'The current state of the DBFS instance does not support this operation.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDbfs' => [
'summary' => '查询DBFS列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdbfsUCP4CQ',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '999999',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '10',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'SortKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'SizeG',
],
],
[
'name' => 'SortType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'desc',
],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FsName',
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dbfs-test-01',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '32',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DBFSInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'attached',
],
'Encryption' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'PayType' => [
'description' => '',
'type' => 'string',
'example' => 'postpaid',
],
'FsId' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
'Tags' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagValue' => [
'description' => '',
'type' => 'string',
'example' => 'TestTagValue1',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TagKey' => [
'description' => '',
'type' => 'string',
'example' => 'TestTagKey1',
],
],
],
],
'SizeG' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'EcsList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EcsId' => [
'description' => '',
'type' => 'string',
'example' => 'i-y2vZ3********vvMilZ2hQ',
],
],
],
],
'EbsList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EbsId' => [
'description' => '',
'type' => 'string',
'example' => 'd-bp1383******3uir001r',
],
'SizeG' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
],
],
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'DBFSClusterId' => [
'description' => '',
'type' => 'string',
'example' => 'c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-i',
],
'FsName' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-test-01',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'standard',
],
'CreatedTime' => [
'description' => '',
'type' => 'string',
'example' => '1609330367000',
],
'AttachNodeNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'KMSKeyId' => [
'description' => '',
'type' => 'string',
'example' => '0e478b7a-4262-4802-b8cb-00d3fb408***',
],
'PerformanceLevel' => [
'description' => '',
'type' => 'string',
'example' => 'PL1',
],
'UsedScene' => [
'description' => '',
'type' => 'string',
'example' => 'MySQL 5.7',
],
'LastMountTime' => [
'description' => '',
'type' => 'string',
'example' => '1644915400000',
],
'LastUmountTime' => [
'description' => '',
'type' => 'string',
'example' => '1644915319000',
],
'EnableRaid' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'RaidStrip' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'InstanceType' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs.small',
],
'LastFailed' => [
'description' => '',
'type' => 'string',
'example' => 'TargetIsBusy.DBFS',
],
'SnapshotInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'SnapshotCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '50331648',
],
'LinkId' => [
'description' => '',
'type' => 'string',
'example' => 'sl-b3zlgraysgcs9jy*******',
],
'PolicyId' => [
'description' => '',
'type' => 'string',
'example' => 'sp-ehuhzlfetb2jiwz*******',
],
],
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 32,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PageNumber\\": 1,\\n \\"DBFSInfo\\": [\\n {\\n \\"Status\\": \\"attached\\",\\n \\"Encryption\\": false,\\n \\"PayType\\": \\"postpaid\\",\\n \\"FsId\\": \\"dbfs-GOrr********Yd0VLOyBpg\\",\\n \\"Tags\\": [\\n {\\n \\"TagValue\\": \\"TestTagValue1\\",\\n \\"Id\\": 1,\\n \\"TagKey\\": \\"TestTagKey1\\"\\n }\\n ],\\n \\"SizeG\\": 20,\\n \\"EcsList\\": [\\n {\\n \\"EcsId\\": \\"i-y2vZ3********vvMilZ2hQ\\"\\n }\\n ],\\n \\"EbsList\\": [\\n {\\n \\"EbsId\\": \\"d-bp1383******3uir001r\\",\\n \\"SizeG\\": 20\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBFSClusterId\\": \\"c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"FsName\\": \\"dbfs-test-01\\",\\n \\"Category\\": \\"standard\\",\\n \\"CreatedTime\\": \\"1609330367000\\",\\n \\"AttachNodeNumber\\": 1,\\n \\"KMSKeyId\\": \\"0e478b7a-4262-4802-b8cb-00d3fb408***\\",\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"UsedScene\\": \\"MySQL 5.7\\",\\n \\"LastMountTime\\": \\"1644915400000\\",\\n \\"LastUmountTime\\": \\"1644915319000\\",\\n \\"EnableRaid\\": false,\\n \\"RaidStrip\\": 2,\\n \\"InstanceType\\": \\"dbfs.small\\",\\n \\"LastFailed\\": \\"TargetIsBusy.DBFS\\",\\n \\"SnapshotInfo\\": {\\n \\"SnapshotCount\\": 1,\\n \\"TotalSize\\": 50331648,\\n \\"LinkId\\": \\"sl-b3zlgraysgcs9jy*******\\",\\n \\"PolicyId\\": \\"sp-ehuhzlfetb2jiwz*******\\"\\n }\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"32\\n473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n10\\n1\\n\\n attached\\n TargetIsBusy.DBFS\\n 0e478b7a-4262-4802-b8cb-00d3fb408***\\n 1609330367000\\n standard\\n false\\n cn-hangzhou-i\\n 20\\n PL1\\n c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD\\n dbfs-GOrr********Yd0VLOyBpg\\n 1644915319000\\n postpaid\\n false\\n dbfs-test-01\\n MySQL 5.7\\n 2\\n 1644915400000\\n 1\\n cn-hangzhou\\n dbfs.small\\n \\n i-y2vZ3********vvMilZ2hQ\\n \\n \\n 20\\n d-bp1383******3uir001r\\n \\n \\n TestTagKey1\\n 1\\n TestTagValue1\\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'DBFSInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'attached',
],
'PayType' => [
'description' => '',
'type' => 'string',
'example' => 'postpaid',
],
'FsId' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
'Tags' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagValue' => [
'description' => '',
'type' => 'string',
'example' => 'TestTagValue1',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TagKey' => [
'description' => '',
'type' => 'string',
'example' => 'TestTagKey1',
],
],
],
],
'SizeG' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'EcsList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EcsId' => [
'description' => '',
'type' => 'string',
'example' => 'i-y2vZ3********vvMilZ2hQ',
],
],
],
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'DBFSClusterId' => [
'description' => '',
'type' => 'string',
'example' => 'c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'desc',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-i',
],
'FsName' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-test-01',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'standard',
],
'CreatedTime' => [
'description' => '',
'type' => 'string',
'example' => '1609330367000',
],
'AttachNodeNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'KMSKeyId' => [
'description' => '',
'type' => 'string',
'example' => 'c39EcDBf-2Ecb-C3C6-6526-018d4D******',
],
'Encryption' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'PerformanceLevel' => [
'description' => '',
'type' => 'string',
'example' => 'PL1',
],
'UsedScene' => [
'description' => '',
'type' => 'string',
'example' => 'MySQL 5.7',
],
'LastMountTime' => [
'description' => '',
'type' => 'string',
'example' => '1644915400000',
],
'LastUmountTime' => [
'description' => '',
'type' => 'string',
'example' => '1644915319000',
],
'EnableRaid' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'InstanceType' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs.small',
],
'RaidStrip' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'EbsList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EbsId' => [
'description' => '',
'type' => 'string',
'example' => 'd-bp1hq4******qi7gy1th',
],
'SizeG' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
],
],
],
'LastFailed' => [
'description' => '',
'type' => 'string',
'example' => 'TargetIsBusy.DBFS',
],
'SnapshotInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'SnapshotCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'LinkId' => [
'description' => '',
'type' => 'string',
'example' => 'sl-9zskwvgoqqqvzxa*******',
],
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '50331648',
],
'PolicyId' => [
'description' => '',
'type' => 'string',
'example' => 'sp-ehuhzlfetb2jiwz*******',
],
],
],
'AdvancedFeatures' => [
'type' => 'string',
],
'SnapshotId' => [
'type' => 'string',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.(EntityNotExist.DBFS)',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"DBFSInfo\\": {\\n \\"Status\\": \\"attached\\",\\n \\"PayType\\": \\"postpaid\\",\\n \\"FsId\\": \\"dbfs-GOrr********Yd0VLOyBpg\\",\\n \\"Tags\\": [\\n {\\n \\"TagValue\\": \\"TestTagValue1\\",\\n \\"Id\\": 1,\\n \\"TagKey\\": \\"TestTagKey1\\"\\n }\\n ],\\n \\"SizeG\\": 20,\\n \\"EcsList\\": [\\n {\\n \\"EcsId\\": \\"i-y2vZ3********vvMilZ2hQ\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBFSClusterId\\": \\"c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD\\",\\n \\"Description\\": \\"desc\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"FsName\\": \\"dbfs-test-01\\",\\n \\"Category\\": \\"standard\\",\\n \\"CreatedTime\\": \\"1609330367000\\",\\n \\"AttachNodeNumber\\": 1,\\n \\"KMSKeyId\\": \\"c39EcDBf-2Ecb-C3C6-6526-018d4D******\\",\\n \\"Encryption\\": false,\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"UsedScene\\": \\"MySQL 5.7\\",\\n \\"LastMountTime\\": \\"1644915400000\\",\\n \\"LastUmountTime\\": \\"1644915319000\\",\\n \\"EnableRaid\\": false,\\n \\"InstanceType\\": \\"dbfs.small\\",\\n \\"RaidStrip\\": 2,\\n \\"EbsList\\": [\\n {\\n \\"EbsId\\": \\"d-bp1hq4******qi7gy1th\\",\\n \\"SizeG\\": 20\\n }\\n ],\\n \\"LastFailed\\": \\"TargetIsBusy.DBFS\\",\\n \\"SnapshotInfo\\": {\\n \\"SnapshotCount\\": 1,\\n \\"LinkId\\": \\"sl-9zskwvgoqqqvzxa*******\\",\\n \\"TotalSize\\": 50331648,\\n \\"PolicyId\\": \\"sp-ehuhzlfetb2jiwz*******\\"\\n },\\n \\"AdvancedFeatures\\": \\"{\\\\\\"cpuCoreCount\\\\\\":0.5,\\\\\\"memorySize\\\\\\":512,\\\\\\"pageCacheSize\\\\\\":128}\\",\\n \\"SnapshotId\\": \\"s-uvwtoxcjj6xtlua*******\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n\\n attached\\n TargetIsBusy.DBFS\\n c39EcDBf-2Ecb-C3C6-6526-018d4D******\\n 1609330367000\\n standard\\n desc\\n false\\n cn-hangzhou-i\\n 20\\n PL1\\n c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD\\n dbfs-GOrr********Yd0VLOyBpg\\n 1644915319000\\n false\\n postpaid\\n dbfs-test-01\\n MySQL 5.7\\n 2\\n 1644915400000\\n 1\\n cn-hangzhou\\n dbfs.small\\n \\n i-y2vZ3********vvMilZ2hQ\\n \\n \\n 20\\n d-bp1hq4******qi7gy1th\\n \\n \\n TestTagKey1\\n 1\\n TestTagValue1\\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDbfsAttachableEcsInstances' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'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' => '100',
],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'InstanceName',
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'autotest1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '3724CFEF-02DA-578B-AED6-67EE80671B4A',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '32',
],
'EcsLabelInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'value' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp10jb8mqajkmrejgo00',
],
'label' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-test-01',
],
'InstanceTypeFamily' => [
'description' => '',
'type' => 'string',
'example' => 'ecs.g7se',
],
'OSName' => [
'description' => '',
'type' => 'string',
'example' => 'Alibaba Cloud Linux 2.1903 LTS 64 bit',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Running',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-i',
],
'ImageId' => [
'description' => '',
'type' => 'string',
'example' => 'm-bp67acfmxazb4p****',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3724CFEF-02DA-578B-AED6-67EE80671B4A\\",\\n \\"TotalCount\\": 32,\\n \\"EcsLabelInfo\\": [\\n {\\n \\"value\\": \\"i-bp10jb8mqajkmrejgo00\\",\\n \\"label\\": \\"dbfs-test-01\\",\\n \\"InstanceTypeFamily\\": \\"ecs.g7se\\",\\n \\"OSName\\": \\"Alibaba Cloud Linux 2.1903 LTS 64 bit\\",\\n \\"Status\\": \\"Running\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ImageId\\": \\"m-bp67acfmxazb4p****\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ListDbfsAttachedEcsInstances' => [
'summary' => '查询数据库文件系统被挂载的ECS实例列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dbfs-nUy1tb********BQ4X8Gpw',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'EcsLabelInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MountPoint' => [
'description' => '',
'type' => 'string',
'example' => '/mnt/dbfs/dbfs-nUy1tb********BQ4X8Gpw',
],
'value' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp10jb8mqajkmrejgo00',
],
'label' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-test-01',
],
'MountedTime' => [
'description' => '',
'type' => 'string',
'example' => '1606290930000',
],
'InstanceTypeFamily' => [
'description' => '',
'type' => 'string',
'example' => 'ecs.g7se',
],
'OSName' => [
'description' => '',
'type' => 'string',
'example' => 'Alibaba Cloud Linux 2.1903 LTS 64 bit',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"EcsLabelInfo\\": [\\n {\\n \\"MountPoint\\": \\"/mnt/dbfs/dbfs-nUy1tb********BQ4X8Gpw\\",\\n \\"value\\": \\"i-bp10jb8mqajkmrejgo00\\",\\n \\"label\\": \\"dbfs-test-01\\",\\n \\"MountedTime\\": \\"1606290930000\\",\\n \\"InstanceTypeFamily\\": \\"ecs.g7se\\",\\n \\"OSName\\": \\"Alibaba Cloud Linux 2.1903 LTS 64 bit\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n\\n /mnt/dbfs/dbfs-nUy1tb********BQ4X8Gpw\\n ecs.g7se\\n Alibaba Cloud Linux 2.1903 LTS 64 bit\\n 1606290930000\\n \\n i-bp10jb8mqajkmrejgo00\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateSnapshot' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd-bp131n0q38u3a4zi*****',
],
],
[
'name' => 'SnapshotName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'testSnapshotName',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'testDescription',
],
],
[
'name' => 'RetentionDays',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '36500',
'minimum' => '-1',
'example' => '30',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SnapshotId' => [
'description' => '',
'type' => 'string',
'example' => 's-Q2greuDZTvWeS8bfKZ****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'InvalidStatus.DBFS',
'errorMessage' => 'The current state of the DBFS instance does not support this operation.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotId\\": \\"s-Q2greuDZTvWeS8bfKZ****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n s-Q2greuDZTvWeS8bfKZ****\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteSnapshot' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'ParameterEmpty.SnapshotId',
'errorMessage' => 'The value of snapshotId is empty.',
],
[
'errorCode' => 'ParameterExceed.SnapshotId',
'errorMessage' => 'The maximum number of snapshot ID has been reached.',
],
[
'errorCode' => 'ParameterInvalid.SnapshotId',
'errorMessage' => 'The SnapshotId parameter is invalid.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.Snapshot',
'errorMessage' => 'The snapshot does not exist.',
],
],
500 => [
[
'errorCode' => 'SnapshotCreatedDbfs',
'errorMessage' => 'A cloned DBFS exists under the current snapshot.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifySnapshotAttribute' => [
'summary' => '修改快照属性',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 's-y2vZ3********vvMilZ2hQ',
],
],
[
'name' => 'SnapshotName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'testSnapshotName',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'testDescription',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'ParameterInvalid.SnapshotDescription',
'errorMessage' => 'The SnapshotDescription parameter is invalid.',
],
[
'errorCode' => 'ParameterInvalid.SnapshotName',
'errorMessage' => 'The SnapshotName parameter is invalid.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.Snapshot',
'errorMessage' => 'The snapshot does not exist.',
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ListSnapshot' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '10240',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '200',
'minimum' => '10',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'SortKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'SnapshotSize',
],
],
[
'name' => 'SortType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'asc' => 'asc',
'desc' => 'desc',
],
'example' => 'desc',
],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'SnapshotId',
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 's-bp67acfmxazb4p****',
],
],
[
'name' => 'FsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dbfs-GOrr********Yd0VLOyBpg',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'accomplished',
],
],
[
'name' => 'SnapshotName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'testSnapshotName',
],
],
[
'name' => 'SnapshotType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'user',
],
],
[
'name' => 'SnapshotIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"]',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '32',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Snapshots' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'accomplished',
],
'CreationTime' => [
'description' => '',
'type' => 'string',
'example' => '1609330367000',
],
'Progress' => [
'description' => '',
'type' => 'string',
'example' => '100%',
],
'SourceFsSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RetentionDays' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'RemainTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '38',
],
'LastModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '1609330367000',
],
'SnapshotType' => [
'description' => '',
'type' => 'string',
'example' => 'user',
],
'SnapshotName' => [
'description' => '',
'type' => 'string',
'example' => 'testSnapshotName',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'testDescription',
],
'SourceFsId' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-bp67acfmxazb4p****',
],
'SnapshotId' => [
'description' => '',
'type' => 'string',
'example' => 's-bp67acfmxazb4p****',
],
'Category' => [
'description' => '',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'standard',
],
'SourceFsStripeWidth' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 32,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PageNumber\\": 1,\\n \\"Snapshots\\": [\\n {\\n \\"Status\\": \\"accomplished\\",\\n \\"CreationTime\\": \\"1609330367000\\",\\n \\"Progress\\": \\"100%\\",\\n \\"SourceFsSize\\": 20,\\n \\"RetentionDays\\": 30,\\n \\"RemainTime\\": 38,\\n \\"LastModifiedTime\\": \\"1609330367000\\",\\n \\"SnapshotType\\": \\"user\\",\\n \\"SnapshotName\\": \\"testSnapshotName\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SourceFsId\\": \\"dbfs-bp67acfmxazb4p****\\",\\n \\"SnapshotId\\": \\"s-bp67acfmxazb4p****\\",\\n \\"Category\\": \\"standard\\",\\n \\"SourceFsStripeWidth\\": 1\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"32\\n473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n10\\n1\\n\\n accomplished\\n \\n standard\\n testDescription\\n 30\\n 20\\n testSnapshotName\\n dbfs-bp67acfmxazb4p****\\n s-bp67acfmxazb4p****\\n 1\\n 1609330367000\\n 1609330367000\\n user\\n 38\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetSnapshotLink' => [
'summary' => '获取快照链',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'LinkId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'sl-b3zlgraysgcs9jy********',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'attached',
],
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '50331648',
],
'SourceSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'FsId' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-194j6u20sp2gisx*******',
],
'EcsList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'EcsId' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp19mogqud1w1*******',
],
],
],
],
'SnapshotCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FsName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'LinkId' => [
'description' => '',
'type' => 'string',
'example' => 'sl-b3zlgraysgcs9jy*******',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'standard',
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
403 => [
[
'errorCode' => 'PermissionDeny.SnapshotLink',
'errorMessage' => 'The account has no permission on this snapshot link.',
],
],
[
[
'errorCode' => 'SnapshotLinkNotFound',
'errorMessage' => 'The snapshot link does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Status\\": \\"attached\\",\\n \\"TotalSize\\": 50331648,\\n \\"SourceSize\\": 20,\\n \\"FsId\\": \\"dbfs-194j6u20sp2gisx*******\\",\\n \\"EcsList\\": [\\n {\\n \\"EcsId\\": \\"i-bp19mogqud1w1*******\\"\\n }\\n ],\\n \\"SnapshotCount\\": 1,\\n \\"FsName\\": \\"test\\",\\n \\"LinkId\\": \\"sl-b3zlgraysgcs9jy*******\\",\\n \\"Category\\": \\"standard\\"\\n },\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ListSnapshotLinks' => [
'summary' => '列出快照链',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '159557',
'abilityTreeNodes' => [
'FEATUREdbfs3RTJEH',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '999999',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '200',
'minimum' => '10',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FsId',
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dbfs-kwziq4dpsle********',
],
],
[
'name' => 'FsIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '["dbfs-kwziq4dpsle********","dbfs-vuaqvfcjqsg********"]',
],
],
[
'name' => 'LinkIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '["sl-bp1grgphbcc9brb5****","sl-bp1c4izumvq0i5bs****","sl-bp1akk7isz866dds****"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SnapshotLinks' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'attached',
],
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => ' '."\n"
.'50331648',
],
'SourceSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'FsId' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs-q7qsgyqptjk******',
],
'EcsList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'EcsId' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp1f4eo2biro*******',
],
],
],
],
'SnapshotCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FsName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'LinkId' => [
'description' => '',
'type' => 'string',
'example' => 'sl-b3zlgraysgcs9jy*******',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PageNumber\\": 1,\\n \\"SnapshotLinks\\": [\\n {\\n \\"Status\\": \\"attached\\",\\n \\"TotalSize\\": 50331648,\\n \\"SourceSize\\": 20,\\n \\"FsId\\": \\"dbfs-q7qsgyqptjk******\\",\\n \\"EcsList\\": [\\n {\\n \\"EcsId\\": \\"i-bp1f4eo2biro*******\\"\\n }\\n ],\\n \\"SnapshotCount\\": 1,\\n \\"FsName\\": \\"test\\",\\n \\"LinkId\\": \\"sl-b3zlgraysgcs9jy*******\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'CreateAutoSnapshotPolicy' => [
'summary' => '创建自动快照策略',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '150683',
'abilityTreeNodes' => [
'FEATUREdbfsOC34E7',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'title' => '自动快照策略名称',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'policyTest',
],
],
[
'name' => 'RetentionDays',
'in' => 'query',
'schema' => [
'title' => '保留天数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'deprecated' => false,
'required' => true,
'maximum' => '65536',
'minimum' => '-1',
'example' => '30',
],
],
[
'name' => 'RepeatWeekdays',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '重复星期',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '"1"',
],
'required' => true,
'maxItems' => 7,
'minItems' => 1,
],
],
[
'name' => 'TimePoints',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '重复时间',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '"01"',
],
'required' => true,
'maxItems' => 24,
'minItems' => 1,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'PolicyId' => [
'description' => '',
'type' => 'string',
'example' => 'sp-z5siir3iq3m**********',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterInvalid.RetentionDays',
'errorMessage' => 'The RetentionDays parameter is invalid.',
],
[
'errorCode' => 'ParameterInvalid.RepeatWeekDays',
'errorMessage' => 'The RepeatWeekdays parameter is invalid.',
],
[
'errorCode' => 'ParameterInvalid.TimePoints',
'errorMessage' => 'The TimePoints parameter is invalid.',
],
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'ParameterInvalid.PolicyName',
'errorMessage' => 'The PolicyName parameter is invalid.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PolicyId\\": \\"sp-z5siir3iq3m**********\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'CancelAutoSnapshotPolicy' => [
'summary' => '取消自动快照策略',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => [
'title' => '策略ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sp-z5siir3iq3m**********',
],
],
[
'name' => 'DbfsIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '"dbfs-1luaxt4vs1iusrd*******"',
],
'required' => true,
'minItems' => 1,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DbfsWithAutoSnapshotPolicy.NotFound',
'errorMessage' => 'Dbfs cancel failed.The specified dbfs does not apply this auto snapshot policy or does not exist.',
],
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'ParameterEmpty.PolicyId',
'errorMessage' => 'The value of policyId is empty.',
],
],
404 => [
[
'errorCode' => 'AutoSnapshotPolicyNotFound',
'errorMessage' => 'The automatic snapshot policy does not exist.',
],
],
409 => [
[
'errorCode' => 'OperationConflict',
'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
],
],
503 => [
[
'errorCode' => 'AutoShapshotBusy',
'errorMessage' => 'The server is busy now, please try again later.',
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ApplyAutoSnapshotPolicy' => [
'summary' => '设置自动快照策略',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => [
'title' => '策略ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sp-z5siir3iq3m**********',
],
],
[
'name' => 'DbfsIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '"dbfs-1luaxt4vs1iusrd*******"',
],
'required' => true,
'minItems' => 1,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterInvalid.DbfsIds',
'errorMessage' => 'The DbfsIds parameter is invalid.',
],
[
'errorCode' => 'ParameterEmpty.PolicyId',
'errorMessage' => 'The value of policyId is empty.',
],
[
'errorCode' => 'DbfsAlreadyAppliedAutoSnapshotPolicy',
'errorMessage' => 'An automatic snapshot policy has been applied on the specified dbfs.',
],
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
[
[
'errorCode' => 'PermissionDeny.Policy',
'errorMessage' => 'The account has no permission on this policy.',
],
[
'errorCode' => 'PermissionDeny.DBFS',
'errorMessage' => 'The account has no permission on this DBFS.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
[
'errorCode' => 'AutoSnapshotPolicyNotFound',
'errorMessage' => 'The automatic snapshot policy does not exist.',
],
],
409 => [
[
'errorCode' => 'OperationConflict',
'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
],
],
503 => [
[
'errorCode' => 'AutoShapshotBusy',
'errorMessage' => 'The server is busy now, please try again later.',
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'DeleteAutoSnapshotPolicy' => [
'summary' => '删除自动快照策略',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => [
'title' => '策略ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sp-z5siir3iq3m**********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC********',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterEmpty.PolicyId',
'errorMessage' => 'The value of policyId is empty.',
],
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
[
[
'errorCode' => 'PermissionDeny.Policy',
'errorMessage' => 'The account has no permission on this policy.',
],
],
404 => [
[
'errorCode' => 'AutoSnapshotPolicyNotFound',
'errorMessage' => 'The automatic snapshot policy does not exist.',
],
],
409 => [
[
'errorCode' => 'OperationConflict',
'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
],
],
503 => [
[
'errorCode' => 'AutoShapshotBusy',
'errorMessage' => 'The server is busy now, please try again later.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC********\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ModifyAutoSnapshotPolicy' => [
'summary' => '修改自动快照策略',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => [
'title' => '策略ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sp-z5siir3iq3m**********',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'title' => '策略名称',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'policyTest',
],
],
[
'name' => 'RetentionDays',
'in' => 'query',
'schema' => [
'title' => '保留天数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '65536',
'minimum' => '-1',
'example' => '30',
],
],
[
'name' => 'RepeatWeekdays',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '"1"',
],
'required' => false,
'maxItems' => 7,
],
],
[
'name' => 'TimePoints',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '"01"',
],
'required' => false,
'maxItems' => 24,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterInvalid.RetentionDays',
'errorMessage' => 'The RetentionDays parameter is invalid.',
],
[
'errorCode' => 'ParameterInvalid.RepeatWeekDays',
'errorMessage' => 'The RepeatWeekdays parameter is invalid.',
],
[
'errorCode' => 'ParameterInvalid.TimePoints',
'errorMessage' => 'The TimePoints parameter is invalid.',
],
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
[
'errorCode' => 'ParameterEmpty.PolicyId',
'errorMessage' => 'The value of policyId is empty.',
],
[
'errorCode' => 'ParameterInvalid.PolicyName',
'errorMessage' => 'The PolicyName parameter is invalid.',
],
],
[
[
'errorCode' => 'PermissionDeny.Policy',
'errorMessage' => 'The account has no permission on this policy.',
],
],
404 => [
[
'errorCode' => 'AutoSnapshotPolicyNotFound',
'errorMessage' => 'The automatic snapshot policy does not exist.',
],
],
409 => [
[
'errorCode' => 'OperationConflict',
'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
],
],
503 => [
[
'errorCode' => 'AutoShapshotBusy',
'errorMessage' => 'The server is busy now, please try again later.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'GetAutoSnapshotPolicy' => [
'summary' => '查询某条自动快照策略',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => [
'title' => '策略ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sp-z5siir3iq3m**********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => '',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PolicyId' => [
'title' => '策略ID',
'description' => '',
'type' => 'string',
'example' => 'sp-z5siir3iq3m**********',
],
'PolicyName' => [
'title' => '自动快照策略名称',
'description' => '',
'type' => 'string',
'example' => 'PolicyTest',
],
'AccountId' => [
'title' => '账户ID',
'description' => '',
'type' => 'string',
'example' => '13523459********',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'Status' => [
'title' => '策略状态',
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
'StatusDetail' => [
'description' => '',
'type' => 'string',
'example' => '-',
],
'RetentionDays' => [
'title' => '快照保留天数(1-65535,NULL为永久保存)',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'AppliedDbfsNumber' => [
'title' => '设置的dbfs数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RepeatWeekdays' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '"1"',
],
],
'TimePoints' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '"01"',
],
],
'CreatedTime' => [
'description' => '',
'type' => 'string',
'example' => '1670998784000',
],
'LastModified' => [
'description' => '',
'type' => 'string',
'example' => '1670998784000',
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
[
[
'errorCode' => 'PermissionDeny.Policy',
'errorMessage' => 'The account has no permission on this policy.',
],
],
404 => [
[
'errorCode' => 'AutoSnapshotPolicyNotFound',
'errorMessage' => 'The automatic snapshot policy does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PolicyId\\": \\"sp-z5siir3iq3m**********\\",\\n \\"PolicyName\\": \\"PolicyTest\\",\\n \\"AccountId\\": \\"13523459********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"Normal\\",\\n \\"StatusDetail\\": \\"-\\",\\n \\"RetentionDays\\": 30,\\n \\"AppliedDbfsNumber\\": 1,\\n \\"RepeatWeekdays\\": [\\n \\"\\\\\\"1\\\\\\"\\"\\n ],\\n \\"TimePoints\\": [\\n \\"\\\\\\"01\\\\\\"\\"\\n ],\\n \\"CreatedTime\\": \\"1670998784000\\",\\n \\"LastModified\\": \\"1670998784000\\"\\n },\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ListAutoSnapshotPolicies' => [
'summary' => '列出自动快照策略',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdbfsOC34E7',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '999999',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '200',
'minimum' => '10',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PolicyName',
'enum' => [
'PolicyId',
'PolicyName',
],
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'policyTest',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse>',
'description' => '',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'SnapshotPolicies' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'PolicyId' => [
'title' => '策略ID',
'description' => '',
'type' => 'string',
'example' => 'sp-z5siir3iq3m**********'."\n",
],
'PolicyName' => [
'title' => '自动快照策略名称',
'description' => '',
'type' => 'string',
'example' => 'policyTest',
],
'AccountId' => [
'title' => '账户ID',
'description' => '',
'type' => 'string',
'example' => '13523459********',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'Status' => [
'title' => '策略状态',
'description' => '',
'type' => 'string',
'enumValueTitles' => [
'normal' => 'normal',
'abnormal' => 'abnormal',
],
'example' => '',
],
'StatusDetail' => [
'description' => '',
'type' => 'string',
'example' => '-',
],
'RetentionDays' => [
'title' => '快照保留天数(1-65535,NULL为永久保存)',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'AppliedDbfsNumber' => [
'title' => '设置的dbfs数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RepeatWeekdays' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '"1"',
],
],
'TimePoints' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => ' "01"',
],
],
'CreatedTime' => [
'description' => '',
'type' => 'string',
'example' => '1670998784000',
],
'LastModified' => [
'description' => '',
'type' => 'string',
'example' => '1670998784000',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidRegionId.NotFound',
'errorMessage' => 'The specified RegionId does not exist.',
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SnapshotPolicies\\": [\\n {\\n \\"PolicyId\\": \\"sp-z5siir3iq3m**********\\\\n\\",\\n \\"PolicyName\\": \\"policyTest\\",\\n \\"AccountId\\": \\"13523459********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"normal\\",\\n \\"StatusDetail\\": \\"-\\",\\n \\"RetentionDays\\": 30,\\n \\"AppliedDbfsNumber\\": 1,\\n \\"RepeatWeekdays\\": [\\n \\"\\\\\\"1\\\\\\"\\"\\n ],\\n \\"TimePoints\\": [\\n \\" \\\\\\"01\\\\\\"\\"\\n ],\\n \\"CreatedTime\\": \\"1670998784000\\",\\n \\"LastModified\\": \\"1670998784000\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ListAutoSnapshotPolicyUnappliedDbfs' => [
'summary' => '列出未设置自动快照策略的DBFS',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdbfsOC34E7',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '999999',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '200',
'minimum' => '10',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FsName',
'enum' => [
'FsId',
'FsName',
],
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DBFS1',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'PlainResponse>',
'description' => '',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'DbfsList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'FsId' => [
'title' => 'DBFS实例ID',
'description' => '',
'type' => 'string',
'example' => 'dbfs-ejdvesb0qvuywvg*******',
],
'FsName' => [
'title' => 'DBFS实例名称',
'description' => '',
'type' => 'string',
'example' => 'test',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'attached',
],
'SizeG' => [
'title' => '容量(GB)',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'SnapshotCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '50331648',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidRegionId.NotFound',
'errorMessage' => 'The specified RegionId does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"DbfsList\\": [\\n {\\n \\"FsId\\": \\"dbfs-ejdvesb0qvuywvg*******\\",\\n \\"FsName\\": \\"test\\",\\n \\"Status\\": \\"attached\\",\\n \\"SizeG\\": 20,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SnapshotCount\\": 1,\\n \\"TotalSize\\": 50331648\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ListAutoSnapshotPolicyAppliedDbfs' => [
'summary' => '列出已设置自动快照策略的DBFS',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sp-z5siir3iq3m**********',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '999999',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '200',
'minimum' => '10',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FsName',
'enum' => [
'FsId',
'FsName',
],
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DBFS1',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'PlainResponse>',
'description' => '',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'DbfsList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'FsId' => [
'title' => 'DBFS实例ID',
'description' => '',
'type' => 'string',
'example' => 'dbfs-ejdvesb0qvuywvg*******',
],
'FsName' => [
'title' => 'DBFS实例名称',
'description' => '',
'type' => 'string',
'example' => 'test',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'attached',
],
'SizeG' => [
'title' => '容量(GB)',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'SnapshotCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '50331648',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterEmpty.PolicyId',
'errorMessage' => 'The value of policyId is empty.',
],
],
[
[
'errorCode' => 'PermissionDeny.Policy',
'errorMessage' => 'The account has no permission on this policy.',
],
],
404 => [
[
'errorCode' => 'InvalidRegionId.NotFound',
'errorMessage' => 'The specified RegionId does not exist.',
],
[
'errorCode' => 'AutoSnapshotPolicyNotFound',
'errorMessage' => 'The automatic snapshot policy does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"DbfsList\\": [\\n {\\n \\"FsId\\": \\"dbfs-ejdvesb0qvuywvg*******\\",\\n \\"FsName\\": \\"test\\",\\n \\"Status\\": \\"attached\\",\\n \\"SizeG\\": 20,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SnapshotCount\\": 1,\\n \\"TotalSize\\": 50331648\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'DeleteTagsBatch' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '15805',
'abilityTreeNodes' => [
'FEATUREdbfsQMJ6C8',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DbfsList',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["dbfs-nUy1tb********BQ4X8Gpw","dbfs-v0WvA********tVEVcgJLg"]',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'title' => 'DeleteTagsBatch',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TagDbfs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '15821',
'abilityTreeNodes' => [
'FEATUREdbfsQMJ6C8',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DbfsId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dbfs-nUy1tb********BQ4X8Gpw',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'title' => 'TagDbfs',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddTagsBatch' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '15798',
'abilityTreeNodes' => [
'FEATUREdbfsQMJ6C8',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DbfsList',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["dbfs-nUy1tb********BQ4X8Gpw","dbfs-v0WvA********tVEVcgJLg"]',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
404 => [
[
'errorCode' => 'EntityNotExist.DBFS',
'errorMessage' => 'The DBFS instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'title' => 'AddTagsBatch',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTagKeys' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'TagKeys' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '["key1", "key2"]',
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TagKeys\\": [\\n \\"[\\\\\\"key1\\\\\\", \\\\\\"key2\\\\\\"]\\"\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n key1\\n key2\\n","errorExample":""}]',
'title' => 'ListTagKeys',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTagValues' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'TagKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'tagKey1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'TagValues' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '["tagValue1", "tagValue2"]',
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TagValues\\": [\\n \\"[\\\\\\"tagValue1\\\\\\", \\\\\\"tagValue2\\\\\\"]\\"\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n tagValue1\\n tagValue2\\n","errorExample":""}]',
'title' => 'ListTagValues',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateServiceLinkedRole' => [
'summary' => '创建DBFS服务关联角色',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '15801',
'abilityTreeNodes' => [
'FEATUREdbfsUCP4CQ',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'AutoCreateServiceLinkedRole',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'title' => 'CreateServiceLinkedRole',
],
'GetServiceLinkedRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '15808',
'abilityTreeNodes' => [
'FEATUREdbfs29ABXP',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '',
'type' => 'string',
'example' => '1352345930******',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'DbfsLinkedRole' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
403 => [
[
'errorCode' => 'PermissionDeny.DBFS',
'errorMessage' => 'RAM permission verification failed.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccountId\\": \\"1352345930******\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"DbfsLinkedRole\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1352345930******\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n true\\n cn-hangzhou\\n","errorExample":""}]',
'title' => 'GetServiceLinkedRole',
],
'DescribeDbfsSpecifications' => [
'summary' => '查询DBFS支持的ECS实例类型,根据ECS实例规格返回ECS可挂载的最大DBFS数量',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdbfs9JXLXY',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'EcsInstanceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ecs.g7se',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'enterprise',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'SupportedEcsInstanceTypeFamily' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '["ecs.g7se","ecs.r7se","ecs.c7se"]',
],
],
'MaxDbfsNumberPerEcs' => [
'description' => '',
'type' => 'object',
'example' => '4',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"187BCB3B-12E6-58B0-8E71-E19A895F49EF\\",\\n \\"SupportedEcsInstanceTypeFamily\\": [\\n \\"[\\\\\\"ecs.g7se\\\\\\",\\\\\\"ecs.r7se\\\\\\",\\\\\\"ecs.c7se\\\\\\"]\\"\\n ],\\n \\"MaxDbfsNumberPerEcs\\": {\\n \\"enterprise\\": 4\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribeDbfsSpecifications',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeInstanceTypes' => [
'summary' => '查询DBFS实例规格',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdbfs29ABXP',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
'title' => '地域ID',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
'title' => 'Id of the request',
],
'InstanceTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceTypeId' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs.small',
],
'CpuCoreCount' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '0.25',
],
'MemorySize' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '0.5',
],
'InstanceTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => 'dbfs.small',
],
],
],
'title' => 'Array of InstanceType',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'PolicyType' => [
'title' => 'PolicyType',
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'title' => 'AuthPrincipalOwnerId',
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'title' => 'EncodedDiagnosticMessage',
'type' => 'string',
],
'AuthPrincipalType' => [
'title' => 'AuthPrincipalType',
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'title' => 'AuthPrincipalDisplayName',
'type' => 'string',
],
'NoPermissionType' => [
'title' => 'NoPermissionType',
'type' => 'string',
],
'AuthAction' => [
'title' => 'AuthAction',
'type' => 'string',
],
],
],
],
'title' => 'Schema of Response',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidRegion.DBFS',
'errorMessage' => 'The region is not supported.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"InstanceTypes\\": [\\n {\\n \\"InstanceTypeId\\": \\"dbfs.small\\",\\n \\"CpuCoreCount\\": 0.25,\\n \\"MemorySize\\": 0.5,\\n \\"InstanceTypeDescription\\": \\"dbfs.small\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"PolicyType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"AuthAction\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribeInstanceTypes',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
],
'endpoints' => [
[
'regionId' => 'cn-beijing',
'endpoint' => 'dbfs.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'dbfs.cn-zhangjiakou.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'dbfs.cn-huhehaote.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'dbfs.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'dbfs.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'dbfs.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'dbfs.cn-chengdu.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'dbfs.cn-hongkong.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'dbfs.ap-southeast-1.aliyuncs.com',
],
],
];