From f8f1b77f86f7141b8084a92b696e1354b26fba09 Mon Sep 17 00:00:00 2001 From: lizaoxu Date: Mon, 27 Apr 2026 08:13:23 +0000 Subject: [PATCH] sfs_api_260228 Reviewed-by: Miskanin, Jan Co-authored-by: lizaoxu Co-committed-by: lizaoxu --- docs/sfs/api-ref/ALL_META.TXT.json | 40 +- docs/sfs/api-ref/CLASS.TXT.json | 22 +- docs/sfs/api-ref/CreateShare.html | 13 +- docs/sfs/api-ref/ListShares.html | 420 +++++++++--------- docs/sfs/api-ref/ShowClientIpInfo.html | 218 ++++----- docs/sfs/api-ref/ShowJobDetail.html | 4 +- docs/sfs/api-ref/ShowShare.html | 382 ++++++++-------- .../api-ref/en-us_image_0000002511210156.png | Bin 0 -> 427113 bytes .../api-ref/en-us_image_0000002511370156.png | Bin 0 -> 272077 bytes .../api-ref/en-us_image_0000002542835887.png | Bin 0 -> 272077 bytes docs/sfs/api-ref/sfs_02_0001.html | 2 +- docs/sfs/api-ref/sfs_02_0009.html | 6 +- docs/sfs/api-ref/sfs_02_0011.html | 2 +- docs/sfs/api-ref/sfs_02_0014.html | 2 +- docs/sfs/api-ref/sfs_02_0021.html | 6 +- docs/sfs/api-ref/sfs_02_0023.html | 2 +- docs/sfs/api-ref/sfs_02_0024.html | 2 +- docs/sfs/api-ref/sfs_02_0025.html | 2 +- docs/sfs/api-ref/sfs_02_0026.html | 2 +- docs/sfs/api-ref/sfs_02_0027.html | 2 +- docs/sfs/api-ref/sfs_02_0029.html | 6 +- docs/sfs/api-ref/sfs_02_0030.html | 2 +- docs/sfs/api-ref/sfs_02_0031.html | 2 +- docs/sfs/api-ref/sfs_02_0032.html | 2 +- docs/sfs/api-ref/sfs_02_0034.html | 2 +- docs/sfs/api-ref/sfs_02_0035.html | 2 +- docs/sfs/api-ref/sfs_02_0039.html | 2 +- docs/sfs/api-ref/sfs_02_0043.html | 2 +- docs/sfs/api-ref/sfs_02_0080.html | 2 +- docs/sfs/api-ref/sfs_02_0088.html | 4 + docs/sfs/api-ref/sfs_02_0092.html | 8 +- docs/sfs/api-ref/sfs_02_0112.html | 105 ++++- docs/sfs/api-ref/sfs_02_0191.html | 78 ++++ docs/sfs/api-ref/sfs_02_0192.html | 20 + 34 files changed, 803 insertions(+), 561 deletions(-) create mode 100644 docs/sfs/api-ref/en-us_image_0000002511210156.png create mode 100644 docs/sfs/api-ref/en-us_image_0000002511370156.png create mode 100644 docs/sfs/api-ref/en-us_image_0000002542835887.png create mode 100644 docs/sfs/api-ref/sfs_02_0191.html create mode 100644 docs/sfs/api-ref/sfs_02_0192.html diff --git a/docs/sfs/api-ref/ALL_META.TXT.json b/docs/sfs/api-ref/ALL_META.TXT.json index 2710a084a..608183cd2 100644 --- a/docs/sfs/api-ref/ALL_META.TXT.json +++ b/docs/sfs/api-ref/ALL_META.TXT.json @@ -1185,7 +1185,7 @@ "node_id":"showclientipinfo.xml", "product_code":"sfs", "code":"65", - "des":"This API is used to obtain the IP addresses of the clients who have mounted the file system.POST /v1/{project_id}/sfs-turbo/shares/{share_id}/actionStatus code: 200Status", + "des":"This API is used to obtain the IP addresses of the clients who have mounted the file system.Only the IP addresses of clients that sent access requests in the last 5 minut", "doc_type":"api", "kw":"Obtaining IP Addresses of the Clients Who Have Mounted the File System,File System Management,API Re", "search_title":"", @@ -1916,11 +1916,47 @@ "title":"Obtaining a Project ID", "githuburl":"" }, + { + "uri":"sfs_02_0191.html", + "node_id":"sfs_02_0191.xml", + "product_code":"sfs", + "code":"105", + "des":"When creating an encrypted file system, you need to add the KMS key ID to the request header. You can obtain the key ID in the following ways:Querying the ID of a KMS Key", + "doc_type":"api", + "kw":"Obtaining a KMS Key ID,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"sfs" + } + ], + "title":"Obtaining a KMS Key ID", + "githuburl":"" + }, + { + "uri":"sfs_02_0192.html", + "node_id":"sfs_02_0192.xml", + "product_code":"sfs", + "code":"106", + "des":"If this is your first time using file system encryption with the account, you need to create an IAM agency to grant account op_svc_sfs the KMS Administrator permissions. ", + "doc_type":"api", + "kw":"Creating an IAM Agency for Encryption,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"sfs" + } + ], + "title":"Creating an IAM Agency for Encryption", + "githuburl":"" + }, { "uri":"sfs_02_0092.html", "node_id":"sfs_02_0092.xml", "product_code":"sfs", - "code":"105", + "code":"107", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/sfs/api-ref/CLASS.TXT.json b/docs/sfs/api-ref/CLASS.TXT.json index 167658537..b5a7aed55 100644 --- a/docs/sfs/api-ref/CLASS.TXT.json +++ b/docs/sfs/api-ref/CLASS.TXT.json @@ -576,7 +576,7 @@ "code":"64" }, { - "desc":"This API is used to obtain the IP addresses of the clients who have mounted the file system.POST /v1/{project_id}/sfs-turbo/shares/{share_id}/actionStatus code: 200Status", + "desc":"This API is used to obtain the IP addresses of the clients who have mounted the file system.Only the IP addresses of clients that sent access requests in the last 5 minut", "product_code":"sfs", "title":"Obtaining IP Addresses of the Clients Who Have Mounted the File System", "uri":"ShowClientIpInfo.html", @@ -935,6 +935,24 @@ "p_code":"99", "code":"104" }, + { + "desc":"When creating an encrypted file system, you need to add the KMS key ID to the request header. You can obtain the key ID in the following ways:Querying the ID of a KMS Key", + "product_code":"sfs", + "title":"Obtaining a KMS Key ID", + "uri":"sfs_02_0191.html", + "doc_type":"api", + "p_code":"99", + "code":"105" + }, + { + "desc":"If this is your first time using file system encryption with the account, you need to create an IAM agency to grant account op_svc_sfs the KMS Administrator permissions. ", + "product_code":"sfs", + "title":"Creating an IAM Agency for Encryption", + "uri":"sfs_02_0192.html", + "doc_type":"api", + "p_code":"99", + "code":"106" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"sfs", @@ -942,6 +960,6 @@ "uri":"sfs_02_0092.html", "doc_type":"api", "p_code":"", - "code":"105" + "code":"107" } ] \ No newline at end of file diff --git a/docs/sfs/api-ref/CreateShare.html b/docs/sfs/api-ref/CreateShare.html index 1d4f27124..e106ab131 100644 --- a/docs/sfs/api-ref/CreateShare.html +++ b/docs/sfs/api-ref/CreateShare.html @@ -257,17 +257,8 @@

String

The file system bandwidth.

-

This parameter is mandatory when you are creating an SFS Turbo 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system.

-

Specify 20M for a 20 MB/s/TiB file system, 40M for a 40 MB/s/TiB file system, 125M for a 125 MB/s/TiB file system, and 250M for a 250 MB/s/TiB file system. Specify 500M for a 500 MB/s/TiB file system and 1000M for a 1,000 MB/s/TiB file system.

- - -

vault_id

- -

No

- -

String

- -

The vault ID.

+

This parameter is mandatory when you are creating a 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system.

+

Specify 20M for a 20 MB/s/TiB file system and specify 40M for a 40 MB/s/TiB file system. Specify 125M for a 125 MB/s/TiB file system and specify 250M for a 250 MB/s/TiB file system. Specify 500M for a 500 MB/s/TiB file system and specify 1000M for a 1,000 MB/s/TiB file system.

diff --git a/docs/sfs/api-ref/ListShares.html b/docs/sfs/api-ref/ListShares.html index 2f0b2ba49..566caa43d 100644 --- a/docs/sfs/api-ref/ListShares.html +++ b/docs/sfs/api-ref/ListShares.html @@ -1,477 +1,477 @@

Listing File Systems

-

Function

This API is used to list file systems.

+

Function

This API is used to list file systems.

-

URI

GET /v1/{project_id}/sfs-turbo/shares/detail

+

URI

GET /v1/{project_id}/sfs-turbo/shares/detail

-
Table 1 Path Parameters

Parameter

+
- - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

The project ID.

+

The project ID.
-
Table 2 Query Parameters

Parameter

+
- - - - - - - - - - -
Table 2 Query Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

limit

+

limit

No

+

No

Integer

+

Integer

The maximum number of returned file systems. If not specified, 1000 is used by default.

+

The maximum number of returned file systems. If not specified, 1000 is used by default.

offset

+

offset

No

+

No

Integer

+

Integer

The offset of the returned file systems.

+

The offset of the returned file systems.
-

Request Parameters

-
Table 3 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - - - - - -
Table 3 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

The account token.

+

The account token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

The MIME type.

+

The MIME type.
-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

+
- - - - - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

shares

+

shares

Array of ShareInfo objects

+

Array of ShareInfo objects

The list of SFS Turbo file systems.

+

The list of SFS Turbo file systems.

count

+

count

Integer

+

Integer

The number of SFS Turbo file systems.

+

The number of SFS Turbo file systems.
-
Table 5 ShareInfo

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ShareInfo

Parameter

Type

+

Type

Description

+

Description

action_progress

+

action_progress

ActionProgress object

+

ActionProgress object

The file system creation progress. This field is only returned when the file system is being created.

+

The file system creation progress. This field is only returned when the file system is being created.

version

+

version

String

+

String

The file system version.

+

The file system version.

avail_capacity

+

avail_capacity

String

+

String

The available capacity of the file system, in GB.

+

The available capacity of the file system, in GB.

availability_zone

+

availability_zone

String

+

String

The code of the AZ where the file system resides.

+

The code of the AZ where the file system resides.

az_name

+

az_name

String

+

String

The name of the AZ where the file system resides.

+

The name of the AZ where the file system resides.

created_at

+

created_at

String

+

String

The time when the file system was created. UTC time, for example: 2018-11-19T04:02:03.

+

The time when the file system was created. UTC time, for example: 2018-11-19T04:02:03.

crypt_key_id

+

crypt_key_id

String

+

String

The ID of the encryption key. This parameter is not returned for non-encrypted file systems.

+

The ID of the encryption key. This parameter is not returned for non-encrypted file systems.

expand_type

+

expand_type

String

+

String

The extension type.

-

bandwidth is returned if the requested file system is an Enhanced file system.

-

For a 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, hpc is returned.

-

-

-

Enumeration values:

-

  • bandwidth

    -

  • hpc

    +

The extension type.

+

bandwidth is returned if the requested file system is an Enhanced file system.

+

For a 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, hpc is returned.

+

+

+

Enumeration values:

+

  • bandwidth

    +

  • hpc

export_location

+

export_location

String

+

String

The file system location, for example, 192.168.0.90:/. This field is not returned when the file system is being created.

+

The file system location, for example, 192.168.0.90:/. This field is not returned when the file system is being created.

id

+

id

String

+

String

The file system ID.

+

The file system ID.

name

+

name

String

+

String

The file system name specified during creation.

+

The file system name specified during creation.

pay_model

+

pay_model

String

+

String

The file system billing mode. Value 0 indicates pay-per-use. This field is not returned when the file system is being created.

-

Enumeration values:

-

  • 0

    -

  • 1

    +

The file system billing mode. Value 0 indicates pay-per-use. This field is not returned when the file system is being created.

+

Enumeration values:

+

  • 0

    +

  • 1

region

+

region

String

+

String

The region where the file system resides.

+

The region where the file system resides.

security_group_id

+

security_group_id

String

+

String

The ID of the specified security group.

+

The ID of the specified security group.

share_proto

+

share_proto

String

+

String

The protocol used by the SFS Turbo file system. The value can be NFS.

+

The protocol used by the SFS Turbo file system. The value can be NFS.

share_type

+

share_type

String

+

String

The file system performance type. Valid values are STANDARD and PERFORMANCE.

+

The file system performance type. Valid values are STANDARD and PERFORMANCE.

size

+

size

String

+

String

The file system total capacity, in GB.

+

The file system total capacity, in GB.

status

+

status

String

+

String

The SFS Turbo file system status.

-

Enumeration values:

-

  • 100: creating

    -

  • 200: available

    -

  • 303: creation failed

    -

  • 800: frozen

    +

The SFS Turbo file system status.

+

Enumeration values:

+

  • 100: creating

    +

  • 200: available

    +

  • 303: creation failed

    +

  • 800: frozen

sub_status

+

sub_status

String

+

String

The file system sub-status. This field is not returned if no modification is made to the file system.

-

121 (expanding capacity), 132 (changing security group), 150* (adding storage backend), 151 (removing storage backend)

-

221 (expansion succeeded), 232 (security group changed), 250 (storage backend added), 251* (storage backend removed)

-

321 (expansion failed), 332 (changing security group failed), 350 (adding storage backend failed), 351 (removing storage backend failed)

+

The file system sub-status. This field is not returned if no modification is made to the file system.

+

121 (expanding capacity), 132 (changing security group), 150* (adding storage backend), 151 (removing storage backend)

+

221 (expansion succeeded), 232 (security group changed), 250 (storage backend added), 251* (storage backend removed)

+

321 (expansion failed), 332 (changing security group failed), 350 (adding storage backend failed), 351 (removing storage backend failed)

subnet_id

+

subnet_id

String

+

String

The ID of the specified subnet.

+

The ID of the specified subnet.

vpc_id

+

vpc_id

String

+

String

The ID of the specified VPC.

+

The ID of the specified VPC.

enterprise_project_id

+

enterprise_project_id

String

+

String

The ID of the enterprise project that file system is added to.

+

The ID of the enterprise project that file system is added to.

tags

+

tags

Array of ResourceTag objects

+

Array of ResourceTag objects

The tag list.

+

The tag list.

optional_endpoint

+

optional_endpoint

String

+

String

The alternative IP addresses that can be used for mount. This field is not returned for previous-generation file systems.

+

The alternative IP addresses that can be used for mount. This field is not returned for previous-generation file systems.

hpc_bw

+

hpc_bw

String

+

String

The file system bandwidth.

-

  • "20M": 20 MB/s/TiB

    -

  • "40M": 40 MB/s/TiB

    -

  • "125M": 125 MB/s/TiB

    -

  • "250M": 250 MB/s/TiB

    -

  • "500M": 500 MB/s/TiB

    -

  • "1000M": 1,000 MB/s/TiB

    +

The file system bandwidth.

+

  • 20M: 20 MB/s/TiB

    +

  • 40M: 40 MB/s/TiB

    +

  • 125M: 125 MB/s/TiB

    +

  • 250M: 250 MB/s/TiB

    +

  • 500M: 500 MB/s/TiB

    +

  • 1000M: 1,000 MB/s/TiB

instanceId

+

instanceId

String

+

String

The node ID of the file system type, which has no meaning. This is a reserved field.

+

The node ID of the file system type, which has no meaning. This is a reserved field.

instanceType

+

instanceType

String

+

String

The node type of the file system type, which has no meaning. This is a reserved field.

+

The node type of the file system type, which has no meaning. This is a reserved field.

statusDetail

+

statusDetail

String

+

String

The file system request ID, which has no meaning. This is a reserved field.

+

The file system request ID, which has no meaning. This is a reserved field.

features

+

features

ShareInfoFeatures object

+

ShareInfoFeatures object

The file system feature settings.

+

The file system feature settings.
-
Table 6 ActionProgress

Parameter

+
- - - - -
Table 6 ActionProgress

Parameter

Type

+

Type

Description

+

Description

CREATING

+

CREATING

String

+

String

The file system creation progress.

+

The file system creation progress.
-
Table 7 ResourceTag

Parameter

+
- - - - - - - -
Table 7 ResourceTag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

The tag key.

-

It can contain a maximum of 128 characters.

-

It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).

+

The tag key.

+

It can contain a maximum of 128 characters.

+

It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).

value

+

value

String

+

String

The tag value.

-

Each tag value can contain a maximum of 255 characters and can be an empty string.

-

It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).

+

The tag value.

+

Each tag value can contain a maximum of 255 characters and can be an empty string.

+

It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
-
Table 8 ShareInfoFeatures

Parameter

+
- - - - -
Table 8 ShareInfoFeatures

Parameter

Type

+

Type

Description

+

Description

backup

+

backup

ShareInfoFeature object

+

ShareInfoFeature object

Whether the file system supports backup.

+

Whether the file system supports backup.
-
Table 9 ShareInfoFeature

Parameter

+
- - - - - - - - - - -
Table 9 ShareInfoFeature

Parameter

Type

+

Type

Description

+

Description

is_support

+

is_support

Boolean

+

Boolean

Whether the file system supports this feature.

+

Whether the file system supports this feature.

message

+

message

String

+

String

The message.

+

The message.

msg_code

+

msg_code

String

+

String

The message code.

+

The message code.
-

Example Requests

Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

-
GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/shares/detail
+

Example Requests

Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

+
GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/shares/detail
-

Example Responses

Status code: 200

-

Success response body

-