summaryrefslogtreecommitdiff
path: root/data/en_us/dbfs
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/dbfs
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/dbfs')
-rw-r--r--data/en_us/dbfs/2020-04-18/api-docs.php8690
1 files changed, 3946 insertions, 4744 deletions
diff --git a/data/en_us/dbfs/2020-04-18/api-docs.php b/data/en_us/dbfs/2020-04-18/api-docs.php
index bd94531..852f825 100644
--- a/data/en_us/dbfs/2020-04-18/api-docs.php
+++ b/data/en_us/dbfs/2020-04-18/api-docs.php
@@ -1,102 +1,49 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'DBFS',
- 'version' => '2020-04-18',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'DBFS', 'version' => '2020-04-18'],
'directories' => [
[
- 'id' => 134159,
- 'title' => null,
+ 'children' => ['CreateDbfs', 'UpdateDbfs', 'DeleteDbfs', 'AttachDbfs', 'DetachDbfs', 'RenameDbfs', 'ResizeDbfs', 'ListDbfs', 'GetDbfs', 'ListDbfsAttachableEcsInstances', 'ListDbfsAttachedEcsInstances'],
'type' => 'directory',
- 'children' => [
- 'CreateDbfs',
- 'UpdateDbfs',
- 'DeleteDbfs',
- 'AttachDbfs',
- 'DetachDbfs',
- 'RenameDbfs',
- 'ResizeDbfs',
- 'ListDbfs',
- 'GetDbfs',
- 'ListDbfsAttachableEcsInstances',
- 'ListDbfsAttachedEcsInstances',
- ],
+ 'title' => 'Basic instance operations',
],
[
- 'id' => 134170,
- 'title' => null,
- 'type' => 'directory',
'children' => [
- 'CreateSnapshot',
- 'DeleteSnapshot',
- 'ModifySnapshotAttribute',
'ListSnapshot',
'GetSnapshotLink',
'ListSnapshotLinks',
[
- 'id' => 177098,
- 'title' => null,
+ 'children' => ['GetAutoSnapshotPolicy', 'ListAutoSnapshotPolicies', 'ListAutoSnapshotPolicyUnappliedDbfs', 'ListAutoSnapshotPolicyAppliedDbfs'],
'type' => 'directory',
- 'children' => [
- 'CreateAutoSnapshotPolicy',
- 'CancelAutoSnapshotPolicy',
- 'ApplyAutoSnapshotPolicy',
- 'DeleteAutoSnapshotPolicy',
- 'ModifyAutoSnapshotPolicy',
- 'GetAutoSnapshotPolicy',
- 'ListAutoSnapshotPolicies',
- 'ListAutoSnapshotPolicyUnappliedDbfs',
- 'ListAutoSnapshotPolicyAppliedDbfs',
- ],
+ 'title' => 'Automatic snapshot policies',
],
],
+ 'type' => 'directory',
+ 'title' => 'Snapshots',
],
[
- 'id' => 134174,
- 'title' => null,
+ 'children' => ['DeleteTagsBatch', 'TagDbfs', 'AddTagsBatch'],
'type' => 'directory',
- 'children' => [
- 'DeleteTagsBatch',
- 'TagDbfs',
- 'AddTagsBatch',
- 'ListTagKeys',
- 'ListTagValues',
- ],
+ 'title' => 'Tags',
],
[
- 'id' => 134180,
- 'title' => null,
+ 'children' => ['GetServiceLinkedRole'],
'type' => 'directory',
- 'children' => [
- 'CreateServiceLinkedRole',
- 'GetServiceLinkedRole',
- ],
+ 'title' => 'Service-linked roles',
],
[
- 'id' => 169510,
- 'title' => null,
+ 'children' => ['DescribeDbfsSpecifications', 'ApplyAutoSnapshotPolicy', 'CancelAutoSnapshotPolicy', 'CreateAutoSnapshotPolicy', 'CreateServiceLinkedRole', 'CreateSnapshot', 'DeleteAutoSnapshotPolicy', 'DeleteSnapshot', 'DescribeInstanceTypes', 'ListTagKeys', 'ListTagValues', 'ModifyAutoSnapshotPolicy', 'ModifySnapshotAttribute'],
'type' => 'directory',
- 'children' => [
- 'DescribeDbfsSpecifications',
- 'DescribeInstanceTypes',
- ],
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateDbfs' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddTagsBatch' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -105,575 +52,225 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '15800',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsUCP4CQ',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '15798',
+ 'abilityTreeNodes' => ['FEATUREdbfsQMJ6C8'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- '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',
+ 'name' => 'DbfsList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'minimum' => '20',
- 'example' => '200',
- ],
+ 'schema' => ['description' => 'A list of DBFS instances to which you want to add tags.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["dbfs-nUy1tb********BQ4X8Gpw","dbfs-v0WvA********tVEVcgJLg"]', 'title' => ''],
],
[
- 'name' => 'ZoneId',
+ 'name' => 'Tags',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-i',
- ],
+ 'schema' => ['description' => 'A list of tags to add.'."\n"
+ ."\n"
+ .'TagKey: The tag key for the resource. Maximum length is 64 characters. Valid characters include uppercase and lowercase English letters, Chinese characters, digits, and the special symbols @ \\_ - = + ; : , < . > / ?'."\n"
+ ."\n"
+ .'TagValue: The tag value for the resource. Maximum length is 128 characters. Valid characters include uppercase and lowercase English letters, Chinese characters, digits, and the special symbols @ \\_ - = + ; : , < . > / ?', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]', 'title' => ''],
],
[
'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}',
- ],
+ 'schema' => ['description' => 'Ensures request idempotence. Generate a unique value from your client for this parameter to differentiate between requests. ClientToken supports only ASCII characters and must not exceed 64 characters. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'FsId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dbfs-GOrr********Yd0VLOyBpg',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.Snapshot',
- 'errorMessage' => 'The snapshot does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
],
- '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":"<CreateDbfsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <FsId>dbfs-GOrr********Yd0VLOyBpg</FsId>\\n</CreateDbfsResponse>","errorExample":""}]',
+ '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"}]',
+ 'title' => 'Batch Set Tags ',
+ 'summary' => 'Call AddTagsBatch to add tags to multiple Database File System (DBFS) instances in a single batch operation. This operation can add new tags or replace existing tags.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UpdateDbfs' => [
- 'summary' => '修改DBFS实例，包括使用场景、实例规格等。',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:AddTagsBatch',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddTagsBatch'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ApplyAutoSnapshotPolicy' => [
+ 'summary' => 'Applies an automatic snapshot policy to one or more database file systems (DBFS).',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '150809',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsS28E99',
- 'FEATUREdbfsQMJ6C8',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'PolicyId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sp-z5siir3iq3m**********'],
],
[
- 'name' => 'FsId',
+ 'name' => 'DbfsIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A JSON array of DBFS IDs to which you want to apply the automatic snapshot policy. Separate IDs with commas. For example: \\["dbfs-1luaxt4vs1iusrd`*******`", "dbfs-cxbyu98fspcbvm`******`"].',
+ 'type' => 'array',
+ 'items' => ['description' => 'You can specify the DBFS to which you want to apply the automatic snapshot policy.', 'type' => 'string', 'required' => true, 'example' => '"dbfs-1luaxt4vs1iusrd*******"', 'title' => ''],
'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',
- ],
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'AdvancedFeatures',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'The type of policy.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'The owner ID of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'The type of authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'ParameterInvalid.DbfsIds', 'errorMessage' => 'The DbfsIds parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ParameterEmpty.PolicyId', 'errorMessage' => 'The value of policyId is empty.', 'description' => ''],
+ ['errorCode' => 'DbfsAlreadyAppliedAutoSnapshotPolicy', 'errorMessage' => 'An automatic snapshot policy has been applied on the specified dbfs.', 'description' => ''],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
- 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' => [],
+ ['errorCode' => 'PermissionDeny.Policy', 'errorMessage' => 'The account has no permission on this policy.', 'description' => ''],
+ ['errorCode' => 'PermissionDeny.DBFS', 'errorMessage' => 'The account has no permission on this DBFS.', 'description' => ''],
],
- ],
- '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',
- ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
+ ['errorCode' => 'AutoSnapshotPolicyNotFound', 'errorMessage' => 'The automatic snapshot policy does not exist.', 'description' => ''],
],
- [
- 'name' => 'FsId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp131n0q38u3a4zi*****',
- ],
+ 409 => [
+ ['errorCode' => 'OperationConflict', 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.', 'description' => ''],
],
- [
- 'name' => 'Force',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否强制删除。',
- 'description' => '是否强制删除数据库文件系统。'."\n"
- .'默认值：false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 503 => [
+ ['errorCode' => 'AutoShapshotBusy', 'errorMessage' => 'The server is busy now, please try again later.', 'description' => ''],
],
],
- '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',
- ],
- ],
- ],
+ '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"}]',
+ 'title' => 'Configure an automatic snapshot policy',
+ 'description' => '- A DBFS instance can be associated with only one automatic snapshot policy. To change the policy, you must first cancel the existing one.'."\n"
+ ."\n"
+ .'- A single automatic snapshot policy can be applied to multiple DBFS instances.'."\n"
+ ."\n"
+ .'DBFS snapshots are based on cloud disk snapshots. You are charged for these snapshots by the cloud disk service. Before you call this operation, review the [pricing details](https://help.aliyun.com/document_detail/56159.htm?spm=openapi-amp.newDocPublishment.0.0.4ada281fa5jFc7#concept-rq2-pcx-ydb) for cloud disk snapshots.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:ApplyAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
],
],
],
],
- '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.',
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyAutoSnapshotPolicy'],
],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
- '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":"<DeleteDbfsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DeleteDbfsResponse>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
'AttachDbfs' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -681,72 +278,43 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ECSInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'i-bp1ecr********5go2go',
- ],
+ 'schema' => ['description' => 'The ID of the destination ECS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-bp1ecr********5go2go', 'title' => ''],
],
[
'name' => 'ServerUrl',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dbfs-pkg-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com',
- ],
+ 'schema' => ['description' => 'The address of the DBFS package. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'dbfs-pkg-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com', 'title' => ''],
],
[
'name' => 'FsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dbfs-v0WvA********tVEVcgJLg',
- ],
+ 'schema' => ['description' => 'The ID of the database file system to attach.'."\n"
+ .'The database file system (FsId) and the ECS instance (ECSInstanceId) must be in the same zone.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-v0WvA********tVEVcgJLg', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'AttachMode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'create_new_mount_point',
- ],
+ 'schema' => ['description' => 'The attach mode. Valid values:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'create_new_mount_point - Create a new mount target (default)'."\n"
+ .'use_exist_mount_point - Use an existing mount target'."\n"
+ .'```', 'type' => 'string', 'required' => false, 'example' => 'create_new_mount_point', 'title' => ''],
],
[
'name' => 'AttachPoint',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/mnt/dbfs/dbfs-001',
- ],
+ 'schema' => ['description' => 'The path of the mount target. If you do not specify this parameter, a path is randomly generated.', 'type' => 'string', 'required' => false, 'example' => '/mnt/dbfs/dbfs-001', 'title' => ''],
],
],
'responses' => [
@@ -755,321 +323,318 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.ECS',
- 'errorMessage' => 'The ECS instance does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.ECS', 'errorMessage' => 'The ECS instance does not exist.', 'description' => ''],
],
],
- '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":"<AttachDbfsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</AttachDbfsResponse>","errorExample":""}]',
- 'title' => 'AttachDbfs',
+ '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"}]',
+ 'title' => 'Mount a database file system',
+ 'summary' => 'Call the AttachDbfs operation to attach a pay-as-you-go database file system to an ECS instance. The ECS instance and the database file system must be in the same zone.',
+ 'description' => 'Note:'."\n"
+ ."\n"
+ .'The database file system must be in the Unattached state.'."\n"
+ .'The destination ECS instance must be in the Running state.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DetachDbfs' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:AttachDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'CancelAutoSnapshotPolicy' => [
+ 'summary' => 'Cancels the automatic snapshot policy for one or more database file systems.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'FsId',
+ 'name' => 'PolicyId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp131n0q38u3a4zi*****',
- ],
+ 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sp-z5siir3iq3m**********'],
],
[
- 'name' => 'ECSInstanceId',
+ 'name' => 'DbfsIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The IDs of the database file systems for which to cancel the automatic snapshot policy. The value must be a JSON array. For example: \\["dbfs-1luaxt4vs1iusrd`*******`","dbfs-cxbyu98fspcbvm`******`"].',
+ 'type' => 'array',
+ 'items' => ['description' => 'The database file system for which the automatic snapshot policy will be canceled.', 'type' => 'string', 'required' => true, 'example' => '"dbfs-1luaxt4vs1iusrd*******"', 'title' => ''],
'required' => true,
- 'docRequired' => true,
- 'example' => 'i-bp67acfmxazb4ph***',
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the most recent list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'DbfsWithAutoSnapshotPolicy.NotFound', 'errorMessage' => 'Dbfs cancel failed.The specified dbfs does not apply this auto snapshot policy or does not exist.', 'description' => ''],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'ParameterEmpty.PolicyId', 'errorMessage' => 'The value of policyId is empty.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.ECS',
- 'errorMessage' => 'The ECS instance does not exist.',
- ],
+ ['errorCode' => 'AutoSnapshotPolicyNotFound', 'errorMessage' => 'The automatic snapshot policy does not exist.', 'description' => ''],
+ ],
+ 409 => [
+ ['errorCode' => 'OperationConflict', 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.', 'description' => ''],
+ ],
+ 503 => [
+ ['errorCode' => 'AutoShapshotBusy', 'errorMessage' => 'The server is busy now, please try again later.', 'description' => ''],
],
],
- '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":"<DetachDbfsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DetachDbfsResponse>","errorExample":""}]',
- 'title' => 'DetachDbfs',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'RenameDbfs' => [
- 'methods' => [
- 'post',
- 'get',
+ '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"}]',
+ 'title' => 'Cancel Automatic Snapshot Policy',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-12-15T06:38:57.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:CancelAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAutoSnapshotPolicy'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'CreateAutoSnapshotPolicy' => [
+ 'summary' => 'Create an automatic snapshot policy in a specified region. An automatic snapshot policy periodically creates snapshot backups for database file systems.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '15818',
- 'abilityTreeNodes' => [
- 'FEATUREdbfs3HYCOJ',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '150683',
+ 'abilityTreeNodes' => ['FEATUREdbfsOC34E7'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'FsName',
+ 'name' => 'PolicyName',
'in' => 'query',
+ 'schema' => ['description' => 'The policy name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'policyTest'],
+ ],
+ [
+ 'name' => 'RetentionDays',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The retention period in days.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'required' => true, 'maximum' => '65536', 'minimum' => '-1', 'title' => '', 'example' => '30'],
+ ],
+ [
+ 'name' => 'RepeatWeekdays',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'A list of repeat dates for automatic snapshots. The unit is day, and the cycle is week. Value range: 1 to 7. For example, 1 indicates Monday. Format description:'."\n"
+ ."\n"
+ .'- The passed parameters must be in JSON array format. For example, \\["1"] means to create automatic snapshots repeatedly every Monday.'."\n"
+ ."\n"
+ .'- To create multiple automatic snapshots within a week, pass multiple time points. Separate time points with a comma (,). Pass up to 7 time points. For example, \\["1","3","5"] means to create automatic snapshots repeatedly every Monday, Wednesday, and Friday.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The repeat date for automatic snapshots. The cycle is week.', 'type' => 'string', 'required' => true, 'example' => '"1"', 'title' => ''],
'required' => true,
- 'docRequired' => true,
- 'example' => 'NewDbfsName',
+ 'maxItems' => 7,
+ 'minItems' => 1,
+ 'example' => '',
],
],
[
- 'name' => 'FsId',
+ 'name' => 'TimePoints',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'A list of creation time points for automatic snapshots. Use UTC+8 time. The unit is hour. Value range: 0 to 23, representing 24 time points from 00:00 to 23:00. For example, 01 indicates 01:00. Format description:'."\n"
+ ."\n"
+ .'- The passed parameters must be in JSON array format. For example, \\["1"] means to create an automatic snapshot at 01:00.'."\n"
+ ."\n"
+ .'- To create multiple automatic snapshots within a day, pass multiple time points. Separate time points with a comma (,). Pass up to 24 time points. For example, \\["01","03","15"] means to create automatic snapshots at 01:00, 03:00, and 15:00.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The creation time point for automatic snapshots.', 'type' => 'string', 'required' => true, 'example' => '"01"', 'title' => ''],
'required' => true,
- 'docRequired' => true,
- 'example' => 'dbfs-GOrr********Yd0VLOyBpg',
+ 'maxItems' => 24,
+ 'minItems' => 1,
+ 'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba Cloud region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'PolicyId' => ['description' => 'The automatic snapshot policy ID.', 'type' => 'string', 'example' => 'sp-z5siir3iq3m**********', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidName.DBFS',
- 'errorMessage' => 'Invalid DBFS instance name.',
- ],
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'ParameterInvalid.RetentionDays', 'errorMessage' => 'The RetentionDays parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.RepeatWeekDays', 'errorMessage' => 'The RepeatWeekdays parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.TimePoints', 'errorMessage' => 'The TimePoints parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.PolicyName', 'errorMessage' => 'The PolicyName parameter is invalid.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
+ ],
+ '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"}]',
+ 'title' => 'Create an automatic snapshot policy',
+ 'description' => 'Database file system snapshots rely on cloud disk snapshots. Cloud disks incur snapshot charges. Before using this API, you should understand the billing methods and [pricing](https://help.aliyun.com/document_detail/56159.htm?spm=a2c4g.11186623.0.0.19dd5496Onr9aK#concept-rq2-pcx-ydb) for cloud disk snapshots.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/*'],
+ ],
],
],
],
- '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',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAutoSnapshotPolicy'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'CreateDbfs' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1078,561 +643,249 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '15800',
+ 'abilityTreeNodes' => ['FEATUREdbfsUCP4CQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the DBFS instance. To view the latest list of Alibaba Cloud regions, call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'FsId',
+ 'name' => 'FsName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dbfs-GOrr********Yd0VLOyBpg',
- ],
+ 'schema' => ['description' => 'The name of the database file system.'."\n"
+ ."\n"
+ .'Valid values: 2 to 128 characters. The name must start with an English letter (case-sensitive) or a Chinese character. It can contain digits, underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdbfs-001', 'title' => ''],
],
[
- 'name' => 'NewSizeG',
+ 'name' => 'Category',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'minimum' => '20',
- 'example' => '40',
- ],
+ 'schema' => ['description' => 'The DBFS edition. Valid values:'."\n"
+ ."\n"
+ .'- standard: Standard Edition'."\n"
+ ."\n"
+ .'- enterprise: Enterprise Edition', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'standard', 'title' => ''],
],
- ],
- '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',
- ],
- ],
- ],
- ],
- ],
+ [
+ 'name' => 'SizeG',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The capacity in GiB. If you specify this parameter, its value must be greater than or equal to the capacity of the specified snapshot.'."\n"
+ ."\n"
+ .'Valid values: an integer from 20 to 32,768 if RAID0 data striping is disabled, or an integer from 160 to 262,144 if RAID0 data striping is enabled.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '20', 'example' => '200', 'title' => ''],
],
- ],
- '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.',
- ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The zone ID of the DBFS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-i', 'title' => ''],
],
- 404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
- ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A client token used to ensure idempotence. Generate a unique value on your client for each request. ClientToken supports only ASCII characters and cannot exceed 64 characters. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
- ],
- '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":"<ResizeDbfsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</ResizeDbfsResponse>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListDbfs' => [
- 'summary' => '查询DBFS列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The snapshot ID used to create the DBFS instance.', 'type' => 'string', 'required' => false, 'example' => 's-y2vZ3********vvMilZ2hQ', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsUCP4CQ',
+ [
+ 'name' => 'DeleteSnapshot',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to delete the source snapshot after creating the DBFS instance from it.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'PerformanceLevel',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The performance level of the DBFS instance. Valid values:'."\n"
+ ."\n"
+ .'- PL0: Up to 10,000 random read/write IOPS per disk'."\n"
+ ."\n"
+ .'- PL1: Up to 50,000 random read/write IOPS per disk (default)'."\n"
+ ."\n"
+ .'- PL2: Up to 100,000 random read/write IOPS per disk'."\n"
+ ."\n"
+ .'- PL3: Up to 1,000,000 random read/write IOPS per disk', 'type' => 'string', 'required' => false, 'example' => 'PL1', 'default' => 'PL1', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'EnableRaid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '999999',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'Specifies whether to create the DBFS instance using RAID.'."\n"
+ ."\n"
+ .'Valid values: true or false. Default value: false.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'RaidStripeUnitNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '10',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The number of stripes. Required when EnableRaid is set to true.'."\n"
+ ."\n"
+ .'Valid values: 2 to 8.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '0', 'example' => '8', 'title' => ''],
],
[
- 'name' => 'SortKey',
+ 'name' => 'KMSKeyId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SizeG',
- ],
+ 'schema' => ['description' => 'The KMS key ID used by the DBFS instance.', 'type' => 'string', 'required' => false, 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40826X', 'title' => ''],
],
[
- 'name' => 'SortType',
+ 'name' => 'Encryption',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- ],
+ 'schema' => ['description' => 'Specifies whether to encrypt the DBFS instance.'."\n"
+ ."\n"
+ .'Valid values: true or false. Default value: false.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'FilterKey',
+ 'name' => 'UsedScene',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FsName',
- ],
+ 'schema' => ['description' => 'The use case for the DBFS instance. Valid values:'."\n"
+ ."\n"
+ .'- MySQL 5.7'."\n"
+ ."\n"
+ .'- PostgreSQL'."\n"
+ ."\n"
+ .'- MongoDB'."\n"
+ ."\n"
+ .'- Oracle RAC', 'type' => 'string', 'required' => false, 'example' => 'PostgreSQL', 'title' => ''],
],
[
- 'name' => 'FilterValue',
+ 'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dbfs-test-01',
- ],
+ 'schema' => ['description' => 'The instance type. Valid values:'."\n"
+ ."\n"
+ .'- dbfs.small'."\n"
+ ."\n"
+ .'- dbfs.medium'."\n"
+ ."\n"
+ .'- dbfs.large (default)', 'type' => 'string', 'required' => false, 'example' => 'dbfs.small', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'AdvancedFeatures',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
- ],
+ 'schema' => ['description' => 'Customize CPU cores, memory limit, and PageCache size for the DBFS instance.'."\n"
+ ."\n"
+ .'- cpuCoreCount: Number of CPU cores.'."\n"
+ ."\n"
+ .'- memorySize: Memory size in MB.'."\n"
+ ."\n"
+ .'- pageCacheSize: PageCache size in MB.', 'type' => 'string', 'required' => false, 'example' => '{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}', 'title' => ''],
],
],
'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*******',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'FsId' => ['description' => 'The DBFS instance ID.', 'type' => 'string', 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'The policy type.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'The owner ID of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType ', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidCategory.DBFS', 'errorMessage' => 'The category is not supported.', 'description' => ''],
+ ['errorCode' => 'InvalidName.DBFS', 'errorMessage' => 'Invalid DBFS instance name.', 'description' => ''],
+ ['errorCode' => 'InvalidPerformanceLevel.DBFS', 'errorMessage' => 'The performance level is not supported.', 'description' => ''],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'InvalidSize.DBFS', 'errorMessage' => 'The size of DBFS is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidZone.DBFS', 'errorMessage' => 'The zone is not supported.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.Snapshot', 'errorMessage' => 'The snapshot does not exist.', 'description' => ''],
],
],
- '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":"<TotalCount>32</TotalCount>\\n<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n<PageSize>10</PageSize>\\n<PageNumber>1</PageNumber>\\n<DBFSInfo>\\n <Status>attached</Status>\\n <LastFailed>TargetIsBusy.DBFS</LastFailed>\\n <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb408***</KMSKeyId>\\n <CreatedTime>1609330367000</CreatedTime>\\n <Category>standard</Category>\\n <EnableRaid>false</EnableRaid>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <SizeG>20</SizeG>\\n <PerformanceLevel>PL1</PerformanceLevel>\\n <DBFSClusterId>c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD</DBFSClusterId>\\n <FsId>dbfs-GOrr********Yd0VLOyBpg</FsId>\\n <LastUmountTime>1644915319000</LastUmountTime>\\n <PayType>postpaid</PayType>\\n <Encryption>false</Encryption>\\n <FsName>dbfs-test-01</FsName>\\n <UsedScene>MySQL 5.7</UsedScene>\\n <RaidStrip>2</RaidStrip>\\n <LastMountTime>1644915400000</LastMountTime>\\n <AttachNodeNumber>1</AttachNodeNumber>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceType>dbfs.small</InstanceType>\\n <EcsList>\\n <EcsId>i-y2vZ3********vvMilZ2hQ</EcsId>\\n </EcsList>\\n <EbsList>\\n <SizeG>20</SizeG>\\n <EbsId>d-bp1383******3uir001r</EbsId>\\n </EbsList>\\n <Tags>\\n <TagKey>TestTagKey1</TagKey>\\n <Id>1</Id>\\n <TagValue>TestTagValue1</TagValue>\\n </Tags>\\n</DBFSInfo>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Create a database file system ',
+ 'summary' => 'Call CreateDbfs to create a pay-as-you-go Database File System (DBFS).',
+ 'description' => 'You must complete identity verification before you can create a DBFS. Go to your account settings and complete [identity verification](https://account.console.aliyun.com/).'."\n"
+ ."\n"
+ .'Creating a DBFS incurs charges. Review the DBFS billing method before you proceed. For more information, see [pay-as-you-go](https://help.aliyun.com/document_detail/149734.html).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetDbfs' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-08-15T06:13:28.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-03-02T13:03:00.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-02-28T09:26:07.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-10-22T02:31:05.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'dbfs:CreateServiceLinkedRole'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'CreateServiceLinkedRole' => [
+ 'summary' => 'Call CreateServiceLinkedRole to create a service-linked role that DBFS uses to manage dependent cloud resources.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ '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',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'FsId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dbfs-GOrr********Yd0VLOyBpg',
- ],
+ 'schema' => ['description' => 'Ensures request idempotence. Generate a unique value from your client for this parameter across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
+ [
+ 'name' => 'AutoCreateServiceLinkedRole',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -1640,353 +893,107 @@
'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',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType ', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.(EntityNotExist.DBFS)',
+ ],
+ '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"}]',
+ 'title' => 'Create a service-linked role ',
+ 'description' => 'Permission description: Grants Database File System permission to access your ECS and PrivateLink resources. This permission enables you to query, create, scale out, mount, unmount, and delete ECS cloud disks; query, create, and delete disk snapshots; and create PrivateLink services.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateServiceLinkedRole',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n<DBFSInfo>\\n <Status>attached</Status>\\n <LastFailed>TargetIsBusy.DBFS</LastFailed>\\n <KMSKeyId>c39EcDBf-2Ecb-C3C6-6526-018d4D******</KMSKeyId>\\n <CreatedTime>1609330367000</CreatedTime>\\n <Category>standard</Category>\\n <Description>desc</Description>\\n <EnableRaid>false</EnableRaid>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <SizeG>20</SizeG>\\n <PerformanceLevel>PL1</PerformanceLevel>\\n <DBFSClusterId>c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD</DBFSClusterId>\\n <FsId>dbfs-GOrr********Yd0VLOyBpg</FsId>\\n <LastUmountTime>1644915319000</LastUmountTime>\\n <Encryption>false</Encryption>\\n <PayType>postpaid</PayType>\\n <FsName>dbfs-test-01</FsName>\\n <UsedScene>MySQL 5.7</UsedScene>\\n <RaidStrip>2</RaidStrip>\\n <LastMountTime>1644915400000</LastMountTime>\\n <AttachNodeNumber>1</AttachNodeNumber>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceType>dbfs.small</InstanceType>\\n <EcsList>\\n <EcsId>i-y2vZ3********vvMilZ2hQ</EcsId>\\n </EcsList>\\n <EbsList>\\n <SizeG>20</SizeG>\\n <EbsId>d-bp1hq4******qi7gy1th</EbsId>\\n </EbsList>\\n <Tags>\\n <TagKey>TestTagKey1</TagKey>\\n <Id>1</Id>\\n <TagValue>TestTagValue1</TagValue>\\n </Tags>\\n</DBFSInfo>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListDbfsAttachableEcsInstances' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'CreateSnapshot' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region where the DBFS instance resides. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'FsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the database file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp131n0q38u3a4zi*****', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SnapshotName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '100',
- ],
+ 'schema' => ['description' => 'The display name of the snapshot. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. It can contain digits, colons (:), underscores (\\_), and hyphens (-).'."\n"
+ ."\n"
+ .'To prevent name conflicts with automatic snapshots, the name cannot start with \\`auto\\` or \\`dbfs-auto\\`.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testSnapshotName', 'title' => ''],
],
[
- 'name' => 'FilterKey',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'InstanceName',
- ],
+ 'schema' => ['description' => 'The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n"
+ ."\n"
+ .'Default value: empty.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDescription', 'title' => ''],
],
[
- 'name' => 'FilterValue',
+ 'name' => 'RetentionDays',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'autotest1',
- ],
+ 'schema' => ['description' => 'The retention period of the snapshot, in days. The snapshot is automatically released after the retention period expires. Valid values: 1 to 65536.'."\n"
+ ."\n"
+ .'Default value: empty. This indicates that the snapshot is not automatically released.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '36500', 'minimum' => '-1', 'example' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique token on the client. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
@@ -1994,119 +1001,77 @@
'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****',
- ],
- ],
- ],
- ],
+ 'SnapshotId' => ['description' => 'The ID of the snapshot.', 'type' => 'string', 'example' => 's-Q2greuDZTvWeS8bfKZ****', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType ', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'InvalidStatus.DBFS', 'errorMessage' => 'The current state of the DBFS instance does not support this operation.', 'description' => ''],
+ ],
404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Create Snapshot ',
+ 'summary' => 'Call CreateSnapshot to create a snapshot for a database file system.',
+ 'description' => 'You cannot create a snapshot for the specified database file system in the following scenarios:'."\n"
+ ."\n"
+ .'- The previous snapshot is still being created.'."\n"
+ ."\n"
+ .'- The Database File System (DBFS) instance is not in the Attached or Unattached state.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'DeleteAutoSnapshotPolicy' => [
+ 'summary' => 'Deletes an automatic snapshot policy. File systems that use this policy automatically stop applying it after deletion.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -2114,147 +1079,93 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'PolicyId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Automatic snapshot policy ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sp-z5siir3iq3m**********'],
],
[
- 'name' => 'FsId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dbfs-nUy1tb********BQ4X8Gpw',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba Cloud region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'BaseResponse',
+ 'description' => 'Result.',
'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',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC********', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'ParameterEmpty.PolicyId', 'errorMessage' => 'The value of policyId is empty.', 'description' => ''],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'PermissionDeny.Policy', 'errorMessage' => 'The account has no permission on this policy.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
- ],
+ ['errorCode' => 'AutoSnapshotPolicyNotFound', 'errorMessage' => 'The automatic snapshot policy does not exist.', 'description' => ''],
+ ],
+ 409 => [
+ ['errorCode' => 'OperationConflict', 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.', 'description' => ''],
+ ],
+ 503 => [
+ ['errorCode' => 'AutoShapshotBusy', 'errorMessage' => 'The server is busy now, please try again later.', 'description' => ''],
],
],
- '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":"<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n<EcsLabelInfo>\\n <MountPoint>/mnt/dbfs/dbfs-nUy1tb********BQ4X8Gpw</MountPoint>\\n <InstanceTypeFamily>ecs.g7se</InstanceTypeFamily>\\n <OSName>Alibaba Cloud Linux 2.1903 LTS 64 bit</OSName>\\n <MountedTime>1606290930000</MountedTime>\\n <label>dbfs-test-01</label>\\n <value>i-bp10jb8mqajkmrejgo00</value>\\n</EcsLabelInfo>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateSnapshot' => [
- 'methods' => [
- 'post',
- 'get',
+ '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"}]',
+ 'title' => 'Delete automatic snapshot policy',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAutoSnapshotPolicy'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'DeleteDbfs' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2263,162 +1174,102 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '15803',
+ 'abilityTreeNodes' => ['FEATUREdbfs3MBLW2'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region where the DBFS is located. To query the latest list of regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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',
- ],
+ 'schema' => ['description' => 'The ID of the DBFS.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-9aqh1sqfqhc0w5********', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Force',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['title' => '是否强制删除。', 'description' => 'Specifies whether to forcibly delete the DBFS.'."\n"
+ .'The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'SnapshotId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's-Q2greuDZTvWeS8bfKZ****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'InvalidStatus.DBFS', 'errorMessage' => 'The current state of the DBFS instance does not support this operation.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
],
- '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":"<CreateSnapshotResponse>\\n <SnapshotId>s-Q2greuDZTvWeS8bfKZ****</SnapshotId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</CreateSnapshotResponse>","errorExample":""}]',
+ '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"}]',
+ 'title' => 'Delete database file system',
+ 'summary' => 'The DeleteDbfs operation releases a pay-as-you-go database file system.',
+ 'description' => 'Note:'."\n"
+ ."\n"
+ .'The Database File System (DBFS) must be in the Unattached state before you can release it. If a DBFS with the specified ID does not exist, the request is ignored.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteSnapshot' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-01-05T01:43:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'DeleteSnapshot' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2426,41 +1277,29 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the DBFS instance. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'SnapshotId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The ID of the snapshot or a list of snapshot IDs.'."\n"
+ ."\n"
+ .'- To delete a single snapshot, enter the snapshot ID.'."\n"
+ ."\n"
+ .'- For batch deletion, enter the snapshot IDs as a JSON array. Separate the IDs with commas (,). You can specify up to 100 snapshot IDs at a time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-Q2greuDZTvWeS8bfKZ**** '."\n"
+ .'或者["s-Q2greuDZTvWeS8bfKZ****","s-r4qlmevirw2vwmwv7*****"]', 'title' => ''],
],
[
'name' => 'Force',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to force delete the snapshot.'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
@@ -2468,95 +1307,80 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'ParameterEmpty.SnapshotId', 'errorMessage' => 'The value of snapshotId is empty.', 'description' => ''],
+ ['errorCode' => 'ParameterExceed.SnapshotId', 'errorMessage' => 'The maximum number of snapshot ID has been reached.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.SnapshotId', 'errorMessage' => 'The SnapshotId parameter is invalid.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.Snapshot',
- 'errorMessage' => 'The snapshot does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.Snapshot', 'errorMessage' => 'The snapshot does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'SnapshotCreatedDbfs',
- 'errorMessage' => 'A cloned DBFS exists under the current snapshot.',
- ],
+ ['errorCode' => 'SnapshotCreatedDbfs', 'errorMessage' => 'A cloned DBFS exists under the current snapshot.', 'description' => ''],
],
],
- '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":"<DeleteSnapshotResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DeleteSnapshotResponse>","errorExample":""}]',
+ '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"}]',
+ 'title' => 'Delete Snapshot',
+ 'summary' => 'Call DeleteSnapshot to delete one or more DBFS snapshots.',
+ 'description' => 'Note:'."\n"
+ ."\n"
+ .'- If the specified snapshot ID does not exist, the request is ignored.'."\n"
+ ."\n"
+ .'- You cannot delete a snapshot if a DBFS instance was created from it. To force delete the snapshot, set the Force parameter to true.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifySnapshotAttribute' => [
- 'summary' => '修改快照属性',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'DeleteTagsBatch' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2565,136 +1389,101 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ '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' => 'SnapshotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-y2vZ3********vvMilZ2hQ',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'SnapshotName',
+ 'name' => 'DbfsList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'testSnapshotName',
- ],
+ 'schema' => ['description' => 'The list of DBFS instances from which to remove tags.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["dbfs-nUy1tb********BQ4X8Gpw","dbfs-v0WvA********tVEVcgJLg"]', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'Tags',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'testDescription',
- ],
+ 'schema' => ['description' => 'The list of tags to remove.'."\n"
+ ."\n"
+ .'TagKey: The tag key. The tag key can be up to 64 characters in length and can contain letters, digits, Chinese characters, and the following special characters: @ \\_ - = + ; : , < . > / ?'."\n"
+ ."\n"
+ .'TagValue: The tag value. The tag value can be up to 128 characters in length and can contain letters, digits, Chinese characters, and the following special characters: @ \\_ - = + ; : , < . > / ?', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.Snapshot',
- 'errorMessage' => 'The snapshot does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
],
- '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',
+ 'title' => 'Batch remove tags',
+ 'summary' => 'Call DeleteTagsBatch to remove tags from multiple Database File System (DBFS) instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteTagsBatch',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteTagsBatch'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'DescribeDbfsSpecifications' => [
+ 'summary' => 'Call DescribeDbfsSpecifications to query DBFS specifications.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2704,738 +1493,307 @@
'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',
- ],
+ 'schema' => ['description' => 'The region ID of the DBFS instance. To view the latest list of Alibaba Cloud regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- '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',
+ 'name' => 'EcsInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
+ 'schema' => ['description' => 'The ECS instance type family.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs.g7se', 'title' => ''],
],
[
- 'name' => 'SnapshotIds',
+ 'name' => 'Category',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"]',
- ],
+ 'schema' => ['description' => 'The DBFS edition. Valid values:'."\n"
+ ."\n"
+ .'- standard'."\n"
+ ."\n"
+ .'- enterprise', 'type' => 'string', 'required' => true, 'example' => 'enterprise', 'title' => ''],
],
],
'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' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '187BCB3B-12E6-58B0-8E71-E19A895F49EF', 'title' => ''],
+ 'SupportedEcsInstanceTypeFamily' => [
'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',
- ],
- ],
- ],
+ 'items' => ['description' => 'The ECS instance type family.', 'type' => 'string', 'example' => '["ecs.g7se","ecs.r7se","ecs.c7se"]', 'title' => ''],
+ 'description' => 'The list of supported ECS instance type families.',
+ 'title' => '',
+ 'example' => '',
],
+ 'MaxDbfsNumberPerEcs' => ['description' => 'The maximum number of DBFS instances that a single ECS instance can mount.', 'type' => 'object', 'example' => '{"enterprise": 4}', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'The policy type.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'The owner ID of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The permission type that is not granted.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
],
- '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":"<TotalCount>32</TotalCount>\\n<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n<PageSize>10</PageSize>\\n<PageNumber>1</PageNumber>\\n<Snapshots>\\n <Status>accomplished</Status>\\n <Progress>100%</Progress>\\n <Category>standard</Category>\\n <Description>testDescription</Description>\\n <RetentionDays>30</RetentionDays>\\n <SourceFsSize>20</SourceFsSize>\\n <SnapshotName>testSnapshotName</SnapshotName>\\n <SourceFsId>dbfs-bp67acfmxazb4p****</SourceFsId>\\n <SnapshotId>s-bp67acfmxazb4p****</SnapshotId>\\n <SourceFsStripeWidth>1</SourceFsStripeWidth>\\n <LastModifiedTime>1609330367000</LastModifiedTime>\\n <CreationTime>1609330367000</CreationTime>\\n <SnapshotType>user</SnapshotType>\\n <RemainTime>38</RemainTime>\\n</Snapshots>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetSnapshotLink' => [
- 'summary' => '获取快照链',
- 'methods' => [
- 'get',
+ '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' => 'Query DBFS specification information',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-08-09T06:58:07.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:DescribeDbfsSpecifications',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDbfsSpecifications'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'DescribeInstanceTypes' => [
+ 'summary' => 'Queries the instance types supported by 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',
- ],
- ],
- [
- 'name' => 'LinkId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sl-b3zlgraysgcs9jy********',
- ],
+ 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'PlainResponse<AutoSnapshotPolicyViewModel>',
- 'description' => 'PlainResponse<AutoSnapshotPolicyViewModel>',
'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' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'InstanceTypes' => [
+ 'description' => 'The list of instance types.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceTypeId' => ['description' => 'The instance type ID.', 'type' => 'string', 'example' => 'dbfs.small', 'title' => ''],
+ 'CpuCoreCount' => ['description' => 'The maximum number of CPU cores.', 'type' => 'number', 'format' => 'float', 'example' => '0.25', 'title' => ''],
+ 'MemorySize' => ['description' => 'The maximum memory size in GiB.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''],
+ 'InstanceTypeDescription' => ['description' => 'The description of the instance type.', 'type' => 'string', 'example' => 'dbfs.small', 'title' => ''],
+ ],
+ 'description' => 'The instance type.',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType ', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'Schema of Response',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'PermissionDeny.SnapshotLink',
- 'errorMessage' => 'The account has no permission on this snapshot link.',
+ ],
+ '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' => 'Query instance types ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-10-26T08:58:40.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-10-26T08:39:42.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:DescribeInstanceTypes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- [
- [
- 'errorCode' => 'SnapshotLinkNotFound',
- 'errorMessage' => 'The snapshot link does not exist.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceTypes'],
],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
- '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',
- ],
+ 'DetachDbfs' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '159557',
- 'abilityTreeNodes' => [
- 'FEATUREdbfs3RTJEH',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update'],
'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',
+ 'name' => 'FsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FsId',
- ],
+ 'schema' => ['description' => 'The ID of the database file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp131n0q38u3a4zi*****', 'title' => ''],
],
[
- 'name' => 'FilterValue',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dbfs-kwziq4dpsle********',
- ],
- ],
- [
- 'name' => 'FsIds',
+ 'name' => 'ECSInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["dbfs-kwziq4dpsle********","dbfs-vuaqvfcjqsg********"]',
- ],
+ 'schema' => ['description' => 'The ID of the ECS instance from which to detach the file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-bp67acfmxazb4ph***', 'title' => ''],
],
[
- 'name' => 'LinkIds',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["sl-bp1grgphbcc9brb5****","sl-bp1c4izumvq0i5bs****","sl-bp1akk7isz866dds****"]',
- ],
+ 'schema' => ['description' => 'The ID of the region where the DBFS instance resides. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'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*******',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ECS', 'errorMessage' => 'The ECS instance does not exist.', 'description' => ''],
],
],
- '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',
+ '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"}]',
+ 'title' => 'Uninstall database file system',
+ 'summary' => 'Call DetachDbfs to detach a pay-as-you-go DBFS from an ECS instance.',
+ 'description' => 'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'- The DBFS must be attached to an instance and in the Attached state.'."\n"
+ ."\n"
+ .'- The ECS instance to which the DBFS is attached must be in the Running or Stopped state.'."\n"
+ ."\n"
+ .'- DetachDbfs is an asynchronous operation. After you successfully call it, the file system takes about one minute to detach.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:DetachDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'GetAutoSnapshotPolicy' => [
+ 'summary' => 'Queries the details of a single automatic snapshot policy.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3443,180 +1801,126 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '150683',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsOC34E7',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'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',
+ 'name' => 'PolicyId',
'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,
- ],
+ 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sp-z5siir3iq3m**********'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'PlainResponse<AutoSnapshotPolicyViewModel>',
+ 'description' => 'The response that is returned.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'PolicyId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sp-z5siir3iq3m**********',
- ],
- 'AccessDeniedDetail' => [
+ 'Data' => [
+ 'description' => 'The details of the automatic snapshot policy.',
'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',
+ 'PolicyId' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'title' => '', 'example' => 'sp-z5siir3iq3m**********'],
+ 'PolicyName' => ['description' => 'The name of the automatic snapshot policy.', 'type' => 'string', 'title' => '', 'example' => 'PolicyTest'],
+ 'AccountId' => ['description' => 'The ID of the account.', 'type' => 'string', 'title' => '', 'example' => '13523459********'],
+ 'RegionId' => ['description' => 'The ID of the region. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the most recent region list.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'Status' => ['description' => 'The status of the policy.', 'type' => 'string', 'title' => '', 'example' => 'Normal'],
+ 'StatusDetail' => ['description' => 'The details of an abnormal status. This parameter is empty if the value of \\`Status\\` is \\`Normal\\`.', 'type' => 'string', 'example' => '-', 'title' => ''],
+ 'RetentionDays' => ['description' => 'The retention period of snapshots, in days. Valid values: 1 to 65535. A value of -1 indicates continuous retention. Snapshots are automatically deleted when the number of snapshots reaches the upper limit.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'],
+ 'AppliedDbfsNumber' => ['description' => 'The number of DBFS instances to which this automatic snapshot policy is applied.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'RepeatWeekdays' => [
+ 'description' => 'The days of the week on which to create automatic snapshots. Valid values: 1 to 7, where 1 indicates Monday. The parameter must be a JSON array. For example, \\`\\["1","3","5"]\\` indicates that automatic snapshots are created on Mondays, Wednesdays, and Fridays.'."\n"
+ ."\n"
+ .'- Input parameters must be in JSON array format. For example, \\["1"] means to create automatic snapshots every Monday.'."\n"
+ ."\n"
+ .'- To create multiple automatic snapshots within a week, pass multiple time points. Separate them with a comma (,). Pass up to 7 time points. For example, \\["1","3","5"] means to create automatic snapshots every Monday, Wednesday, and Friday.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The day of the week on which an automatic snapshot is created.', 'type' => 'string', 'example' => '"1"', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'AuthAction' => [
- 'title' => 'AuthAction',
- 'type' => 'string',
+ 'TimePoints' => [
+ 'description' => 'The points in time of a day at which to create automatic snapshots. The time is in UTC+8. The parameter must be a JSON array. The values must be from 0 to 23. For example, \\`\\["01","03","15"]\\` indicates that automatic snapshots are created at 01:00, 03:00, and 15:00.'."\n"
+ ."\n"
+ .'- Pass the parameter as a JSON array. For example, \\["1"] creates an automatic snapshot at 01:00.'."\n"
+ ."\n"
+ .'- To create multiple automatic snapshots in one day, pass multiple time points separated by commas. You can pass up to 24 time points. For example, \\["01","03","15"] creates automatic snapshots at 01:00, 03:00, and 15:00.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The point in time of a day at which to create an automatic snapshot.', 'type' => 'string', 'example' => '"01"', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'CreatedTime' => ['description' => 'The time when the policy was created.', 'type' => 'string', 'example' => '1670998784000', 'title' => ''],
+ 'LastModified' => ['description' => 'The time when the policy was last modified.', 'type' => 'string', 'example' => '1670998784000', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'AccessDeniedDetail' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'PermissionDeny.Policy', 'errorMessage' => 'The account has no permission on this policy.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'AutoSnapshotPolicyNotFound', 'errorMessage' => 'The automatic snapshot policy does not exist.', 'description' => ''],
],
],
- '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',
+ '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"}]',
+ 'title' => 'Query a Single Automatic Snapshot Policy',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAutoSnapshotPolicy'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'GetDbfs' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3624,143 +1928,231 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'PolicyId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => '策略ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sp-z5siir3iq3m**********',
- ],
+ 'schema' => ['description' => 'The region ID of the DBFS instance. Invoke [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba Cloud region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DbfsIds',
+ 'name' => 'FsId',
'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',
- ],
+ 'schema' => ['description' => 'The Database File System ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'AccessDeniedDetail' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'DBFSInfo' => [
+ 'description' => 'The Database File System instance.',
'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',
+ 'Status' => ['description' => 'The status of the Database File System.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- unattached: Not attached'."\n"
+ ."\n"
+ .'- attached: Attached'."\n"
+ ."\n"
+ .'- creating: Creating'."\n"
+ ."\n"
+ .'- attaching: Attaching'."\n"
+ ."\n"
+ .'- detaching: Detaching'."\n"
+ ."\n"
+ .'- deleting: Deleting'."\n"
+ ."\n"
+ .'- deleted: Deleted'."\n"
+ ."\n"
+ .'- resizing: Scaling up'."\n"
+ ."\n"
+ .'- snapshotting: Snapshotting'."\n"
+ ."\n"
+ .'- upgrading: Upgrading', 'type' => 'string', 'example' => 'attached', 'title' => ''],
+ 'PayType' => ['description' => 'The payment type of the Database File System. Currently, only pay-as-you-go (postpaid) is supported.', 'type' => 'string', 'example' => 'postpaid', 'title' => ''],
+ 'FsId' => ['description' => 'The Database File System ID.', 'type' => 'string', 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'The tag collection.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestTagValue1', 'title' => ''],
+ 'Id' => ['description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestTagKey1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'AuthAction' => [
- 'title' => 'AuthAction',
- 'type' => 'string',
+ 'SizeG' => ['description' => 'The size of the Database File System, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'EcsList' => [
+ 'description' => 'The collection of attached ECS instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EcsId' => ['description' => 'The ID of the attached ECS instance.', 'type' => 'string', 'example' => 'i-y2vZ3********vvMilZ2hQ', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RegionId' => ['description' => 'The region ID to which the Database File System belongs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'DBFSClusterId' => ['description' => 'The Database File System cluster ID.', 'type' => 'string', 'example' => 'c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD', 'title' => ''],
+ 'Description' => ['description' => 'The description of the Database File System.', 'type' => 'string', 'example' => 'desc', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID to which the Database File System belongs.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
+ 'FsName' => ['description' => 'The name of the Database File System.', 'type' => 'string', 'example' => 'dbfs-test-01', 'title' => ''],
+ 'Category' => ['description' => 'The type of the Database File System. Valid values:'."\n"
+ ."\n"
+ .'- standard: Standard Edition'."\n"
+ ."\n"
+ .'- enterprise: Enterprise Edition (public preview)', 'type' => 'string', 'example' => 'standard', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1609330367000', 'title' => ''],
+ 'AttachNodeNumber' => ['description' => 'The number of nodes to which the Database File System is attached.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'KMSKeyId' => ['description' => 'The KMS key ID.', 'type' => 'string', 'example' => 'c39EcDBf-2Ecb-C3C6-6526-018d4D******', 'title' => ''],
+ 'Encryption' => ['description' => 'Indicates whether the file system is encrypted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'PerformanceLevel' => ['description' => 'The performance level of the disk. Valid values:'."\n"
+ ."\n"
+ .'- PL0'."\n"
+ ."\n"
+ .'- PL1'."\n"
+ ."\n"
+ .'- PL2'."\n"
+ ."\n"
+ .'- PL3', 'type' => 'string', 'example' => 'PL1', 'title' => ''],
+ 'UsedScene' => ['description' => 'The scenario.', 'type' => 'string', 'example' => 'MySQL 5.7', 'title' => ''],
+ 'LastMountTime' => ['description' => 'The last attachment time.', 'type' => 'string', 'example' => '1644915400000', 'title' => ''],
+ 'LastUmountTime' => ['description' => 'The last detachment time.', 'type' => 'string', 'example' => '1644915319000', 'title' => ''],
+ 'EnableRaid' => ['description' => 'Indicates whether RAID is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type of the DBFS. Valid values:'."\n"
+ ."\n"
+ .'- dbfs.small'."\n"
+ ."\n"
+ .'- dbfs.medium'."\n"
+ ."\n"
+ .'- dbfs.large', 'type' => 'string', 'example' => 'dbfs.small', 'title' => ''],
+ 'RaidStrip' => ['description' => 'The number of stripes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'EbsList' => [
+ 'description' => 'The list of disks used by DBFS.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EbsId' => ['description' => 'The disk ID.', 'type' => 'string', 'example' => 'd-bp1hq4******qi7gy1th', 'title' => ''],
+ 'SizeG' => ['description' => 'The disk capacity, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'LastFailed' => ['description' => 'The reason for the last failed operation.', 'type' => 'string', 'example' => 'TargetIsBusy.DBFS', 'title' => ''],
+ 'SnapshotInfo' => [
+ 'description' => 'Snapshot-related information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SnapshotCount' => ['description' => 'The number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'LinkId' => ['description' => 'The snapshot chain ID. If no snapshot chain exists, the value is "-".', 'type' => 'string', 'example' => 'sl-9zskwvgoqqqvzxa*******', 'title' => ''],
+ 'TotalSize' => ['description' => 'The snapshot size.', 'type' => 'integer', 'format' => 'int64', 'example' => '50331648', 'title' => ''],
+ 'PolicyId' => ['description' => 'The automatic snapshot policy ID. If no automatic snapshot policy is set, the value is "-".', 'type' => 'string', 'example' => 'sp-ehuhzlfetb2jiwz*******', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AdvancedFeatures' => ['description' => 'The number of CPU cores and the maximum memory of the Database File System instance.'."\n"
+ ."\n"
+ .'- cpuCoreCount: The number of CPU cores.'."\n"
+ ."\n"
+ .'- memorySize: The memory size, in MB.'."\n"
+ ."\n"
+ .'- pageCacheSize: The PageCache size, in MB.', 'type' => 'string', 'example' => '{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}', 'title' => ''],
+ 'SnapshotId' => ['description' => 'The snapshot ID used to create the DBFS instance.', 'type' => 'string', 'example' => 's-uvwtoxcjj6xtlua*******', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AccessDeniedDetail' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'The policy type.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'The owner ID of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The permission type that is not granted.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'AutoSnapshotPolicyNotFound',
- 'errorMessage' => 'The automatic snapshot policy does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.(EntityNotExist.DBFS)', 'description' => ''],
],
- 409 => [
- [
- 'errorCode' => 'OperationConflict',
- 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query a single Database File System ',
+ 'summary' => 'Call GetDbfs to retrieve details about a Database File System (DBFS).',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-11-07T11:56:27.000Z', 'description' => 'Error codes changed, Response parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-01-04T03:07:11.000Z', 'description' => 'Response parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-01-03T02:42:12.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-01-19T07:16:37.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-10-27T06:07:17.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-05-19T11:19:18.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 503 => [
- [
- 'errorCode' => 'AutoShapshotBusy',
- 'errorMessage' => 'The server is busy now, please try again later.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDbfs'],
],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
- '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',
- ],
+ 'GetServiceLinkedRole' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3768,290 +2160,236 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '15808',
+ 'abilityTreeNodes' => ['FEATUREdbfs29ABXP'],
+ ],
'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',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'AccountId' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1352345930******', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'DbfsLinkedRole' => ['description' => 'Indicates whether a service-linked role has been created.'."\n"
+ ."\n"
+ .'- true: The role has been created.'."\n"
+ ."\n"
+ .'- false: The role has not been created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
- [
- [
- '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.',
- ],
+ 403 => [
+ ['errorCode' => 'PermissionDeny.DBFS', 'errorMessage' => 'RAM permission verification failed.', 'description' => ''],
],
- 409 => [
- [
- 'errorCode' => 'OperationConflict',
- 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query service-linked role ',
+ 'summary' => 'You can call GetServiceLinkedRole to check whether a service-linked role has been created.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Error codes changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetServiceLinkedRole',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 503 => [
- [
- 'errorCode' => 'AutoShapshotBusy',
- 'errorMessage' => 'The server is busy now, please try again later.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetServiceLinkedRole'],
],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
- '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',
- ],
+ 'GetSnapshotLink' => [
+ 'summary' => 'Retrieves the snapshot chain for a Database File System (DBFS). A snapshot chain is a sequence that includes all snapshots associated with a DBFS instance. Each file system has exactly one snapshot chain.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'PolicyId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => '策略ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sp-z5siir3iq3m**********',
- ],
+ 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the most recent list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'LinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The snapshot chain ID.', 'type' => 'string', 'required' => false, 'example' => 'sl-b3zlgraysgcs9jy********', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'BaseResponse',
- 'description' => '',
+ 'title' => 'PlainResponse<AutoSnapshotPolicyViewModel>',
+ 'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC********',
+ 'Data' => [
+ 'description' => 'Details of the automatic snapshot policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the DBFS instance.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'unattached: The DBFS instance is not attached.'."\n"
+ ."\n"
+ .'attached: The DBFS instance is attached.'."\n"
+ ."\n"
+ .'creating: The DBFS instance is being created.'."\n"
+ ."\n"
+ .'attaching: The DBFS instance is being attached.'."\n"
+ ."\n"
+ .'detaching: The DBFS instance is being detached.'."\n"
+ ."\n"
+ .'deleting: The DBFS instance is being deleted.'."\n"
+ ."\n"
+ .'deleted: The DBFS instance is deleted.'."\n"
+ ."\n"
+ .'resizing: The DBFS instance is scaling up.'."\n"
+ ."\n"
+ .'snapshotting: A snapshot is being created.'."\n"
+ ."\n"
+ .'upgrading: The DBFS instance is being upgraded.', 'type' => 'string', 'example' => 'attached', 'title' => ''],
+ 'TotalSize' => ['description' => 'The total size of all snapshots in the snapshot chain. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '50331648', 'title' => ''],
+ 'SourceSize' => ['description' => 'The capacity of the DBFS instance. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'FsId' => ['description' => 'The ID of the DBFS instance.', 'type' => 'string', 'example' => 'dbfs-194j6u20sp2gisx*******', 'title' => ''],
+ 'EcsList' => [
+ 'description' => 'The collection of attached ECS instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The attached ECS instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EcsId' => ['description' => 'The ID of the attached ECS instance.', 'type' => 'string', 'example' => 'i-bp19mogqud1w1*******', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SnapshotCount' => ['description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'FsName' => ['description' => 'The name of the DBFS instance.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'LinkId' => ['description' => 'The ID of the snapshot chain.', 'type' => 'string', 'example' => 'sl-b3zlgraysgcs9jy*******', 'title' => ''],
+ 'Category' => ['description' => 'The type of the DBFS instance. Valid values:'."\n"
+ ."\n"
+ .'- standard: Standard Edition'."\n"
+ ."\n"
+ .'- enterprise: Enterprise Edition (in public preview)', 'type' => 'string', 'example' => 'standard', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType ', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'ParameterEmpty.PolicyId',
- 'errorMessage' => 'The value of policyId is empty.',
- ],
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
- [
- [
- 'errorCode' => 'PermissionDeny.Policy',
- 'errorMessage' => 'The account has no permission on this policy.',
- ],
+ 403 => [
+ ['errorCode' => 'PermissionDeny.SnapshotLink', 'errorMessage' => 'The account has no permission on this snapshot link.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'AutoSnapshotPolicyNotFound',
- 'errorMessage' => 'The automatic snapshot policy does not exist.',
- ],
+ [
+ ['errorCode' => 'SnapshotLinkNotFound', 'errorMessage' => 'The snapshot link does not exist.', 'description' => ''],
],
- 409 => [
- [
- 'errorCode' => 'OperationConflict',
- 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
+ ],
+ '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"}]',
+ 'title' => 'View a single snapshot chain',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetSnapshotLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 503 => [
- [
- 'errorCode' => 'AutoShapshotBusy',
- 'errorMessage' => 'The server is busy now, please try again later.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSnapshotLink'],
],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
- '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',
- ],
+ 'ListAutoSnapshotPolicies' => [
+ 'summary' => 'List all automatic snapshot policies that you created in a region and that match your query conditions.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4059,202 +2397,171 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdbfsOC34E7'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
'parameters' => [
[
- 'name' => 'PolicyId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '策略ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sp-z5siir3iq3m**********',
- ],
- ],
- [
- 'name' => 'PolicyName',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => '策略名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'policyTest',
- ],
+ 'schema' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RetentionDays',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '保留天数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '65536',
- 'minimum' => '-1',
- 'example' => '30',
- ],
+ 'schema' => ['description' => 'The page number for paged queries. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '999999', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'RepeatWeekdays',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '"1"',
- ],
- 'required' => false,
- 'maxItems' => 7,
- ],
+ 'schema' => ['description' => 'The number of entries per page for paged queries. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'default' => '10', 'example' => '10', 'title' => ''],
],
[
- 'name' => 'TimePoints',
+ 'name' => 'FilterKey',
'in' => 'query',
- 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '"01"',
- ],
+ 'description' => 'The filter key to use when querying resources.'."\n"
+ ."\n"
+ .'Use with FilterValue. Valid values: PolicyId or PolicyName.'."\n"
+ ."\n"
+ .'If you specify PolicyId, the system filters by automatic snapshot policy ID. If you specify PolicyName, the system filters by automatic snapshot policy name.',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 24,
+ 'enum' => ['PolicyId', 'PolicyName'],
+ 'example' => 'PolicyName',
+ 'title' => '',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'FilterValue',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The filter value to use when querying automatic snapshot policies.'."\n"
+ ."\n"
+ .'Use with FilterKey.', 'type' => 'string', 'required' => false, 'example' => 'policyTest', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'PlainResponse<PageResponse<AutoSnapshotPolicyViewModel>>',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
+ 'PageNumber' => ['description' => 'The page number for paged queries. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page for paged queries. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of automatic snapshot policies.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'SnapshotPolicies' => [
+ 'description' => 'The list of automatic snapshot policies.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of an automatic snapshot policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyId' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'title' => '', 'example' => 'sp-z5siir3iq3m**********'."\n"],
+ 'PolicyName' => ['description' => 'The name of the automatic snapshot policy.', 'type' => 'string', 'title' => '', 'example' => 'policyTest'],
+ 'AccountId' => ['description' => 'The ID of the account.', 'type' => 'string', 'title' => '', 'example' => '13523459********'],
+ 'RegionId' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'Status' => [
+ 'description' => 'The status of the policy.',
+ 'enumValueTitles' => ['normal' => 'normal', 'abnormal' => 'abnormal'],
+ 'type' => 'string',
+ 'title' => '',
+ 'example' => 'normal',
+ ],
+ 'StatusDetail' => ['description' => 'Detailed status information if the status is abnormal. This field is empty when Status is normal.', 'type' => 'string', 'example' => '-', 'title' => ''],
+ 'RetentionDays' => ['description' => 'The number of days to retain snapshots. Valid values: 1 to 65535. A null value means retain indefinitely until the quota limit is reached and older snapshots are automatically deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'],
+ 'AppliedDbfsNumber' => ['description' => 'The number of database file systems that use this automatic snapshot policy.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'RepeatWeekdays' => [
+ 'description' => 'The list of weekdays on which to create automatic snapshots. Valid values: 1 to 7, where 1 represents Monday.'."\n"
+ ."\n"
+ .'- Specify values as a JSON array. For example, \\["1"] creates automatic snapshots every Monday.'."\n"
+ ."\n"
+ .'- To create automatic snapshots multiple times per week, specify up to seven values separated by commas. For example, \\["1","3","5"] creates automatic snapshots every Monday, Wednesday, and Friday.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The weekday on which to create automatic snapshots.', 'type' => 'string', 'example' => '"1"', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TimePoints' => [
+ 'description' => 'The list of times at which to create automatic snapshots. Times use UTC+8 and are specified in hours. Valid values: 0 to 23, representing 00:00 to 23:00. For example, 01 represents 01:00.'."\n"
+ ."\n"
+ .'- Specify values as a JSON array. For example, \\["1"] creates an automatic snapshot at 01:00.'."\n"
+ ."\n"
+ .'- To create automatic snapshots multiple times per day, specify up to 24 values separated by commas. For example, \\["01","03","15"] creates automatic snapshots at 01:00, 03:00, and 15:00.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The time at which to create an automatic snapshot.', 'type' => 'string', 'example' => ' "01"', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreatedTime' => ['description' => 'The time when the policy was created.', 'type' => 'string', 'example' => '1670998784000', 'title' => ''],
+ 'LastModified' => ['description' => 'The time when the policy was last modified.', 'type' => 'string', 'example' => '1670998784000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'The type of policy.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'The ID of the owner of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The specified RegionId does not exist.', 'description' => ''],
],
- 409 => [
- [
- 'errorCode' => 'OperationConflict',
- 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.',
+ ],
+ '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"}]',
+ 'title' => 'List automatic snapshot policies',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListAutoSnapshotPolicies',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/*'],
+ ],
],
],
- 503 => [
- [
- 'errorCode' => 'AutoShapshotBusy',
- 'errorMessage' => 'The server is busy now, please try again later.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAutoSnapshotPolicies'],
],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
- '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',
- ],
+ 'ListAutoSnapshotPolicyAppliedDbfs' => [
+ 'summary' => 'Retrieves a list of Database File System (DBFS) instances that have a specific automatic snapshot policy applied.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4262,196 +2569,170 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to obtain the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
'name' => 'PolicyId',
'in' => 'query',
- 'schema' => [
- 'title' => '策略ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sp-z5siir3iq3m**********',
- ],
+ 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => true, 'example' => 'sp-z5siir3iq3m**********', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '999999', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'default' => '10', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'FilterKey',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The filter key for the query. This parameter is used with \\`FilterValue\\`.'."\n"
+ ."\n"
+ .'The value must be \\`FsId\\` or \\`FsName\\`.'."\n"
+ ."\n"
+ .'\\`FsId\\` filters the results by DBFS instance ID. \\`FsName\\` filters the results by DBFS instance name.',
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
+ 'required' => false,
+ 'enum' => ['FsId', 'FsName'],
+ 'example' => 'FsName',
+ 'title' => '',
],
],
+ [
+ 'name' => 'FilterValue',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The filter value for the query.'."\n"
+ ."\n"
+ .'This parameter is used with \\`FilterKey\\`.', 'type' => 'string', 'required' => false, 'example' => 'DBFS1', 'title' => ''],
+ ],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'PlainResponse<AutoSnapshotPolicyViewModel>',
- 'description' => '',
+ 'title' => 'PlainResponse<PageResponse<DbfsOnAutoSnapshotPolicyViewModel>>',
+ 'description' => 'The response.',
'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',
- ],
+ 'PageNumber' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'DbfsList' => [
+ 'description' => 'The list of DBFS instances to which the automatic snapshot policy is applied.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The DBFS instance to which the automatic snapshot policy is applied.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FsId' => ['description' => 'The ID of the DBFS instance.', 'type' => 'string', 'title' => '', 'example' => 'dbfs-ejdvesb0qvuywvg*******'],
+ 'FsName' => ['description' => 'The name of the DBFS instance.', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'Status' => ['description' => 'The status of the DBFS instance.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- unattached: The instance is not attached.'."\n"
+ ."\n"
+ .'- attached: The instance is attached.'."\n"
+ ."\n"
+ .'- creating: The instance is being created.'."\n"
+ ."\n"
+ .'- attaching: The instance is being attached.'."\n"
+ ."\n"
+ .'- detaching: The instance is being detached.'."\n"
+ ."\n"
+ .'- deleting: The instance is being deleted.'."\n"
+ ."\n"
+ .'- deleted: The instance is deleted.'."\n"
+ ."\n"
+ .'- resizing: The instance is scaling up.'."\n"
+ ."\n"
+ .'- snapshotting: A snapshot is being created for the instance.'."\n"
+ ."\n"
+ .'- upgrading: The instance is being upgraded.', 'type' => 'string', 'example' => 'attached', 'title' => ''],
+ 'SizeG' => ['description' => 'The capacity in GB.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'],
+ 'RegionId' => ['description' => 'The ID of the region. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to obtain the latest list of Alibaba Cloud regions.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'SnapshotCount' => ['description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalSize' => ['description' => 'The total size of all snapshots in the snapshot chain, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '50331648', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'ParameterEmpty.PolicyId', 'errorMessage' => 'The value of policyId is empty.', 'description' => ''],
],
[
- [
- 'errorCode' => 'PermissionDeny.Policy',
- 'errorMessage' => 'The account has no permission on this policy.',
- ],
+ ['errorCode' => 'PermissionDeny.Policy', 'errorMessage' => 'The account has no permission on this policy.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'AutoSnapshotPolicyNotFound',
- 'errorMessage' => 'The automatic snapshot policy does not exist.',
- ],
+ ['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The specified RegionId does not exist.', 'description' => ''],
+ ['errorCode' => 'AutoSnapshotPolicyNotFound', 'errorMessage' => 'The automatic snapshot policy does not exist.', 'description' => ''],
],
],
- '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',
+ '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"}]',
+ 'title' => 'List file systems associated with this automatic snapshot policy',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-01-06T06:21:06.000Z', 'description' => 'Response parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-01-03T02:42:12.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListAutoSnapshotPolicyAppliedDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAutoSnapshotPolicyAppliedDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ListAutoSnapshotPolicyUnappliedDbfs' => [
+ 'summary' => 'Lists all DBFS instances in a region without an automatic snapshot policy applied and that match your query criteria.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4463,255 +2744,160 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsOC34E7',
- ],
+ 'abilityTreeNodes' => ['FEATUREdbfsOC34E7'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '999999',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The page number for paged queries. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '999999', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '10',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page for paged queries. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'default' => '10', 'example' => '10', 'title' => ''],
],
[
'name' => 'FilterKey',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The filter key used to query resources.'."\n"
+ ."\n"
+ .'Use with FilterValue. Valid values: FsId or FsName.'."\n"
+ ."\n"
+ .'If you specify FsId, the system filters by DBFS instance ID. If you specify FsName, the system filters by DBFS instance name.',
'type' => 'string',
'required' => false,
- 'example' => 'PolicyName',
- 'enum' => [
- 'PolicyId',
- 'PolicyName',
- ],
+ 'enum' => ['FsId', 'FsName'],
+ 'example' => 'FsName',
+ 'title' => '',
],
],
[
'name' => 'FilterValue',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'policyTest',
- ],
+ 'schema' => ['description' => 'The filter value used to query resources.'."\n"
+ ."\n"
+ .'Use with FilterKey.', 'type' => 'string', 'required' => false, 'example' => 'DBFS1', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'PlainResponse<PageResponse<AutoSnapshotPolicyViewModel>>',
- 'description' => '',
+ 'title' => 'PlainResponse<PageResponse<DbfsOnAutoSnapshotPolicyViewModel>>',
+ 'description' => 'The response object.',
'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' => '',
+ 'PageNumber' => ['description' => 'The page number for paged queries. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page for paged queries. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'DbfsList' => [
+ 'description' => 'The list of DBFS instances with no automatic snapshot policy applied.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A DBFS instance with no automatic snapshot policy applied.',
'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',
- ],
- ],
+ 'FsId' => ['description' => 'The ID of the DBFS instance.', 'type' => 'string', 'title' => '', 'example' => 'dbfs-ejdvesb0qvuywvg*******'],
+ 'FsName' => ['description' => 'The name of the DBFS instance.', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'Status' => ['description' => 'The status of the DBFS instance.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- unattached: Not attached'."\n"
+ ."\n"
+ .'- attached: Attached'."\n"
+ ."\n"
+ .'- creating: Creating'."\n"
+ ."\n"
+ .'- attaching: Attaching'."\n"
+ ."\n"
+ .'- detaching: Detaching'."\n"
+ ."\n"
+ .'- deleting: Deleting'."\n"
+ ."\n"
+ .'- deleted: Deleted'."\n"
+ ."\n"
+ .'- resizing: Scaling up'."\n"
+ ."\n"
+ .'- snapshotting: Creating snapshots'."\n"
+ ."\n"
+ .'- upgrading: Upgrading', 'type' => 'string', 'example' => 'attached', 'title' => ''],
+ 'SizeG' => ['description' => 'The capacity in GB.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'],
+ 'RegionId' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'SnapshotCount' => ['description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalSize' => ['description' => 'The total size of all snapshots in the snapshot chain, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '50331648', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'The type of policy.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'The ID of the owner of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType ', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidRegionId.NotFound',
- 'errorMessage' => 'The specified RegionId does not exist.',
- ],
+ ['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The specified RegionId does not exist.', 'description' => ''],
],
],
- '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',
+ '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"}]',
+ 'title' => 'List file systems that do not have an automatic snapshot policy configured ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-01-06T06:21:06.000Z', 'description' => 'Response parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-01-03T02:42:12.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListAutoSnapshotPolicyUnappliedDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAutoSnapshotPolicyUnappliedDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ListDbfs' => [
+ 'summary' => 'Call ListDbfs to query the database file systems you have created.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4720,219 +2906,290 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsOC34E7',
- ],
+ 'abilityTreeNodes' => ['FEATUREdbfsUCP4CQ'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the DBFS instance. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '999999',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The current page number.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '999999', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '10',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page for paged queries.'."\n"
+ ."\n"
+ .'Maximum value: 100.'."\n"
+ ."\n"
+ .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The field to sort by when querying resources.'."\n"
+ ."\n"
+ .'Use with SortType. Valid values: SizeG or CreatedTime.'."\n"
+ ."\n"
+ .'If you set SortKey to SizeG, results are sorted by capacity. If you set it to CreatedTime, results are sorted by creation time.'."\n"
+ ."\n"
+ .'By default, results are sorted in descending order by creation time.', 'type' => 'string', 'required' => false, 'example' => 'SizeG', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The sort order when querying resources.'."\n"
+ ."\n"
+ .'Use with SortKey. Valid values: asc or desc.'."\n"
+ ."\n"
+ .'If you set SortType to asc, results are sorted in ascending order. If you set it to desc, results are sorted in descending order.'."\n"
+ ."\n"
+ .'By default, results are sorted in descending order by creation time.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''],
],
[
'name' => 'FilterKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FsName',
- 'enum' => [
- 'FsId',
- 'FsName',
- ],
- ],
+ 'schema' => ['description' => 'The filter key when querying resources.'."\n"
+ ."\n"
+ .'Use with FilterValue. Valid values: FsId or FsName.'."\n"
+ ."\n"
+ .'If you specify FsId, the system filters by DBFS instance ID. If you specify FsName, the system filters by DBFS instance name.', 'type' => 'string', 'required' => false, 'example' => 'FsName', 'title' => ''],
],
[
'name' => 'FilterValue',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DBFS1',
- ],
+ 'schema' => ['description' => 'The filter value when querying resources.'."\n"
+ ."\n"
+ .'Use with FilterKey.', 'type' => 'string', 'required' => false, 'example' => 'dbfs-test-01', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Filter the list of DBFS instances by tags.'."\n"
+ ."\n"
+ .'TagKey: The tag key of the resource. Valid values: Up to 64 characters. Can include uppercase and lowercase letters, Chinese characters, digits, and special characters @ \\_ - = + ; : , < . > / ?'."\n"
+ ."\n"
+ .'TagValue: The tag value of the resource. Valid values: Up to 128 characters. Can include uppercase and lowercase letters, Chinese characters, digits, and special characters @ \\_ - = + ; : , < . > / ?', 'type' => 'string', 'required' => false, 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
- 'title' => 'PlainResponse<PageResponse<DbfsOnAutoSnapshotPolicyViewModel>>',
- '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' => '',
+ 'TotalCount' => ['description' => 'The total number of entries in the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page that you specified in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'DBFSInfo' => [
+ 'description' => 'The collection of database file systems.',
'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',
+ 'Status' => ['description' => 'The status of the database file system.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- unattached: Not attached'."\n"
+ ."\n"
+ .'- attached: Attached'."\n"
+ ."\n"
+ .'- creating: Creating'."\n"
+ ."\n"
+ .'- attaching: Attaching'."\n"
+ ."\n"
+ .'- detaching: Detaching'."\n"
+ ."\n"
+ .'- deleting: Deleting'."\n"
+ ."\n"
+ .'- deleted: Deleted'."\n"
+ ."\n"
+ .'- resizing: Scaling up'."\n"
+ ."\n"
+ .'- snapshotting: Creating snapshot'."\n"
+ ."\n"
+ .'- upgrading: Upgrading', 'type' => 'string', 'example' => 'attached', 'title' => ''],
+ 'Encryption' => ['description' => 'Indicates whether the database file system is encrypted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method of the database file system. Only pay-as-you-go is supported.', 'type' => 'string', 'example' => 'postpaid', 'title' => ''],
+ 'FsId' => ['description' => 'The ID of the database file system.', 'type' => 'string', 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'The collection of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestTagValue1', 'title' => ''],
+ 'Id' => ['description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestTagKey1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
+ 'SizeG' => ['description' => 'The size of the database file system, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'EcsList' => [
+ 'description' => 'The collection of ECS instances to which the database file system is attached.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EcsId' => ['description' => 'The ID of an attached ECS instance.', 'type' => 'string', 'example' => 'i-y2vZ3********vvMilZ2hQ', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'SnapshotCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'EbsList' => [
+ 'description' => 'The collection of cloud disks.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EbsId' => ['description' => 'The ID of the cloud disk used by DBFS.', 'type' => 'string', 'example' => 'd-bp1383******3uir001r', 'title' => ''],
+ 'SizeG' => ['description' => 'The capacity of the cloud disk, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'TotalSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50331648',
+ 'RegionId' => ['description' => 'The region ID of the database file system.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'DBFSClusterId' => ['description' => 'The cluster ID of the database file system.', 'type' => 'string', 'example' => 'c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID of the database file system.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
+ 'FsName' => ['description' => 'The name of the database file system.', 'type' => 'string', 'example' => 'dbfs-test-01', 'title' => ''],
+ 'Category' => ['description' => 'The type of the database file system. Valid values:'."\n"
+ ."\n"
+ .'- standard: Standard Edition'."\n"
+ ."\n"
+ .'- enterprise: Enterprise Edition (in public preview)', 'type' => 'string', 'example' => 'standard', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the database file system was created.', 'type' => 'string', 'example' => '1609330367000', 'title' => ''],
+ 'AttachNodeNumber' => ['description' => 'The number of nodes to which the database file system is attached.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'KMSKeyId' => ['description' => 'The KMS key ID used by the database file system.', 'type' => 'string', 'example' => '0e478b7a-4262-4802-b8cb-00d3fb408***', 'title' => ''],
+ 'PerformanceLevel' => ['description' => 'The performance level of the cloud disk. Valid values:'."\n"
+ ."\n"
+ .'- PL0'."\n"
+ ."\n"
+ .'- PL1'."\n"
+ ."\n"
+ .'- PL2'."\n"
+ ."\n"
+ .'- PL3', 'type' => 'string', 'example' => 'PL1', 'title' => ''],
+ 'UsedScene' => ['description' => 'The use scenario.', 'type' => 'string', 'example' => 'MySQL 5.7', 'title' => ''],
+ 'LastMountTime' => ['description' => 'The time when the database file system was last attached.', 'type' => 'string', 'example' => '1644915400000', 'title' => ''],
+ 'LastUmountTime' => ['description' => 'The time when the database file system was last detached.', 'type' => 'string', 'example' => '1644915319000', 'title' => ''],
+ 'EnableRaid' => ['description' => 'Indicates whether RAID is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'RaidStrip' => ['description' => 'The number of stripes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type of the DBFS instance. Valid values:'."\n"
+ ."\n"
+ .'- dbfs.small'."\n"
+ ."\n"
+ .'- dbfs.medium'."\n"
+ ."\n"
+ .'- dbfs.large', 'type' => 'string', 'example' => 'dbfs.small', 'title' => ''],
+ 'LastFailed' => ['description' => 'The reason for the most recent failed operation.', 'type' => 'string', 'example' => 'TargetIsBusy.DBFS', 'title' => ''],
+ 'SnapshotInfo' => [
+ 'description' => 'Information about related snapshots.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SnapshotCount' => ['description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalSize' => ['description' => 'The total size of all snapshots in the snapshot chain, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '50331648', 'title' => ''],
+ 'LinkId' => ['description' => 'The ID of the snapshot chain. If no snapshot chain exists, this value is "-".', 'type' => 'string', 'example' => 'sl-b3zlgraysgcs9jy*******', 'title' => ''],
+ 'PolicyId' => ['description' => 'The ID of the automatic snapshot policy. If no automatic snapshot policy is configured, this value is "-".', 'type' => 'string', 'example' => 'sp-ehuhzlfetb2jiwz*******', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidRegionId.NotFound',
- 'errorMessage' => 'The specified RegionId does not exist.',
- ],
+ 400 => [
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query the list of database file systems ',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-02-27T09:18:22.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-01-03T02:42:12.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-01-19T07:16:37.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-10-27T06:07:17.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-05-19T11:19:18.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ListDbfsAttachableEcsInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4940,287 +3197,157 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'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**********',
- ],
+ 'schema' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '999999',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The page number of the current page. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '10',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page for a paged query. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'default' => '100', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'FilterKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FsName',
- 'enum' => [
- 'FsId',
- 'FsName',
- ],
- ],
+ 'schema' => ['description' => 'The filter key used when querying resources.'."\n"
+ ."\n"
+ .'Use with FilterValue. Valid values: InstanceId or InstanceName.'."\n"
+ ."\n"
+ .'If you specify InstanceId, the system filters by ECS instance ID. If you specify InstanceName, the system filters by ECS instance name.', 'type' => 'string', 'required' => false, 'example' => 'InstanceName', 'title' => ''],
],
[
'name' => 'FilterValue',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DBFS1',
- ],
+ 'schema' => ['description' => 'The filter value used when querying resources.'."\n"
+ ."\n"
+ .'Use with FilterKey.', 'type' => 'string', 'required' => false, 'example' => 'autotest1', 'title' => ''],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'PlainResponse<PageResponse<DbfsOnAutoSnapshotPolicyViewModel>>',
- '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' => '',
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '3724CFEF-02DA-578B-AED6-67EE80671B4A', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries in the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ 'EcsLabelInfo' => [
+ 'description' => 'The collection of ECS instances.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Information about an ECS instance.',
'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',
- ],
- ],
+ 'value' => ['description' => 'The ID of the ECS instance.', 'type' => 'string', 'example' => 'i-bp10jb8mqajkmrejgo00', 'title' => ''],
+ 'label' => ['description' => 'The name of the ECS instance.', 'type' => 'string', 'example' => 'dbfs-test-01', 'title' => ''],
+ 'InstanceTypeFamily' => ['description' => 'The instance type family of the ECS instance.', 'type' => 'string', 'example' => 'ecs.g7se', 'title' => ''],
+ 'OSName' => ['description' => 'The name of the operating system on the ECS instance.', 'type' => 'string', 'example' => 'Alibaba Cloud Linux 2.1903 LTS 64 bit', 'title' => ''],
+ 'Status' => ['description' => 'The status of the ECS instance:'."\n"
+ ."\n"
+ .'- Pending: The instance is being created.'."\n"
+ ."\n"
+ .'- Running: The instance is running.'."\n"
+ ."\n"
+ .'- Starting: The instance is starting.'."\n"
+ ."\n"
+ .'- Stopping: The instance is stopping.'."\n"
+ ."\n"
+ .'- Stopped: The instance is stopped.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
+ 'ImageId' => ['description' => 'The ID of the image.', 'type' => 'string', 'example' => 'm-bp67acfmxazb4p****', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'The policy type.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'The ID of the owner of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ParameterEmpty.PolicyId',
- 'errorMessage' => 'The value of policyId is empty.',
- ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
- [
- [
- 'errorCode' => 'PermissionDeny.Policy',
- 'errorMessage' => 'The account has no permission on this policy.',
+ ],
+ '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"}]',
+ 'title' => 'Query mountable ECS instances ',
+ 'summary' => 'Call ListDbfsAttachableEcsInstances to query the list of ECS instances that can be attached to a DBFS file system.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-01-29T12:50:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-08-22T08:26:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-08-22T06:18:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-12-29T11:42:19.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListDbfsAttachableEcsInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 404 => [
- [
- 'errorCode' => 'InvalidRegionId.NotFound',
- 'errorMessage' => 'The specified RegionId does not exist.',
- ],
- [
- 'errorCode' => 'AutoSnapshotPolicyNotFound',
- 'errorMessage' => 'The automatic snapshot policy does not exist.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDbfsAttachableEcsInstances'],
],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
- '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',
- ],
+ 'ListDbfsAttachedEcsInstances' => [
+ 'summary' => 'You can call the ListDbfsAttachedEcsInstances operation to query the ECS instances on which a DBFS is mounted.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '15805',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsQMJ6C8',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'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"]',
- ],
+ 'schema' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'FsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
- ],
+ 'schema' => ['description' => 'The ID of the DBFS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-nUy1tb********BQ4X8Gpw', 'title' => ''],
],
],
'responses' => [
@@ -5228,341 +3355,509 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'EcsLabelInfo' => [
+ 'description' => 'The collection of ECS instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MountPoint' => ['description' => 'The mount target of the DBFS instance.', 'type' => 'string', 'example' => '/mnt/dbfs/dbfs-nUy1tb********BQ4X8Gpw', 'title' => ''],
+ 'value' => ['description' => 'The ID of the ECS instance.', 'type' => 'string', 'example' => 'i-bp10jb8mqajkmrejgo00', 'title' => ''],
+ 'label' => ['description' => 'The name of the ECS instance.', 'type' => 'string', 'example' => 'dbfs-test-01', 'title' => ''],
+ 'MountedTime' => ['description' => 'The time when DBFS was mounted. This value is a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1606290930000', 'title' => ''],
+ 'InstanceTypeFamily' => ['description' => 'The instance type family of the ECS instance.', 'type' => 'string', 'example' => 'ecs.g7se', 'title' => ''],
+ 'OSName' => ['description' => 'The name of the operating system on the ECS instance.', 'type' => 'string', 'example' => 'Alibaba Cloud Linux 2.1903 LTS 64 bit', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'The type of policy.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'The ID of the owner of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
],
- '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":"<DeleteTagsBatchResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DeleteTagsBatchResponse>","errorExample":""}]',
- 'title' => 'DeleteTagsBatch',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query mounted ECS instances',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'TagDbfs' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-12-29T11:01:25.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListDbfsAttachedEcsInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDbfsAttachedEcsInstances'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ListSnapshot' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '15821',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsQMJ6C8',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the DBFS instance. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba Cloud region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DbfsId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dbfs-nUy1tb********BQ4X8Gpw',
- ],
+ 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10240', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page for paged query.'."\n"
+ ."\n"
+ .'Maximum: 100.'."\n"
+ ."\n"
+ .'Default: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'default' => '10', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Set the sorting method for snapshots.'."\n"
+ ."\n"
+ .'Use with SortType. The value must be SnapshotSize or CreatedTime.'."\n"
+ ."\n"
+ .'SnapshotSize sorts by snapshot size. CreatedTime sorts by creation time.'."\n"
+ ."\n"
+ .'By default, sort by creation time in descending order.', 'type' => 'string', 'required' => false, 'example' => 'SnapshotSize', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Set the sorting method for snapshots.'."\n"
+ ."\n"
+ .'Use with SortKey. The value must be asc or desc.'."\n"
+ ."\n"
+ .'If the value is asc, sort in ascending order. If the value is desc, sort in descending order.'."\n"
+ ."\n"
+ .'By default, sort by creation time in descending order.',
+ 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'],
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
+ 'required' => false,
+ 'example' => 'desc',
+ 'title' => '',
],
],
+ [
+ 'name' => 'FilterKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The filter key for querying snapshots.'."\n"
+ ."\n"
+ .'Use with FilterValue. The value must be SnapshotId or SnapshotName.'."\n"
+ ."\n"
+ .'If SnapshotId is passed, filter by snapshot ID. If SnapshotName is passed, filter by snapshot name.', 'type' => 'string', 'required' => false, 'example' => 'SnapshotId', 'title' => ''],
+ ],
+ [
+ 'name' => 'FilterValue',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The filter value for querying snapshots.'."\n"
+ ."\n"
+ .'Use with FilterKey.', 'type' => 'string', 'required' => false, 'example' => 's-bp67acfmxazb4p****', 'title' => ''],
+ ],
+ [
+ 'name' => 'FsId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DBFS ID.', 'type' => 'string', 'required' => false, 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Snapshot status. Valid values:'."\n"
+ ."\n"
+ .'- progressing: The snapshot is being created.'."\n"
+ ."\n"
+ .'- accomplished: The snapshot was created successfully.'."\n"
+ ."\n"
+ .'- failed: The snapshot failed to be created.'."\n"
+ ."\n"
+ .'- all (default): All snapshot statuses.', 'type' => 'string', 'required' => false, 'example' => 'accomplished', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Snapshot name.', 'type' => 'string', 'required' => false, 'example' => 'testSnapshotName', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Snapshot creation type. Currently, only manual snapshots are supported.'."\n"
+ ."\n"
+ .'- user: Manual snapshot.'."\n"
+ ."\n"
+ .'- all (default): All snapshot creation types.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Snapshot code. The value can be a JSON array of multiple snapshot IDs. It supports a maximum of 100 IDs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"]', 'title' => ''],
+ ],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
+ 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page set in the input.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Snapshots' => [
+ 'description' => 'Snapshot collection.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'Snapshot status. Possible values:'."\n"
+ ."\n"
+ .'- progressing'."\n"
+ ."\n"
+ .'- accomplished'."\n"
+ ."\n"
+ .'- failed', 'type' => 'string', 'example' => 'accomplished', 'title' => ''],
+ 'CreationTime' => ['description' => 'Snapshot creation time.', 'type' => 'string', 'example' => '1609330367000', 'title' => ''],
+ 'Progress' => ['description' => 'Snapshot progress.', 'type' => 'string', 'example' => '100%', 'title' => ''],
+ 'SourceFsSize' => ['description' => 'The size of the source file system.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'RetentionDays' => ['description' => 'Snapshot retention days.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'RemainTime' => ['description' => 'The remaining time, in seconds, for the snapshot to complete creation.', 'type' => 'integer', 'format' => 'int32', 'example' => '38', 'title' => ''],
+ 'LastModifiedTime' => ['description' => 'Snapshot last modified time.', 'type' => 'string', 'example' => '1609330367000', 'title' => ''],
+ 'SnapshotType' => ['description' => 'Snapshot creation type. Possible values:'."\n"
+ ."\n"
+ .'- auto: Automatic snapshot.'."\n"
+ ."\n"
+ .'- user: Manual snapshot.'."\n"
+ ."\n"
+ .'- all (default): All snapshot creation types.', 'type' => 'string', 'example' => 'user', 'title' => ''],
+ 'SnapshotName' => ['description' => 'Snapshot display name. Returns if a snapshot display name was specified during creation.', 'type' => 'string', 'example' => 'testSnapshotName', 'title' => ''],
+ 'Description' => ['description' => 'Snapshot description.', 'type' => 'string', 'example' => 'testDescription', 'title' => ''],
+ 'SourceFsId' => ['description' => 'The ID of the source DBFS.', 'type' => 'string', 'example' => 'dbfs-bp67acfmxazb4p****', 'title' => ''],
+ 'SnapshotId' => ['description' => 'Snapshot ID.', 'type' => 'string', 'example' => 's-bp67acfmxazb4p****', 'title' => ''],
+ 'Category' => [
+ 'description' => 'Snapshot type. Possible values:'."\n"
+ ."\n"
+ .'- standard: Standard Edition.'."\n"
+ ."\n"
+ .'- enterprise: Enterprise Edition.',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'example' => 'standard',
+ 'title' => '',
+ ],
+ 'SourceFsStripeWidth' => ['description' => 'Source DBFS stripe width.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
],
- '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":"<TagDbfsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</TagDbfsResponse>","errorExample":""}]',
- 'title' => 'TagDbfs',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query snapshots',
+ 'summary' => 'Call ListSnapshot to query user-created DBFS snapshots.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'AddTagsBatch' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-01-07T02:58:41.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSnapshot'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ListSnapshotLinks' => [
+ 'summary' => 'Lists the snapshot chains in a region that match your criteria.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '15798',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsQMJ6C8',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '159557',
+ 'abilityTreeNodes' => ['FEATUREdbfs3RTJEH'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DbfsList',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["dbfs-nUy1tb********BQ4X8Gpw","dbfs-v0WvA********tVEVcgJLg"]',
- ],
+ 'schema' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '999999', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page for a paged query.'."\n"
+ ."\n"
+ .'Maximum: 100.'."\n"
+ ."\n"
+ .'Default: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'default' => '10', 'example' => '10', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'FilterKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The filter key used to list snapshot chains.'."\n"
+ ."\n"
+ .'Use with FilterValue. Valid values: LinkId or FsId.'."\n"
+ ."\n"
+ .'If you set FilterKey to LinkId, the operation filters by snapshot chain ID. If you set FilterKey to FsId, the operation filters by file system ID.', 'type' => 'string', 'required' => false, 'example' => 'FsId', 'title' => ''],
+ ],
+ [
+ 'name' => 'FilterValue',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The filter value used to list snapshot chains.'."\n"
+ ."\n"
+ .'Use with FilterKey.', 'type' => 'string', 'required' => false, 'example' => 'dbfs-kwziq4dpsle********', 'title' => ''],
+ ],
+ [
+ 'name' => 'FsIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IDs of database file systems. You can specify up to 100 IDs. Format the value as a JSON array. Separate IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["dbfs-kwziq4dpsle********","dbfs-vuaqvfcjqsg********"]', 'title' => ''],
+ ],
+ [
+ 'name' => 'LinkIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IDs of snapshot chains. You can specify up to 100 IDs. Format the value as a JSON array. Separate IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["sl-bp1grgphbcc9brb5****","sl-bp1c4izumvq0i5bs****","sl-bp1akk7isz866dds****"]', 'title' => ''],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries returned on each page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'SnapshotLinks' => [
+ 'description' => 'A collection of snapshot chain information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Snapshot chain information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the database file system.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- unattached Not attached'."\n"
+ ."\n"
+ .'- attached Attached'."\n"
+ ."\n"
+ .'- creating Creating'."\n"
+ ."\n"
+ .'- attaching Attaching'."\n"
+ ."\n"
+ .'- detaching Detaching'."\n"
+ ."\n"
+ .'- deleting Deleting'."\n"
+ ."\n"
+ .'- deleted Deleted'."\n"
+ ."\n"
+ .'- resizing Scaling up'."\n"
+ ."\n"
+ .'- snapshotting Taking snapshots'."\n"
+ ."\n"
+ .'- upgrading Upgrading', 'type' => 'string', 'example' => 'attached', 'title' => ''],
+ 'TotalSize' => ['description' => 'The total size of all snapshots in the snapshot chain, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => ' '."\n"
+ .'50331648', 'title' => ''],
+ 'SourceSize' => ['description' => 'The capacity of the database file system, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'FsId' => ['description' => 'The ID of the database file system.', 'type' => 'string', 'example' => 'dbfs-q7qsgyqptjk******', 'title' => ''],
+ 'EcsList' => [
+ 'description' => 'A collection of ECS instances to which the file system is attached.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'An attached ECS instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EcsId' => ['description' => 'The ID of the attached ECS instance.', 'type' => 'string', 'example' => 'i-bp1f4eo2biro*******', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SnapshotCount' => ['description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'FsName' => ['description' => 'The DBFS instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'LinkId' => ['description' => 'The ID of the snapshot chain.', 'type' => 'string', 'example' => 'sl-b3zlgraysgcs9jy*******', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'EntityNotExist.DBFS',
- 'errorMessage' => 'The DBFS instance does not exist.',
+ ],
+ '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"}]',
+ 'title' => 'Query snapshot chains',
+ 'description' => 'Note the following when you call this operation:'."\n"
+ ."\n"
+ .'- The request parameters RegionId, FsIds, and LinkIds act as filters. These parameters are joined by a logical AND operator.'."\n"
+ ."\n"
+ .'- If you do not specify any filter parameters, no filtering is applied. If FsIds or LinkIds is an empty array, no filtering is applied.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-03-16T11:48:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListSnapshotLinks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<AddTagsBatchResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</AddTagsBatchResponse>","errorExample":""}]',
- 'title' => 'AddTagsBatch',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSnapshotLinks'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
+ ],
],
'ListTagKeys' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5570,20 +3865,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
@@ -5591,79 +3878,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'TagKeys' => [
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["key1", "key2"]',
- ],
+ 'items' => ['description' => 'A tag key.', 'type' => 'string', 'example' => '["key1", "key2"]', 'title' => ''],
+ 'description' => 'The list of tag keys.',
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'The type of policy.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'The ID of the owner of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
],
- '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":"<ListTagKeysResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <TagKeys>key1</TagKeys>\\n <TagKeys>key2</TagKeys>\\n</ListTagKeysResponse>","errorExample":""}]',
- 'title' => 'ListTagKeys',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query tag keys',
+ 'summary' => 'Call ListTagKeys to query all existing tag keys.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListTagValues' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListTagKeys',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagKeys'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ListTagValues' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5671,31 +3952,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'TagKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'tagKey1',
- ],
+ 'schema' => ['description' => 'The tag key of the resource. The value can be up to 64 characters in length and can contain letters, digits, Chinese characters, and special characters such as @ \\_ - = + ; : , < . > / ?', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tagKey1', 'title' => ''],
],
],
'responses' => [
@@ -5703,358 +3970,544 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'TagValues' => [
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["tagValue1", "tagValue2"]',
- ],
+ 'items' => ['description' => 'A tag value.', 'type' => 'string', 'example' => '["tagValue1", "tagValue2"]', 'title' => ''],
+ 'description' => 'The list of tag values.',
+ 'title' => '',
+ 'example' => '',
],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'The type of policy.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'The ID of the owner of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'The type of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'The display name of the authenticated principal.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'The action that requires authorization.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
],
],
- '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":"<ListTagValuesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <TagValues>tagValue1</TagValues>\\n <TagValues>tagValue2</TagValues>\\n</ListTagValuesResponse>","errorExample":""}]',
- 'title' => 'ListTagValues',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query tag values ',
+ 'summary' => 'Call ListTagValues to retrieve all values associated with a specific tag key.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateServiceLinkedRole' => [
- 'summary' => '创建DBFS服务关联角色',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListTagValues',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagValues'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'ModifyAutoSnapshotPolicy' => [
+ 'summary' => 'Modifies an automatic snapshot policy. After you modify the policy, all DBFS file systems that use this policy immediately apply the updated settings.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '15801',
- 'abilityTreeNodes' => [
- 'FEATUREdbfsUCP4CQ',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'PolicyId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sp-z5siir3iq3m**********'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'PolicyName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the automatic snapshot policy.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'policyTest'],
+ ],
+ [
+ 'name' => 'RetentionDays',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of days to retain automatic snapshots.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65536', 'minimum' => '-1', 'title' => '', 'example' => '30'],
+ ],
+ [
+ 'name' => 'RepeatWeekdays',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A list of days of the week when automatic snapshots repeat. Valid values: 1 to 7. For example, 1 means Monday. Format rules:'."\n"
+ ."\n"
+ .'- Pass the parameter as a JSON array. For example, \\["1"] creates an automatic snapshot every Monday.'."\n"
+ ."\n"
+ .'- To create multiple automatic snapshots in one week, pass multiple values separated by commas (,). You can pass up to seven values. For example, \\["1","3","5"] creates automatic snapshots every Monday, Wednesday, and Friday.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The day of the week when automatic snapshots repeat.', 'type' => 'string', 'required' => false, 'example' => '"1"', 'title' => ''],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ 'maxItems' => 7,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'AutoCreateServiceLinkedRole',
+ 'name' => 'TimePoints',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'description' => 'The times at which to create automatic snapshots. Times are specified in UTC+8 and must be integers from 0 to 23, representing the hour of the day from 00:00 to 23:00. For example, a value of 1 indicates 01:00. The parameter must be a JSON array. For example, \\["1"] creates an automatic snapshot at 01:00. To create multiple automatic snapshots per day, specify up to 24 time points in the array. For example, \\["1", "3", "15"] creates automatic snapshots at 01:00, 03:00, and 15:00.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The time when an automatic snapshot is created.', 'type' => 'string', 'required' => false, 'example' => '"01"', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 24,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region. To view the latest list of Alibaba Cloud regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'The type of the policy.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'The ID of the owner of the principal that lacks permissions.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'The type of the principal that lacks permissions.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'The display name of the principal that lacks permissions.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'The action that requires permissions.', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
+ ['errorCode' => 'ParameterInvalid.RetentionDays', 'errorMessage' => 'The RetentionDays parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.RepeatWeekDays', 'errorMessage' => 'The RepeatWeekdays parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.TimePoints', 'errorMessage' => 'The TimePoints parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'ParameterEmpty.PolicyId', 'errorMessage' => 'The value of policyId is empty.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.PolicyName', 'errorMessage' => 'The PolicyName parameter is invalid.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'PermissionDeny.Policy', 'errorMessage' => 'The account has no permission on this policy.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'AutoSnapshotPolicyNotFound', 'errorMessage' => 'The automatic snapshot policy does not exist.', 'description' => ''],
+ ],
+ 409 => [
+ ['errorCode' => 'OperationConflict', 'errorMessage' => 'Too many requests on automatic snapshot policy, please try again later.', 'description' => ''],
+ ],
+ 503 => [
+ ['errorCode' => 'AutoShapshotBusy', 'errorMessage' => 'The server is busy now, please try again later.', 'description' => ''],
+ ],
+ ],
+ '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"}]',
+ 'title' => 'Modify Automatic Snapshot Policy',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:ModifyAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
],
],
],
- '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":"<CreateServiceLinkedRoleResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</CreateServiceLinkedRoleResponse>","errorExample":""}]',
- 'title' => 'CreateServiceLinkedRole',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoSnapshotPolicy'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
+ ],
],
- 'GetServiceLinkedRole' => [
- 'methods' => [
- 'post',
- 'get',
+ 'ModifySnapshotAttribute' => [
+ 'summary' => 'Modifies the name and description of a snapshot.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region. Call DescribeRegions to query the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-y2vZ3********vvMilZ2hQ', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The display name of the snapshot. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. The name can contain English or Chinese characters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n"
+ ."\n"
+ .'To prevent conflicts with automatic snapshot names, the name cannot start with auto or dbfs-auto.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testSnapshotName', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n"
+ ."\n"
+ .'Default value: empty.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testDescription', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
+ 'AccessDeniedDetail' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyType' => ['title' => 'PolicyType', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.SnapshotDescription', 'errorMessage' => 'The SnapshotDescription parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'ParameterInvalid.SnapshotName', 'errorMessage' => 'The SnapshotName parameter is invalid.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.Snapshot', 'errorMessage' => 'The snapshot does not exist.', 'description' => ''],
+ ],
+ ],
+ '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"}]',
+ 'title' => 'Modify Snapshot Properties ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:ModifySnapshotAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifySnapshotAttribute'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
+ ],
+ ],
+ 'RenameDbfs' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '15808',
- 'abilityTreeNodes' => [
- 'FEATUREdbfs29ABXP',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '15818',
+ 'abilityTreeNodes' => ['FEATUREdbfs3HYCOJ'],
],
'parameters' => [
[
+ 'name' => 'FsName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new name of the DBFS.'."\n"
+ ."\n"
+ .'The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and can contain digits, underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NewDbfsName', 'title' => ''],
+ ],
+ [
+ 'name' => 'FsId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the DBFS.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region where the DBFS instance is located. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-zhangjiakou', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6AE8A242-E12D-55AC-A75D-F707020AD0D6', 'title' => ''],
+ 'AccessDeniedDetail' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidName.DBFS', 'errorMessage' => 'Invalid DBFS instance name.', 'description' => ''],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
+ ],
+ ],
+ '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' => 'Rename Database File System',
+ 'summary' => 'Renames a database file system (DBFS).',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T07:44:34.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:RenameDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenameDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
+ ],
+ ],
+ 'ResizeDbfs' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID of the DBFS instance. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'FsId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the database file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
+ ],
+ [
+ 'name' => 'NewSizeG',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The capacity of the database file system after resizing. It must be greater than its capacity before resizing. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '20', 'example' => '40', 'title' => ''],
+ ],
+ ],
'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',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'InvalidSize.DBFS', 'errorMessage' => 'The size of DBFS is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidStatus.DBFS', 'errorMessage' => 'The current state of the DBFS instance does not support this operation.', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'PermissionDeny.DBFS',
- 'errorMessage' => 'RAM permission verification failed.',
- ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
],
- '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":"<GetServiceLinkedRoleResponse>\\n <AccountId>1352345930******</AccountId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <DbfsLinkedRole>true</DbfsLinkedRole>\\n <RegionId>cn-hangzhou</RegionId>\\n</GetServiceLinkedRoleResponse>","errorExample":""}]',
- 'title' => 'GetServiceLinkedRole',
- ],
- 'DescribeDbfsSpecifications' => [
- 'summary' => '查询DBFS支持的ECS实例类型，根据ECS实例规格返回ECS可挂载的最大DBFS数量',
- 'methods' => [
- 'post',
- 'get',
+ '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"}]',
+ 'title' => 'Scale-out database file system',
+ 'summary' => 'Call ResizeDbfs to resize a DBFS (database file system).',
+ 'description' => '- The new capacity of the DBFS must be greater than its current capacity.'."\n"
+ ."\n"
+ .'- The DBFS must be in the attached state.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-03-02T13:03:00.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:ResizeDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResizeDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'TagDbfs' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdbfs9JXLXY',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '15821',
+ 'abilityTreeNodes' => ['FEATUREdbfsQMJ6C8'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'EcsInstanceType',
+ 'name' => 'DbfsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ecs.g7se',
- ],
+ 'schema' => ['description' => 'The ID of the database file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-nUy1tb********BQ4X8Gpw', 'title' => ''],
],
[
- 'name' => 'Category',
+ 'name' => 'Tags',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'enterprise',
- ],
+ 'schema' => ['description' => 'The list of tags to set.'."\n"
+ ."\n"
+ .'TagKey: The tag key of the resource. The tag key can be up to 64 characters in length and can contain uppercase and lowercase letters, Chinese characters, digits, and the following special characters: @\\_-=+;:,<.>/?'."\n"
+ ."\n"
+ .'TagValue: The tag value of the resource. The tag value can be up to 128 characters in length and can contain uppercase and lowercase letters, Chinese characters, digits, and the following special characters: @\\_-=+;:,<.>/?', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]', 'title' => ''],
],
],
'responses' => [
@@ -6062,247 +4515,996 @@
'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',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => '',
'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',
- ],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'PolicyType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'AuthPrincipalOwnerId', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'EncodedDiagnosticMessage', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'AuthPrincipalType', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'AuthPrincipalDisplayName', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType', 'description' => 'NoPermissionType', 'type' => 'string', 'example' => ''],
+ 'AuthAction' => ['title' => 'AuthAction', 'description' => 'AuthAction', 'type' => 'string', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
- ],
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
],
],
- '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',
+ '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"}]',
+ 'title' => 'Set Tags',
+ 'summary' => 'Call TagDbfs to assign tags to a DBFS (database file system).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeInstanceTypes' => [
- 'summary' => '查询DBFS实例规格',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:TagDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
],
+ ],
+ 'UpdateDbfs' => [
+ 'summary' => 'Update the instance type and scenario of a Database File System (DBFS) instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdbfs29ABXP',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '150809',
+ 'abilityTreeNodes' => ['FEATUREdbfsS28E99', 'FEATUREdbfsQMJ6C8'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region where the DBFS instance resides. To view the latest list of Alibaba Cloud regions, see [DescribeRegions](https://help.aliyun.com/document_detail/25609.html).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'FsId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the Database File System (DBFS) instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbfs-GOrr********Yd0VLOyBpg', 'title' => ''],
+ ],
+ [
+ 'name' => 'UsedScene',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The updated scenario. Valid values:'."\n"
+ ."\n"
+ .'- MySQL 5.7'."\n"
+ ."\n"
+ .'- PostgreSQL'."\n"
+ ."\n"
+ .'- MongoDB'."\n"
+ ."\n"
+ .'- Oracle RAC', 'type' => 'string', 'required' => false, 'example' => 'MySQL 5.7', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The updated instance type. Valid values:'."\n"
+ ."\n"
+ .'- dbfs.small'."\n"
+ ."\n"
+ .'- dbfs.medium'."\n"
+ ."\n"
+ .'- dbfs.large (default)',
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- 'title' => '地域ID',
+ 'enum' => ['dbfs.small', 'dbfs.medium', 'dbfs.large'],
+ 'required' => false,
+ 'example' => 'dbfs.medium',
+ 'title' => '',
],
],
+ [
+ 'name' => 'AdvancedFeatures',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Customize CPU core count, maximum memory size, and page cache size for the DBFS instance.', 'type' => 'string', 'required' => false, 'example' => '{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Response object',
'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',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''],
'AccessDeniedDetail' => [
+ 'description' => 'Details about an access-denied error.',
+ 'title' => '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',
- ],
+ 'AuthAction' => ['title' => 'AuthAction ', 'description' => 'The action that was denied.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalDisplayName' => ['title' => 'AuthPrincipalDisplayName ', 'description' => 'The display name of the principal that was denied access.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalOwnerId' => ['title' => 'AuthPrincipalOwnerId ', 'description' => 'The ID of the owner of the principal that was denied access.', 'type' => 'string', 'example' => ''],
+ 'AuthPrincipalType' => ['title' => 'AuthPrincipalType ', 'description' => 'The type of the principal that was denied access.', 'type' => 'string', 'example' => ''],
+ 'EncodedDiagnosticMessage' => ['title' => 'EncodedDiagnosticMessage ', 'description' => 'An encoded diagnostic message for the access-denied error.', 'type' => 'string', 'example' => ''],
+ 'NoPermissionType' => ['title' => 'NoPermissionType ', 'description' => 'The type of permission that is missing.', 'type' => 'string', 'example' => ''],
+ 'PolicyType' => ['title' => 'PolicyType ', 'description' => 'The type of policy that caused the access denial.', 'type' => 'string', 'example' => ''],
],
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRegion.DBFS',
- 'errorMessage' => 'The region is not supported.',
+ ['errorCode' => 'InvalidRegion.DBFS', 'errorMessage' => 'The region is not supported.', 'description' => ''],
+ ['errorCode' => 'InvalidStatus.DBFS', 'errorMessage' => 'The current state of the DBFS instance does not support this operation.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.DBFS', 'errorMessage' => 'The DBFS instance does not exist.', 'description' => ''],
+ ],
+ ],
+ '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"}]',
+ 'title' => 'Modify Database File System ',
+ 'changeSet' => [
+ ['createdAt' => '2025-02-17T07:27:21.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-31T03:35:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-11-06T09:56:27.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-08-17T09:02:07.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateDbfs'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => '数据库文件存储'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:UpdateDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/{#FsId}'],
+ ],
],
],
],
- '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' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dbfs.ap-southeast-1.aliyuncs.com', 'vpc' => 'dbfs-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-beijing.aliyuncs.com', 'endpoint' => 'dbfs.cn-beijing.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-chengdu.aliyuncs.com', 'endpoint' => 'dbfs.cn-chengdu.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbfs.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-hongkong.aliyuncs.com', 'endpoint' => 'dbfs.cn-hongkong.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-huhehaote.aliyuncs.com', 'endpoint' => 'dbfs.cn-huhehaote.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-shanghai.aliyuncs.com', 'endpoint' => 'dbfs.cn-shanghai.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dbfs.cn-shenzhen.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dbfs.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'dbfs.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'dbfs-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AutoShapshotBusy', 'message' => 'The server is busy now, please try again later.', 'http_code' => 503, 'description' => ''],
+ ['code' => 'AutoSnapshotPolicyNotFound', 'message' => 'The automatic snapshot policy does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'DbfsAlreadyAppliedAutoSnapshotPolicy', 'message' => 'An automatic snapshot policy has been applied on the specified dbfs.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DbfsId.StatusNotSupported', 'message' => 'The specified DBFS status does not support the operation.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'DbfsWithAutoSnapshotPolicy.NotFound', 'message' => 'Dbfs cancel failed.The specified dbfs does not apply this auto snapshot policy or does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EntityAlreadyExist.Role', 'message' => 'The service-linked role for DBFS already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EntityNotExist.DBFS', 'message' => 'The DBFS instance does not exist.(EntityNotExist.DBFS)', 'http_code' => 404, 'description' => ''],
+ ['code' => 'EntityNotExist.ECS', 'message' => 'The ECS instance does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'EntityNotExist.Snapshot', 'message' => 'The snapshot does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'ExceedMaxCount.Tag', 'message' => 'The number of labels exceeds the upper limit.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.RAM', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IncorrectDiskStatus.CreatingSnapshot', 'message' => 'The current database file system has a snapshot being created, please wait for the creation to complete and then try again.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'IncorrectInstanceStatus', 'message' => 'The current status of the resource does not support this operation.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InternalError', 'message' => 'An error occurred while processing your request. Please try again. If the problem still exists, submit a ticket.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InternalError', 'message' => 'A server internal error occurred.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InvalidCategory.DBFS', 'message' => 'The category is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDbfs.AlreadyDetached', 'message' => 'The specified DBFS has been detached.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidDbfsCategory.NotSupported', 'message' => 'The specified DBFS category is not supported.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InvalidDbfsCategory.NotSupported', 'message' => 'The specified DBFS category does not support online resizing.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InvalidDbfsId.NotFound', 'message' => 'The specified DBFS does not exist. Please check the ID.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidDbfsSize.TooLarge', 'message' => 'The size of the newly specified DBFS exceeds the limit.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InvalidDbfsSize.TooSmall', 'message' => 'The size of the newly specified DBFS is smaller than the original DBFS', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The specified InstanceId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidName.DBFS', 'message' => 'Invalid DBFS instance name.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPerformanceLevel.DBFS', 'message' => 'The performance level is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.DBFS', 'message' => 'The region is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionId.NotFound', 'message' => 'The specified RegionId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidSize.DBFS', 'message' => 'The size of DBFS is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSize.ValueNotSupported', 'message' => 'The specified Size is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStatus.DBFS', 'message' => 'The current state of the DBFS instance does not support this operation.(InvalidStatus.DBFS)', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidZone.DBFS', 'message' => 'The zone is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidZoneId.NotFound', 'message' => 'The specified zone does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'MissingParamter.RegionId', 'message' => 'You must specify regionId.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'NotRunning.ECS', 'message' => 'The ECS instance is not in the running state.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OperationConflict', 'message' => 'Too many requests on automatic snapshot policy, please try again later.', 'http_code' => 409, 'description' => ''],
+ ['code' => 'ParameterEmpty.PolicyId', 'message' => 'The value of policyId is empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterEmpty.SnapshotId', 'message' => 'The value of snapshotId is empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterEmpty.SnapshotIds', 'message' => 'The value of snapshotIds is empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterExceed.SnapshotId', 'message' => 'The maximum number of snapshot ID has been reached.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterExceed.SnapshotIds', 'message' => 'The maximum number of snapshot ID has been reached.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.DbfsIds', 'message' => 'The DbfsIds parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.PolicyName', 'message' => 'The PolicyName parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.RepeatWeekDays', 'message' => 'The RepeatWeekdays parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.RetentionDays', 'message' => 'The RetentionDays parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.SnapshotDescription', 'message' => 'The SnapshotDescription parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.SnapshotId', 'message' => 'The SnapshotId parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.SnapshotIds', 'message' => 'The SnapshotIds parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.SnapshotName', 'message' => 'The SnapshotName parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParameterInvalid.TimePoints', 'message' => 'The TimePoints parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'PermissionDeny.DBFS', 'message' => 'RAM permission verification failed.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'PermissionDeny.Policy', 'message' => 'The account has no permission on this policy.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'PermissionDeny.Snapshot', 'message' => 'The account has no permission on this snapshot.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'PermissionDeny.SnapshotLink', 'message' => 'The account has no permission on this snapshot link.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'QuotaExceed.AutoSnapshotPolicy', 'message' => 'The maximum number of automatic snapshot policy has been reached.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'QuotaExceed.Dbfs', 'message' => 'The maximum number of DBFS is exceeded.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'ResourcesNotInSameZone', 'message' => 'The specified instance and DBFS are not in the same zone.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'SnapshotCreatedDbfs', 'message' => 'A cloned DBFS exists under the current snapshot.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'SnapshotLinkNotFound', 'message' => 'The snapshot link does not exist.', 'http_code' => 404, 'description' => ''],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'AddTagsBatch'],
+ ['description' => 'Response parameters changed', 'api' => 'ApplyAutoSnapshotPolicy'],
+ ['description' => 'Response parameters changed', 'api' => 'AttachDbfs'],
+ ['description' => 'Response parameters changed', 'api' => 'CancelAutoSnapshotPolicy'],
+ ['description' => 'Response parameters changed', 'api' => 'CreateAutoSnapshotPolicy'],
+ ['description' => 'Response parameters changed', 'api' => 'CreateDbfs'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateServiceLinkedRole'],
+ ['description' => 'Response parameters changed', 'api' => 'CreateSnapshot'],
+ ['description' => 'Response parameters changed', 'api' => 'DeleteAutoSnapshotPolicy'],
+ ['description' => 'Response parameters changed', 'api' => 'DeleteDbfs'],
+ ],
+ 'createdAt' => '2024-12-31T03:35:38.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'RenameDbfs'],
+ ],
+ 'createdAt' => '2024-12-05T07:44:19.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListDbfs'],
+ ],
+ 'createdAt' => '2024-02-27T09:13:54.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListDbfsAttachableEcsInstances'],
+ ],
+ 'createdAt' => '2024-01-29T12:50:00.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed, Response parameters changed, Response parameters changed', 'api' => 'GetDbfs'],
+ ],
+ 'createdAt' => '2023-11-07T11:50:25.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'UpdateDbfs'],
+ ],
+ 'createdAt' => '2023-11-06T09:56:23.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSnapshotLinks'],
+ ],
+ 'createdAt' => '2023-03-16T11:31:16.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'ListAutoSnapshotPolicyAppliedDbfs'],
+ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'ListAutoSnapshotPolicyUnappliedDbfs'],
+ ],
+ 'createdAt' => '2023-01-06T06:07:26.000Z',
+ 'description' => '修改SnapshotCount和TotalSize参数类型。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteDbfs'],
+ ],
+ 'createdAt' => '2023-01-05T01:43:13.000Z',
+ 'description' => '新增force参数，支持强制释放DBFS',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetDbfs'],
+ ],
+ 'createdAt' => '2023-01-04T03:06:55.000Z',
+ 'description' => '修改“totalSize”为大驼峰形式“TotalSize”。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetDbfs'],
+ ['description' => 'Response parameters changed', 'api' => 'ListAutoSnapshotPolicyAppliedDbfs'],
+ ['description' => 'Response parameters changed', 'api' => 'ListAutoSnapshotPolicyUnappliedDbfs'],
+ ['description' => 'Response parameters changed', 'api' => 'ListDbfs'],
+ ],
+ 'createdAt' => '2023-01-03T02:42:00.000Z',
+ 'description' => '增加快照信息显示',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CancelAutoSnapshotPolicy'],
+ ],
+ 'createdAt' => '2022-12-15T06:36:40.000Z',
+ 'description' => '修改参数是否必填选项。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListDbfsAttachableEcsInstances'],
+ ],
+ 'createdAt' => '2022-08-22T08:27:11.000Z',
+ 'description' => '查询可挂载的ecs列表接口新增过滤参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListDbfsAttachableEcsInstances'],
+ ],
+ 'createdAt' => '2022-08-22T06:19:25.000Z',
+ 'description' => '查询可挂载的ECS列表接口新增分页参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'UpdateDbfs'],
+ ],
+ 'createdAt' => '2022-08-17T09:02:23.000Z',
+ 'description' => '新增修改DBFS接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateDbfs'],
+ ],
+ 'createdAt' => '2022-08-15T06:47:18.000Z',
+ 'description' => '创建DBFS增加AdvancedFeature参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListSnapshot'],
+ ],
+ 'createdAt' => '2022-03-22T08:39:11.000Z',
+ 'description' => '查询快照时返回源dbfs的条带宽度',
+ ],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'dbfs.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateDbfs'],
+ ['description' => 'Request parameters changed', 'api' => 'ResizeDbfs'],
+ ],
+ 'createdAt' => '2022-03-02T13:03:55.000Z',
+ 'description' => '支持RAID0',
],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'dbfs.cn-zhangjiakou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateDbfs'],
+ ],
+ 'createdAt' => '2022-02-28T09:26:32.000Z',
+ 'description' => '性能等级默认值PL1',
],
[
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'dbfs.cn-huhehaote.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetDbfs'],
+ ['description' => 'Response parameters changed', 'api' => 'ListDbfs'],
+ ],
+ 'createdAt' => '2022-01-19T15:22:02.000Z',
+ 'description' => '查询DBFS接口新增返回上一次失败的原因',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListDbfsAttachableEcsInstances'],
+ ],
+ 'createdAt' => '2021-12-29T11:43:03.000Z',
+ 'description' => '查询ecs列表接口新增instanceTypeFamily字段',
],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'dbfs.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListDbfsAttachedEcsInstances'],
+ ],
+ 'createdAt' => '2021-12-29T11:02:17.000Z',
+ 'description' => '查询数据库文件系统被挂载的ECS实例列表接口中新增返回OS名称和实例规格族',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'dbfs.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetDbfs'],
+ ['description' => 'Response parameters changed', 'api' => 'ListDbfs'],
+ ],
+ 'createdAt' => '2021-10-27T06:07:49.000Z',
+ 'description' => '查询接口新增实例规格字段',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'dbfs.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTypes'],
+ ],
+ 'createdAt' => '2021-10-26T08:59:08.000Z',
+ 'description' => '更正返回数据的类型',
],
[
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'dbfs.cn-chengdu.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeInstanceTypes'],
+ ],
+ 'createdAt' => '2021-10-26T08:40:13.000Z',
+ 'description' => '新增查询DBFS实例规格接口',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'dbfs.cn-hongkong.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateDbfs'],
+ ],
+ 'createdAt' => '2021-10-22T02:31:41.000Z',
+ 'description' => '新增DBFS规格选择',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'dbfs.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeDbfsSpecifications'],
+ ],
+ 'createdAt' => '2021-08-09T07:15:52.000Z',
+ 'description' => '新增查询dbfs规格接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetDbfs'],
+ ['description' => 'Response parameters changed', 'api' => 'ListDbfs'],
+ ],
+ 'createdAt' => '2021-05-19T11:20:05.000Z',
+ 'description' => '查询DBFS时新增返回云盘ID',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifySnapshotAttribute'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDbfsAttachedEcsInstances'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResizeDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAutoSnapshotPolicy'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagValues'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAutoSnapshotPolicy'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSnapshotLink'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDbfsAttachableEcsInstances'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoSnapshotPolicy'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAutoSnapshotPolicyUnappliedDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteTagsBatch'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetServiceLinkedRole'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachDbfs'],
+ ['threshold' => '20000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAutoSnapshotPolicyAppliedDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyAutoSnapshotPolicy'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAutoSnapshotPolicy'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAutoSnapshotPolicy'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddTagsBatch'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenameDbfs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAutoSnapshotPolicies'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagKeys'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDbfsSpecifications'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSnapshot'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSnapshotLinks'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceTypes'],
+ ],
+ 'product' => ['code' => 'dbfs', 'title' => 'DBFS'],
+ ],
+ 'ram' => [
+ 'productCode' => 'DBFS',
+ 'productName' => 'Database File System',
+ 'ramCodes' => ['dbfs'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'AttachDbfs',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:AttachDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAutoSnapshotPolicy',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddTagsBatch',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:AddTagsBatch',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDbfsAttachableEcsInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListDbfsAttachableEcsInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetServiceLinkedRole',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetServiceLinkedRole',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagKeys',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListTagKeys',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteTagsBatch',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteTagsBatch',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDbfsSpecifications',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:DescribeDbfsSpecifications',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDbfs',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'additionalActions' => [
+ ['action' => 'dbfs:CreateServiceLinkedRole'],
+ ],
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAutoSnapshotPolicyUnappliedDbfs',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListAutoSnapshotPolicyUnappliedDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDbfs',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:UpdateDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/{#FsId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSnapshot',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAutoSnapshotPolicy',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateSnapshot',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDbfs',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDbfsAttachedEcsInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListDbfsAttachedEcsInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDbfs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSnapshotLinks',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListSnapshotLinks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceTypes',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:DescribeInstanceTypes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAutoSnapshotPolicyAppliedDbfs',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListAutoSnapshotPolicyAppliedDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DetachDbfs',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:DetachDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ApplyAutoSnapshotPolicy',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:ApplyAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAutoSnapshotPolicy',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResizeDbfs',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:ResizeDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAutoSnapshotPolicies',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListAutoSnapshotPolicies',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateServiceLinkedRole',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dbfs:CreateServiceLinkedRole',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenameDbfs',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:RenameDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagDbfs',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:TagDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSnapshotLink',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetSnapshotLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDbfs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:GetDbfs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelAutoSnapshotPolicy',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:CancelAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifySnapshotAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dbfs:ModifySnapshotAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyAutoSnapshotPolicy',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'dbfs:ModifyAutoSnapshotPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSnapshot',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dbfs:DeleteSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagValues',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dbfs:ListTagValues',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DBFS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/*'],
+ ['validationType' => 'always', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/{#PolicyId}'],
+ ['validationType' => 'always', 'resourceType' => 'DbfsInstance', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/{#FsId}'],
+ ['validationType' => 'always', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/*'],
+ ['validationType' => 'always', 'resourceType' => 'AutoSnapShotPolicy', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/*'],
+ ['validationType' => 'always', 'resourceType' => 'Snapshot', 'arn' => 'acs:dbfs:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:37:56 +0000