History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Auto scale-out rule.
Used by actions: DescribeCfsFileSystems.
| Name | Type | Required | Description |
|---|---|---|---|
| Status | String | No | Enable auto scale-out policy, disable. |
| ScaleThreshold | Integer | No | Cluster usage percentage. start expansion when reaching this value. value range: [10-90]. |
| TargetThreshold | Integer | No | Used capacity to total clusters ratio after expansion. value range: [10-90]. |
Snapshot policy information
Used by actions: DescribeAutoSnapshotPolicies.
| Name | Type | Description |
|---|---|---|
| AutoSnapshotPolicyId | String | Snapshot policy ID |
| PolicyName | String | Snapshot policy name. |
| CreationTime | String | Snapshot policy creation time |
| FileSystemNums | Integer | Number of bound file systems |
| DayOfWeek | String | The specific day of the week on which to create a snapshot. This parameter is mutually exclusive with DayOfMonth and IntervalDays. |
| Hour | String | The hour of a day at which to regularly back up the snapshot |
| IsActivated | Integer | Whether the periodic snapshot function is activated; 1 indicates activated, 0 indicates inactive. |
| NextActiveTime | String | Next time to trigger snapshot |
| Status | String | Snapshot policy status. available represents normal status. only status here. |
| AppId | Integer | Account ID. |
| AliveDays | Integer | Retention period |
| RegionName | String | Region |
| FileSystems | Array of FileSystemByPolicy | File system information |
| DayOfMonth | String | The specific day of the month on which to create a snapshot. This parameter is mutually exclusive with DayOfWeek and IntervalDays.Note: This field may return null, indicating that no valid values can be obtained. |
| IntervalDays | Integer | The snapshot interval (1 to 365 days). This parameter is mutually exclusive with DayOfWeek and DayOfMonth.Note: This field may return null, indicating that no valid values can be obtained. |
| CrossRegionsAliveDays | Integer | Snapshot retention time for cross-region replication, in days. |
| Tags | Array of TagInfo | Snapshot policy tag. |
Version control - protocol details.
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| SaleStatus | String | Sale status. Valid values: sale_out (sold out), saling (purchasable), no_saling (non-purchasable) |
| Protocol | String | Protocol type. optional values: NFS, CIFS, and TURBO. |
Versioning - array of regions
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| Region | String | Region name, such as "ap-beijing" |
| RegionName | String | Region name, such as "bj" |
| RegionStatus | String | Region availability. If a region has at least one AZ where resources are purchasable, this value will be AVAILABLE; otherwise, it will be UNAVAILABLE |
| Zones | Array of AvailableZone | Array of AZs |
| RegionCnName | String | Region name, such as "Guangzhou" |
Versioning - array of classes
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| Protocols | Array of AvailableProtoStatus | Protocol and sale details |
| Type | String | Storage type. In the return value, SD indicates General Standard Storage, HP indicates General Performance Storage, TB indicates Standard Turbo, and TP indicates High-Performance Turbo. |
| Prepayment | Boolean | Support for prepaid. In the return value, true means supported and false means unsupported. |
| Version | String | File system version Enumeration value:
|
Versioning - array of AZs
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| Zone | String | AZ name |
| ZoneId | Integer | AZ ID |
| ZoneCnName | String | Chinese name of an AZ |
| Types | Array of AvailableType | Array of classes |
| ZoneName | String | Chinese and English names of an AZ |
Bucket information
Used by actions: DescribeBucketList.
| Name | Type | Description |
|---|---|---|
| Name | String | Bucket name |
| Region | String | Bucket region Note: This field may return null, indicating that no valid values can be obtained. |
Returns the rule information list if there is a rule conflict.
Used by actions: ApplyPathLifecyclePolicy.
| Name | Type | Description |
|---|---|---|
| LifecyclePolicyID | String | Lifecycle management policy ID. |
| FileSystemId | String | File system ID. |
| Path | String | Directory absolute path. |
| LifecycleRules | Array of LifecycleRule | List of management rules associated with the lifecycle management policy. |
| TargetPath | String | Target path. |
Data flow information.
Used by actions: DescribeDataFlow.
| Name | Type | Description |
|---|---|---|
| DataFlowId | String | Data flow manage ID. |
| DataFlowName | String | Data flow name. |
| SourceStorageType | String | Source data type. |
| SourceStorageAddress | String | Source storage address. |
| SourcePath | String | Source path. |
| TargetPath | String | Directory path. |
| Status | String | available: effective. pending: configuring. unavailable. Deleting: deleting. |
| CreationTime | String | Creation time. |
| FileSystemId | String | File system ID |
| AutoRefresh | Integer | 0: disable auto-update. 1: enable auto-update. |
| UserKafkaTopic | String | Topic Parameter used by KafkaConsumer during consumption |
| ServerAddr | String | Service address. |
| UserName | String | Kafka consuming user name. |
| AutoRefreshStatus | String | Auto refresh status, available: in effect. pending: configuring. unavailable. |
| AutoRefreshTime | String | Automatically refresh start time. |
Value after purchasing additional performance.
Used by actions: DescribeCfsFileSystems.
| Name | Type | Description |
|---|---|---|
| Type | String | Fixed: final value is fixed. |
| Performance | Integer | Additional purchase CFS performance value in MB/s. |
Information of the file system bound to the snapshot policy
Used by actions: DescribeAutoSnapshotPolicies.
| Name | Type | Description |
|---|---|---|
| CreationToken | String | File system name |
| FileSystemId | String | File system ID |
| SizeByte | Integer | File system size, in Byte. |
| StorageType | String | Storage type. HP: high-performance; SD: standard; TP: high-performance Turbo; TB: standard Turbo; THP: throughput. |
| TotalSnapshotSize | Integer | Total snapshot size in GiB. |
| CreationTime | String | File system creation time |
| ZoneId | Integer | Region ID of the file system |
Information on the file system client
Used by actions: DescribeCfsFileSystemClients.
| Name | Type | Description |
|---|---|---|
| CfsVip | String | IP address of the file system |
| ClientIp | String | Client IP |
| VpcId | String | File system VPCID |
| Zone | String | Availability zone name, such as ap-beijing-1. see the region and availability zone list in the description document (https://www.tencentcloud.com/document/api/582/38144?from_cn_redirect=1). |
| ZoneName | String | AZ name |
| MountDirectory | String | Path in which the file system is mounted to the client |
Basic information of a file system
Used by actions: DescribeCfsFileSystems.
| Name | Type | Description |
|---|---|---|
| CreationTime | String | Creation time |
| CreationToken | String | Custom name |
| FileSystemId | String | File system ID |
| LifeCycleState | String | File system status. Valid values: - creating - mounting - create_failed - available - unserviced - upgrading |
| SizeByte | Integer | Used capacity of the file system, in Byte. |
| SizeLimit | Integer | File system space limit, in GiB. |
| ZoneId | Integer | Region ID |
| Zone | String | Region name |
| Protocol | String | File system protocol type. Valid values: NFS, CIFS, and TURBO. |
| StorageType | String | Storage type. HP: high-performance; SD: standard; TP: high-performance Turbo; TB: standard Turbo; THP: throughput. |
| StorageResourcePkg | String | Prepaid storage pack bound with the file system |
| BandwidthResourcePkg | String | Prepaid bandwidth pack bound to a file system (not supported currently) |
| PGroup | PGroup | Information of permission groups bound to a file system |
| FsName | String | Custom name |
| Encrypted | Boolean | Is the file system encrypted. true: encrypted. false: non-encrypted. |
| KmsKeyId | String | Key used for encryption, which can be the key ID or ARN |
| AppId | Integer | Application ID |
| BandwidthLimit | Float | Upper limit of the file system throughput, in MiB/s. The upper limit is determined based on the current storage used of the file system, bound storage resource packages, and throughput resource packages. |
| AutoSnapshotPolicyId | String | Snapshot policy associated with the file system. |
| SnapStatus | String | File system processes snapshot status, snapping: in snapshot, normal: in normal status. |
| Capacity | Integer | Upper limit of file system capacity. Unit: GiB. |
| Tags | Array of TagInfo | File system tag list |
| TieringState | String | Status of file system lifecycle management. NotAvailable: unavailable. Available. |
| TieringDetail | TieringDetailInfo | Layered storage detail. |
| AutoScaleUpRule | AutoScaleUpRule | File system auto scale-out policy. |
| Version | String | File System Version |
| ExstraPerformanceInfo | Array of ExstraPerformanceInfo | Additional performance info. Note: This field may return null, indicating that no valid values can be obtained. |
| MetaType | String | basic: standard version metadata type. enhanced: additional metadata type. |
Conditional filter
Used by actions: DescribeAutoSnapshotPolicies, DescribeCfsSnapshots, DescribeLifecycleDataTask, DescribeMigrationTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| Values | Array of String | Yes | Value |
| Name | String | Yes | Name |
Lifecycle task.
Used by actions: DescribeLifecycleDataTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskId | String | No | Task ID. |
| TaskStatus | String | No | Task status. init: pending. running: executing, finished: completed. failed: failure. Stopping: stopping, stopped: stopped. |
| CreationTime | String | No | Task creation time |
| FinishTime | String | No | Task end time. |
| FileTotalCount | Integer | No | Total files. |
| FileSuccessedCount | Integer | No | Number of successfully processed files. |
| FileFailedCount | Integer | No | Number of failed files. |
| FileTotalSize | Integer | No | File capacity, in Byte. |
| FileSuccessedSize | Integer | No | Processed file capacity, in Byte. |
| FileFailedSize | Integer | No | Capacity of processed failed files, in Byte. |
| FileTotalList | String | No | Total file list. |
| FileSuccessedList | String | No | List of successful files. |
| FileFailedList | String | No | List of failed files. |
| FileSystemId | String | No | FileSystemId |
| TaskName | String | No | Task name. |
| TaskPath | String | No | Task path. |
| Type | String | No | Task type, archive: indicates settlement task, restore: indicates pull task. |
| DataFlowId | String | No | Data flow Id. |
| IsOverwrite | Boolean | No | When a file in CFSTurbo and an external storage have the same name, whether to overwrite. Override. false: not overwrite (at the same time, it does not release hot data storage). Default false when empty. |
Lifecycle management policy information.
Used by actions: DescribeLifecyclePolicies.
| Name | Type | Description |
|---|---|---|
| CreateTime | String | The time when the lifecycle management policy was created . |
| LifecyclePolicyID | String | Lifecycle management policy ID. . |
| LifecyclePolicyName | String | Lifecycle management policy name .Note: This field may return null, indicating that no valid values can be obtained. |
| LifecycleRules | Array of LifecycleRule | List of management rules associated with the lifecycle management policy. .Note: This field may return null, indicating that no valid values can be obtained. |
| Paths | Array of PathInfo | List of absolute paths for directories associated with the lifecycle management policy .Note: This field may return null, indicating that no valid values can be obtained. |
Manage rule associated with the lifecycle management policy.
Used by actions: ApplyPathLifecyclePolicy, CreateLifecyclePolicy, DescribeLifecyclePolicies, ModifyLifecyclePolicy.
| Name | Type | Required | Description |
|---|---|---|---|
| StorageType | String | Yes | Storage type after data dump. among them: InfrequentAccess: infrequent medium storage; ColdStorage: cold storage. |
| FileType | String | Yes | Data dump FILE type. among them, BIG_FILE: extra large FILE; STD_FILE: regular FILE; SMALL_FILE: SMALL FILE; ALL: ALL files. |
| Action | String | Yes | Data dumping action. among them, Archive: settlement; Noarchive: no settlement. |
| Interval | String | No | Data dump trigger time. consists of "DEFAULT_ATIME_" and a number, in days. keep it empty when Action is Noarchive. Note: This field may return null, indicating that no valid values can be obtained. |
| FileMaxSize | String | No | Maximum specification for data dump files. the value needs to use the "number+measurement unit" format, and the supported units are K (KiB), M (MiB), and G (GiB). Note: This field may return null, indicating that no valid values can be obtained. |
| FileMinSize | String | No | Minimum specification of the dump file. its numeric value needs to use the "number+measurement unit" format, and the supported units are K (KiB), M (MiB), and G (GiB). Note: This field may return null, indicating that no valid values can be obtained. |
| PolicyType | String | No | Policy type. |
| ExpireThreshold | Integer | No | Threshold range: 10-90. |
| TargetThreshold | Integer | No | Threshold range: 10-90. |
| IsOverwrite | Boolean | No | When a file in CFSTurbo and an external storage have the same name, whether to overwrite. Override. false: not overwrite (at the same time will not release hot data storage). Default false when empty. |
Information of a CFS data migration task
Used by actions: DescribeMigrationTasks.
| Name | Type | Description |
|---|---|---|
| TaskName | String | Migration task name |
| TaskId | String | Migration task ID |
| MigrationType | Integer | Migration type. Valid values: 0 (bucket) and 1 (list). Default value: 0. |
| MigrationMode | Integer | Migration mode. Default value: 0 (full migration). |
| BucketName | String | Data source bucket name. |
| BucketRegion | String | Source bucket region. |
| BucketAddress | String | Data source bucket address. |
| ListAddress | String | Checklist address. |
| FsName | String | File system instance name. |
| FileSystemId | String | File system instance ID |
| FsPath | String | File system path |
| CoverType | Integer | Overwrite policy for files with the same name. Valid values: 0 (retain the file with the latest modified time), 1 (overwrite); and 2 (not overwrite). Default value: 0. |
| CreateTime | Integer | Creation time |
| EndTime | Integer | Completion/Termination time. |
| Status | Integer | Migration status. 0: completed; 1: creating; 2: running; 3: terminating; 4: terminated; 5: creation failed; 6: running failure; 7: ending; 8: deleting; 9: waiting. |
| FileTotalCount | Integer | Number of files. |
| FileMigratedCount | Integer | Number of migrated files. |
| FileFailedCount | Integer | Number of failed files in migration. |
| FileTotalSize | Integer | File capacity, in Byte. |
| FileMigratedSize | Integer | Migrated file capacity in Byte. |
| FileFailedSize | Integer | Capacity of failed migration files, in Byte. |
| FileTotalList | String | Total inventory. |
| FileCompletedList | String | File list completed. |
| FileFailedList | String | Failed file list. |
| BucketPath | String | Source bucket path. |
| Direction | Integer | Migration direction. valid values: 0 (cos migration to file system), 1 (file system migration to cos). default is 0. |
Mount target information
Used by actions: DescribeMountTargets.
| Name | Type | Description |
|---|---|---|
| FileSystemId | String | File system ID |
| MountTargetId | String | Mount target ID |
| IpAddress | String | Mount target IP |
| FSID | String | Mount root-directory |
| LifeCycleState | String | Mount point status, including creating: under creation; available: running. Deleting: deleting. Creation failed. |
| NetworkInterface | String | Network type, including VPC, CCN. |
| VpcId | String | VPC ID |
| VpcName | String | VPC name |
| SubnetId | String | Subnet ID |
| SubnetName | String | Subnet name |
| CcnID | String | CCN instance ID used by CFS Turbo |
| CidrBlock | String | CCN IP range used by CFS Turbo |
Information of permission groups bound to a file system
Used by actions: DescribeCfsFileSystems.
| Name | Type | Description |
|---|---|---|
| PGroupId | String | Permission group ID |
| Name | String | Permission group name |
Array of permission groups
Used by actions: DescribeCfsPGroups.
| Name | Type | Description |
|---|---|---|
| PGroupId | String | Permission group ID |
| Name | String | Permission group name |
| DescInfo | String | Description |
| CDate | String | Creation time |
| BindCfsNum | Integer | The number of bound file system |
List of permission group rules
Used by actions: DescribeCfsRules.
| Name | Type | Description |
|---|---|---|
| RuleId | String | Rule ID |
| AuthClientIp | String | Client IP allowed for access |
| RWPermission | String | Read/write permission. ro: read-only; rw: read & write |
| UserPermission | String | All_squash: all accessing users (including the root user) will be mapped to anonymous users or groups. no_all_squash: all accessing users (including the root user) retain original UID/GID information. root_squash: maps visiting root user to anonymous user or user group. non-root user keeps original UID/GID information. no_root_squash: has the same effect as no_all_squash. all accessing users (including the root user) retain their original UID/GID information. |
| Priority | Integer | Rule priority. Value range: 1-100. 1 represents the highest priority, while 100 the lowest |
Absolute path of the directory associated with the lifecycle management policy.
Used by actions: ApplyPathLifecyclePolicy, DescribeLifecyclePolicies.
| Name | Type | Required | Description |
|---|---|---|---|
| FileSystemId | String | Yes | File system ID. |
| Path | String | Yes | Directory absolute path. |
| DataFlowId | String | No | Data flow Id. |
Snapshot information
Used by actions: DescribeCfsSnapshots.
| Name | Type | Description |
|---|---|---|
| CreationTime | String | Snapshot creation time . |
| SnapshotName | String | Snapshot name . |
| SnapshotId | String | Snapshot ID. . |
| Status | String | Snapshot status: creating - creating; available - running; deleting - deleting; rollbacking-new - creating new file system; create-failed - creation failed. . |
| RegionName | String | Region name . |
| FileSystemId | String | File system ID . |
| Size | Integer | Snapshot size unit: MiB . |
| AliveDay | Integer | Retention duration days . |
| Percent | Integer | Snapshot progress percentage. 1 means 1%. value range: 1-100. . |
| AppId | Integer | Account ID. . |
| DeleteTime | String | Snapshot deletion time . |
| FsName | String | File system name . |
| Tags | Array of TagInfo | Snapshot tag. . |
| SnapshotType | String | Snapshot type. general indicates a snapshot of the general series. turbo indicates a snapshot of the turbo series. .Note: This field may return null, indicating that no valid values can be obtained. |
| SnapshotTime | String | Snapshot time reflects the data of the corresponding file system at a certain moment. .Note: This field may return null, indicating that no valid values can be obtained. |
Snapshot operation log
Used by actions: DescribeSnapshotOperationLogs.
| Name | Type | Description |
|---|---|---|
| Action | String | Operation type CreateCfsSnapshot: create a snapshot. DeleteCfsSnapshot: delete snapshot. CreateCfsFileSystem: create a file system. UpdateCfsSnapshotAttribute: update snapshot. |
| ActionTime | String | Operation time |
| ActionName | String | Operation name. CreateCfsSnapshot DeleteCfsSnapshot CreateCfsFileSystem UpdateCfsSnapshotAttribute |
| Operator | String | Operator uin. |
| Result | Integer | 1- task in progress; 2- task success; 3- task failure. |
File system snapshot statistics
Used by actions: DescribeCfsSnapshotOverview.
| Name | Type | Description |
|---|---|---|
| Region | String | Region |
| SnapshotNumber | Integer | Total number of snapshots |
| SnapshotSize | Integer | Total snapshot capacity in MiB. |
Tag information unit
Used by actions: CreateAutoSnapshotPolicy, CreateCfsFileSystem, CreateCfsSnapshot, DescribeAutoSnapshotPolicies, DescribeCfsFileSystems, DescribeCfsSnapshots.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
The details about tiered storage.
Used by actions: DescribeCfsFileSystems.
| Name | Type | Required | Description |
|---|---|---|---|
| TieringSizeInBytes | Integer | No | Infrequent access storage capacity measurement unit: Byte, B, Byte . |
| SecondaryTieringSizeInBytes | Integer | No | Cold storage capacity measurement unit: Byte, B, Byte . |
피드백