Data type

CFS

  • Updates and Announcements
    • Function Release Records
    • Product Announcement
      • Announcement on CFS Metric Adjustments
  • Product Description
    • Product Introduction
    • Basic concepts
    • Product features
    • Product specifications
    • Usage Limits and Recommendations
    • Selection Guide
      • How to Choose Between CFS and PFS
      • How to Choose Between CFS, BOS and CDS
    • Application scenarios
  • Product pricing
    • Pay-as-you-go
    • Storage package billing
    • Insufficient balance reminders and debt handling
    • Billing Cases
  • Quick Start
    • Getting Started Overview
    • Quick start (Linux)
    • Quick start (Windows)
  • Operation guide
    • Activate Service
    • Manage File System
      • Create file system
      • Delete a file system
      • View file system details
      • Set File System Capacity Upper Limit
    • Mount and Access
      • Add mount target
      • Mount and Unmount CFS on BCC
        • Mount and Unmount on Linux System
          • Mount and Unmount SMB Protocol CFS on Single BCC
          • Batch mounting and unmounting NFS CFS on multiple BCC
          • Mounting and unmounting NFS CFS on a single BCC
        • Mount and Unmount SMB Protocol CFS on Windows System
        • Mount CFS File System When Purchasing New BCC
      • Using CFS in CCE
    • Permission Group Management
    • Identity and access management
    • Data encryption
    • Management Tags
    • Backup
    • Monitor and Alarm
      • View monitoring
      • Alarm management
      • Metric definition
    • Cloud Audit
  • Typical Practices
    • Set Different User Permissions for Different Directories
    • Using File Systems Across Regions Or Accounts
    • Use SFTP to Upload and Download CFS File System Data
    • Use Rsync to Sync From Old File System to CFS File System
    • Best Practices for Managing CFS with Terraform
    • Performance Testing Methods
      • Linux System Performance Testing Methods
      • Windows System Performance Testing Methods
  • API Reference
    • API Function Update Records
    • API Overview
    • Interface Overview
    • General Description
    • Service domain
    • Error code
    • File System Related Interfaces
      • Create file system
      • Update file system
      • Query file system
      • Query mount client
      • Drop file system
      • Update file system tags
    • mount target Related Interfaces
      • Create mount target
      • Query mount targets
      • Delete mount target
    • Permission Group-related APIs
      • Create Permission Group
      • Update permission group
      • Query Permission Groups
      • Delete permission group
      • Create permission group rules
      • Update permission group rules
      • Query permission group rules
      • Delete permission group rule
    • Data type
  • Go-SDK
    • Overview
    • Initialization
    • File system
    • Mount target
    • Error handling
  • FAQs
    • Common Questions Overview
    • General Problems
    • Billing Problems
    • NFS protocol questions
    • SMB Protocol Issues
  • Service Level Agreement (SLA)
    • CFS Service Level Agreement (SLA)
All documents
menu
No results found, please re-enter

CFS

  • Updates and Announcements
    • Function Release Records
    • Product Announcement
      • Announcement on CFS Metric Adjustments
  • Product Description
    • Product Introduction
    • Basic concepts
    • Product features
    • Product specifications
    • Usage Limits and Recommendations
    • Selection Guide
      • How to Choose Between CFS and PFS
      • How to Choose Between CFS, BOS and CDS
    • Application scenarios
  • Product pricing
    • Pay-as-you-go
    • Storage package billing
    • Insufficient balance reminders and debt handling
    • Billing Cases
  • Quick Start
    • Getting Started Overview
    • Quick start (Linux)
    • Quick start (Windows)
  • Operation guide
    • Activate Service
    • Manage File System
      • Create file system
      • Delete a file system
      • View file system details
      • Set File System Capacity Upper Limit
    • Mount and Access
      • Add mount target
      • Mount and Unmount CFS on BCC
        • Mount and Unmount on Linux System
          • Mount and Unmount SMB Protocol CFS on Single BCC
          • Batch mounting and unmounting NFS CFS on multiple BCC
          • Mounting and unmounting NFS CFS on a single BCC
        • Mount and Unmount SMB Protocol CFS on Windows System
        • Mount CFS File System When Purchasing New BCC
      • Using CFS in CCE
    • Permission Group Management
    • Identity and access management
    • Data encryption
    • Management Tags
    • Backup
    • Monitor and Alarm
      • View monitoring
      • Alarm management
      • Metric definition
    • Cloud Audit
  • Typical Practices
    • Set Different User Permissions for Different Directories
    • Using File Systems Across Regions Or Accounts
    • Use SFTP to Upload and Download CFS File System Data
    • Use Rsync to Sync From Old File System to CFS File System
    • Best Practices for Managing CFS with Terraform
    • Performance Testing Methods
      • Linux System Performance Testing Methods
      • Windows System Performance Testing Methods
  • API Reference
    • API Function Update Records
    • API Overview
    • Interface Overview
    • General Description
    • Service domain
    • Error code
    • File System Related Interfaces
      • Create file system
      • Update file system
      • Query file system
      • Query mount client
      • Drop file system
      • Update file system tags
    • mount target Related Interfaces
      • Create mount target
      • Query mount targets
      • Delete mount target
    • Permission Group-related APIs
      • Create Permission Group
      • Update permission group
      • Query Permission Groups
      • Delete permission group
      • Create permission group rules
      • Update permission group rules
      • Query permission group rules
      • Delete permission group rule
    • Data type
  • Go-SDK
    • Overview
    • Initialization
    • File system
    • Mount target
    • Error handling
  • FAQs
    • Common Questions Overview
    • General Problems
    • Billing Problems
    • NFS protocol questions
    • SMB Protocol Issues
  • Service Level Agreement (SLA)
    • CFS Service Level Agreement (SLA)
  • Document center
  • arrow
  • CFS
  • arrow
  • API Reference
  • arrow
  • Data type
Table of contents on this page
  • Definition of model object
  • FileSystemModel
  • MountTargetModel
  • ClientInfoModel
  • AccessGroupModel
  • AccessRuleModel
  • Status code definitions
  • FsStatus

Data type

Updated at：2025-11-11

Definition of model object

FileSystemModel

Parameter name Types Description
fsId String File system ID
fsName String File system name
type String File system storage class
protocol String File system protocol type
zone String Availability zone of the file system
capacityQuota uint64 File system capacity quota, in bytes
status FsStatus File system status
vpcId String Short VPC ID
mountTargetList MountTargetModel Mount target list of file system
tags List<Tag> List of tags bound to the file system
fsUsasge String File system used capacity
KMSKeyId String Encryption key ID used by the file system
createTime String File system creation time (UTC)

MountTargetModel

Parameter name Types Description
subnetId String ID of subnet where the mount target resides
domain String Domain name of a mount target
mountId String Mount target ID
ovip String Mount target IP
vpcId String VPC ID where the mount target resides
accessGroupName String Mount target permission group name

ClientInfoModel

Parameter name Types Description
clientIp String Client IP
zone String Client availability zone.
  • In some cases, availability zones may not be queried, such as when the client is not BCC
  • A newly mounted client may not return zone information for approximately 10 seconds
    		•
    vpcId String VPC ID where the mount target resides
    mountId String Mount target ID

    AccessGroupModel

    Parameter name Types Description
    accessGroupName String Permission group name
    accessRules List<AccessRuleModel> List of permission rules included in the permission group
    createTime Object Creation time of the permission group (UTC), a JSON object composed of two keys: “tv_nsec” and “tv_sec”, representing the timestamp
    description String Description of the permission group
    fsCount int Number of file systems bound to the permission group

    AccessRuleModel

    Parameter name Types Description
    accessRuleId int Identifier of permission group rule
    ip String Authorized IP address, virtual VPC IP
    mask int Network segment mask, representing the network segment in combination with the IP
    priority String Rule priority. The priority range is from 1 to 100, with 1 being the highest priority
    userAccess String User permission rules. The "no_squash" indicates no restrictions on root users, the "root_squash" indicates restrictions on root users, and "all_squash" indicates restrictions on all users
    writeAccess String Read-write rules. The "read_only" indicates read-only access, while "read_write" indicates read-write access.

    Status code definitions

    FsStatus

    Status Description
    available Running
    updating Updating
    paused In debt
    unavailable Unavailable temporarily

    Previous
    Permission Group-related APIs
    Next
    Go-SDK