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

-
  • Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Success response body

    +
    • Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

      +
      {
         "shares" : [ {
           "id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8",
           "name" : "sfs-turbo-8468",
      @@ -504,8 +504,8 @@
         } ],
         "count" : 1
       }
      -
    • Listing file systems in the project whose ID is 5694xxx8f3e0000xxxx655exxxxx60b7

      -
      {
      +
    • Listing file systems in the project whose ID is 5694xxx8f3e0000xxxx655exxxxx60b7

      +
      {
         "shares" : [ {
           "id" : "65f2d30b-7b4e-4786-9608-4324faef6646",
           "name" : "sfs-turbo-df12",
      @@ -542,23 +542,23 @@
       }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Success response body

    +

    Success response body

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/sfs/api-ref/ShowClientIpInfo.html b/docs/sfs/api-ref/ShowClientIpInfo.html index 9b701dd43..4fde7ab97 100644 --- a/docs/sfs/api-ref/ShowClientIpInfo.html +++ b/docs/sfs/api-ref/ShowClientIpInfo.html @@ -1,302 +1,304 @@

    Obtaining IP Addresses of the Clients Who Have Mounted the File System

    -

    Function

    This API is used to obtain the IP addresses of the clients who have mounted the file system.

    +

    Function

    This API is used to obtain the IP addresses of the clients who have mounted the file system.

    -

    URI

    POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action

    +

    Constraints

    Only the IP addresses of clients that sent access requests in the last 5 minutes are obtained.

    +
    +

    URI

    POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action

    -
    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.

    share_id

    +

    share_id

    Yes

    +

    Yes

    String

    +

    String

    The file system ID.

    +

    The file system ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - -
    Table 2 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.

    -
    Table 3 Request body parameters

    Parameter

    +
    - - - - - - -
    Table 3 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    get_client_ips

    +

    get_client_ips

    Yes

    +

    Yes

    ClientIpInfo object

    +

    ClientIpInfo object

    Obtaining IP addresses of the clients who have mounted the file system

    +

    Obtaining IP addresses of the clients who have mounted the file system

    -
    Table 4 ClientIpInfo

    Parameter

    +
    - - - - - - -
    Table 4 ClientIpInfo

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    ips

    +

    ips

    No

    +

    No

    String

    +

    String

    The IP addresses of the clients who have mounted the file system.

    +

    The IP addresses of the clients who have mounted the file system.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response header parameters

    Parameter

    +
    - - - - -
    Table 5 Response header parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    X-request-id

    +

    X-request-id

    String

    +

    String

    The request ID.

    +

    The request ID.

    -
    Table 6 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 6 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    The file system ID.

    +

    The file system ID.

    ips

    +

    ips

    Array of strings

    +

    Array of strings

    The IP addresses of the clients who have mounted the file system.

    +

    The IP addresses of the clients who have mounted the file system.

    -

    Status code: 400

    +

    Status code: 400

    -
    Table 7 Response header parameters

    Parameter

    +
    - - - - -
    Table 7 Response header parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    X-request-id

    +

    X-request-id

    String

    +

    String

    The request ID.

    +

    The request ID.

    -
    Table 8 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 8 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    errCode

    +

    errCode

    String

    +

    String

    The error code.

    +

    The error code.

    errMsg

    +

    errMsg

    String

    +

    String

    The error message.

    +

    The error message.

    -

    Status code: 500

    +

    Status code: 500

    -
    Table 9 Response header parameters

    Parameter

    +
    - - - - -
    Table 9 Response header parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    X-request-id

    +

    X-request-id

    String

    +

    String

    The request ID.

    +

    The request ID.

    -
    Table 10 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 10 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    errCode

    +

    errCode

    String

    +

    String

    The error code.

    +

    The error code.

    errMsg

    +

    errMsg

    String

    +

    String

    The error message.

    +

    The error message.

    -

    Example Requests

    None

    +

    Example Requests

    None

    -

    Example Responses

    Status code: 400

    -

    Error response

    -
    {
    +

    Example Responses

    Status code: 400

    +

    Error response

    +
    {
       "errCode" : "SFS.TURBO.0001",
       "errMsg" : "parameter error"
     }
    -

    Status code: 500

    -

    Error response

    -
    {
    +

    Status code: 500

    +

    Error response

    +
    {
       "errCode" : "SFS.TURBO.0005",
       "errMsg" : "Internal server error"
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Success

    +

    Success

    400

    +

    400

    Error response

    +

    Error response

    500

    +

    500

    Error response

    +

    Error response

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/sfs/api-ref/ShowJobDetail.html b/docs/sfs/api-ref/ShowJobDetail.html index c186285de..d6e0e0059 100644 --- a/docs/sfs/api-ref/ShowJobDetail.html +++ b/docs/sfs/api-ref/ShowJobDetail.html @@ -124,7 +124,7 @@

    String

    The task type.

    -

    Enumerated values:

    +

    Enumeration values:

    • create_share: creating a file system

    • hpc_create_share: creating a file system

    • delete_share: deleting a file system

      @@ -207,7 +207,7 @@

    String

    The subtask type.

    -

    Enumerated values:

    +

    Enumeration values:

    • create_share: creating a file system

    • hpc_create_share: creating a file system

    • delete_share: deleting a file system

      diff --git a/docs/sfs/api-ref/ShowShare.html b/docs/sfs/api-ref/ShowShare.html index 85de8fe9b..8ac96213d 100644 --- a/docs/sfs/api-ref/ShowShare.html +++ b/docs/sfs/api-ref/ShowShare.html @@ -1,428 +1,428 @@

      Querying Details About a File System

      -

      Function

      This API is used to query details about an SFS Turbo file system.

      +

      Function

      This API is used to query details about an SFS Turbo file system.

      -

      URI

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

      +

      URI

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

      -
      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.

      share_id

      +

      share_id

      Yes

      +

      Yes

      String

      +

      String

      The file system ID.

      +

      The file system ID.

      -

      Request Parameters

      -
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - - - - - -
      Table 2 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 3 Response body parameters

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 3 Response body parameters

      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 4 ActionProgress

      Parameter

      +
      - - - - -
      Table 4 ActionProgress

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      CREATING

      +

      CREATING

      String

      +

      String

      The file system creation progress.

      +

      The file system creation progress.

      -
      Table 5 ResourceTag

      Parameter

      +
      - - - - - - - -
      Table 5 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 6 ShareInfoFeatures

      Parameter

      +
      - - - - -
      Table 6 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 7 ShareInfoFeature

      Parameter

      +
      - - - - - - - - - - -
      Table 7 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

      Querying the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

      -
      GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde
      +

      Example Requests

      Querying the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

      +
      GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde
      -

      Example Responses

      Status code: 200

      -

      Query response body

      -
      • Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

        -
        {
        +

        Example Responses

        Status code: 200

        +

        Query response body

        +
        • Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

          +
          {
             "id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8",
             "name" : "sfs-turbo-8468",
             "status" : "100",
          @@ -454,23 +454,23 @@
           }
        -

        Status Codes

        -

        Status Code

        +

        Status Codes

        +
        - - -

        Status Code

        Description

        +

        Description

        200

        +

        200

        Query response body

        +

        Query response body

        -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/sfs/api-ref/en-us_image_0000002511210156.png b/docs/sfs/api-ref/en-us_image_0000002511210156.png new file mode 100644 index 000000000..738e63695 Binary files /dev/null and b/docs/sfs/api-ref/en-us_image_0000002511210156.png differ diff --git a/docs/sfs/api-ref/en-us_image_0000002511370156.png b/docs/sfs/api-ref/en-us_image_0000002511370156.png new file mode 100644 index 000000000..7ca2419d5 Binary files /dev/null and b/docs/sfs/api-ref/en-us_image_0000002511370156.png differ diff --git a/docs/sfs/api-ref/en-us_image_0000002542835887.png b/docs/sfs/api-ref/en-us_image_0000002542835887.png new file mode 100644 index 000000000..7ca2419d5 Binary files /dev/null and b/docs/sfs/api-ref/en-us_image_0000002542835887.png differ diff --git a/docs/sfs/api-ref/sfs_02_0001.html b/docs/sfs/api-ref/sfs_02_0001.html index d6d0765bb..a59b64b86 100644 --- a/docs/sfs/api-ref/sfs_02_0001.html +++ b/docs/sfs/api-ref/sfs_02_0001.html @@ -4,7 +4,7 @@

        Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

        Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

        For details about how to use APIs, see API Usage Guidelines.

        -

        An endpoint is the request address for calling an API. Endpoints vary depending on services and regions.

        +

        An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

        diff --git a/docs/sfs/api-ref/sfs_02_0009.html b/docs/sfs/api-ref/sfs_02_0009.html index dfee87f1c..32dbe0148 100644 --- a/docs/sfs/api-ref/sfs_02_0009.html +++ b/docs/sfs/api-ref/sfs_02_0009.html @@ -80,7 +80,7 @@
        Table 1 SFS endpoint information

        Service Name

        -

        For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:

        +

        For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:

        1
        POST https://{{endpoint}}/v3/auth/tokens
         
        @@ -156,7 +156,7 @@

        In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added in the request.

        For more details, see "Authentication Using AK/SK" in Authentication.

        -

        The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

        +

        The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

        1
         2
        POST https://{{endpoint}}/v3/auth/tokens
         Content-Type: application/json
        @@ -165,7 +165,7 @@
         

        (Optional) Request Body

        This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. The request body transfers content except the request header.

        The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

        -

        In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname (), $ADMIN_PASS (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.

        +

        In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname (), $ADMIN_PASS (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.

        The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.

        - @@ -233,7 +233,7 @@
         1
        diff --git a/docs/sfs/api-ref/sfs_02_0011.html b/docs/sfs/api-ref/sfs_02_0011.html
        index 229a20ce4..b20baebad 100644
        --- a/docs/sfs/api-ref/sfs_02_0011.html
        +++ b/docs/sfs/api-ref/sfs_02_0011.html
        @@ -14,7 +14,7 @@
         

        Token Authentication

        • A token remains valid for 24 hours after it is generated. You can cache a token and reuse it for authentication instead of generating a new one each time.
        • Before using a token, ensure that it has sufficient time remaining before expiration. Using a near-expiry token may cause API call failures.

        A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the Obtaining a User Token API.

        -

        IMS is a project-level service. When you call the API, set auth.scope in the request body to project.

        +

        IMS is a project-level service. When you call the API, set auth.scope in the request body to project.

        {
             "auth": {
        diff --git a/docs/sfs/api-ref/sfs_02_0014.html b/docs/sfs/api-ref/sfs_02_0014.html
        index 9711eabfb..8d37be68c 100644
        --- a/docs/sfs/api-ref/sfs_02_0014.html
        +++ b/docs/sfs/api-ref/sfs_02_0014.html
        @@ -41,7 +41,7 @@
                "is_public": false
            }
         }
        -
        • #sfs_crypt_key_id: Specifies the encryption key ID. If #sfs_crypt_key_id, #sfs_crypt_domain_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
        • #sfs_crypt_domain_id: Specifies the tenant domain ID. If #sfs_crypt_domain_id, #sfs_crypt_key_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
        • #sfs_crypt_alias: Specifies the encryption key alias. If #sfs_crypt_alias, #sfs_crypt_key_id, and #sfs_crypt_domain_id exist at the same time, the data encryption function is enabled.
        +
        • #sfs_crypt_key_id: Specifies the encryption key ID. If #sfs_crypt_key_id, #sfs_crypt_domain_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
        • #sfs_crypt_domain_id: Specifies the tenant domain ID. If #sfs_crypt_domain_id, #sfs_crypt_key_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
        • #sfs_crypt_alias: Specifies the encryption key alias. If #sfs_crypt_alias, #sfs_crypt_key_id, and #sfs_crypt_domain_id exist at the same time, the data encryption function is enabled.
        diff --git a/docs/sfs/api-ref/sfs_02_0021.html b/docs/sfs/api-ref/sfs_02_0021.html index ff119c811..908aac29b 100644 --- a/docs/sfs/api-ref/sfs_02_0021.html +++ b/docs/sfs/api-ref/sfs_02_0021.html @@ -2,7 +2,7 @@

        Creating a Shared File System

        Function

        This API is used to create a shared file system. After the file system is created, you need to mount the file system to ECSs to achieve shared file storage.

        -

        This API is an asynchronous API. If the returned status code is 200, the API request is successfully delivered and received. Later, you can query the status and path of the shared file system by referring to Querying Details About a Shared File System to identify whether the creation is complete and successful. If the status of the shared file system becomes available or the shared path is generated, the creation is successful.

        +

        This API is an asynchronous API. If the returned status code is 200, the API request is successfully delivered and received. Later, you can query the status and path of the shared file system by referring to Querying Details About a Shared File System to identify whether the creation is complete and successful. If the status of the shared file system becomes available or the shared path is generated, the creation is successful.

        After a shared file system is created successfully, it can be used only after you add share access rules by referring to Adding a File System Access Rule.

        @@ -24,7 +24,7 @@

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        -
      • Description of the share field +
      • Description of the share field
        - - diff --git a/docs/sfs/api-ref/sfs_02_0025.html b/docs/sfs/api-ref/sfs_02_0025.html index dd4548c2e..be7f79da1 100644 --- a/docs/sfs/api-ref/sfs_02_0025.html +++ b/docs/sfs/api-ref/sfs_02_0025.html @@ -31,7 +31,7 @@ - diff --git a/docs/sfs/api-ref/sfs_02_0026.html b/docs/sfs/api-ref/sfs_02_0026.html index f28ed12f8..a9ef652ea 100644 --- a/docs/sfs/api-ref/sfs_02_0026.html +++ b/docs/sfs/api-ref/sfs_02_0026.html @@ -29,7 +29,7 @@ - diff --git a/docs/sfs/api-ref/sfs_02_0027.html b/docs/sfs/api-ref/sfs_02_0027.html index 049fcaadb..177c6515d 100644 --- a/docs/sfs/api-ref/sfs_02_0027.html +++ b/docs/sfs/api-ref/sfs_02_0027.html @@ -31,7 +31,7 @@ - diff --git a/docs/sfs/api-ref/sfs_02_0029.html b/docs/sfs/api-ref/sfs_02_0029.html index 4af201244..4fc0d1111 100644 --- a/docs/sfs/api-ref/sfs_02_0029.html +++ b/docs/sfs/api-ref/sfs_02_0029.html @@ -31,7 +31,7 @@ - - - diff --git a/docs/sfs/api-ref/sfs_02_0030.html b/docs/sfs/api-ref/sfs_02_0030.html index 18e293cbd..8e5372f6e 100644 --- a/docs/sfs/api-ref/sfs_02_0030.html +++ b/docs/sfs/api-ref/sfs_02_0030.html @@ -31,7 +31,7 @@ - diff --git a/docs/sfs/api-ref/sfs_02_0031.html b/docs/sfs/api-ref/sfs_02_0031.html index 54c50c9be..470520488 100644 --- a/docs/sfs/api-ref/sfs_02_0031.html +++ b/docs/sfs/api-ref/sfs_02_0031.html @@ -29,7 +29,7 @@ - diff --git a/docs/sfs/api-ref/sfs_02_0032.html b/docs/sfs/api-ref/sfs_02_0032.html index 21b59126a..b1f76a351 100644 --- a/docs/sfs/api-ref/sfs_02_0032.html +++ b/docs/sfs/api-ref/sfs_02_0032.html @@ -20,7 +20,7 @@ - - diff --git a/docs/sfs/api-ref/sfs_02_0035.html b/docs/sfs/api-ref/sfs_02_0035.html index 420c3c736..d2d381194 100644 --- a/docs/sfs/api-ref/sfs_02_0035.html +++ b/docs/sfs/api-ref/sfs_02_0035.html @@ -31,7 +31,7 @@ - diff --git a/docs/sfs/api-ref/sfs_02_0039.html b/docs/sfs/api-ref/sfs_02_0039.html index 6e7f26aa2..976ad3ea5 100644 --- a/docs/sfs/api-ref/sfs_02_0039.html +++ b/docs/sfs/api-ref/sfs_02_0039.html @@ -63,7 +63,7 @@ diff --git a/docs/sfs/api-ref/sfs_02_0043.html b/docs/sfs/api-ref/sfs_02_0043.html index e33571695..b6e9d29a2 100644 --- a/docs/sfs/api-ref/sfs_02_0043.html +++ b/docs/sfs/api-ref/sfs_02_0043.html @@ -337,7 +337,7 @@ - + + + - + + + + + + + + + + + + + + + + + + + +

        Parameter

        Type

        diff --git a/docs/sfs/api-ref/sfs_02_0023.html b/docs/sfs/api-ref/sfs_02_0023.html index 7a16b8d74..468a6d29c 100644 --- a/docs/sfs/api-ref/sfs_02_0023.html +++ b/docs/sfs/api-ref/sfs_02_0023.html @@ -20,7 +20,7 @@

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        all_tenants

        diff --git a/docs/sfs/api-ref/sfs_02_0024.html b/docs/sfs/api-ref/sfs_02_0024.html index d12191661..6e64d40df 100644 --- a/docs/sfs/api-ref/sfs_02_0024.html +++ b/docs/sfs/api-ref/sfs_02_0024.html @@ -29,7 +29,7 @@

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        vpc_ip_base_acl

        @@ -227,14 +227,14 @@

        String

        Specifies the time when the access rule was created. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.

        +

        Specifies the time when the access rule was created. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.

        updated_at

        String

        Specifies the time when the access rule was updated. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.

        +

        Specifies the time when the access rule was updated. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        project_id

        diff --git a/docs/sfs/api-ref/sfs_02_0034.html b/docs/sfs/api-ref/sfs_02_0034.html index e78c0e1cd..dde693be9 100644 --- a/docs/sfs/api-ref/sfs_02_0034.html +++ b/docs/sfs/api-ref/sfs_02_0034.html @@ -31,7 +31,7 @@

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        String

        Specifies the project ID of the operator.

        +

        Specifies the project ID of the operator.

        Only the op_service permission can obtain this field.

        1. Currently, only one resource_tag structure key is used, _sys_enterprise_project_id.
        2. Currently, key contains only one value.
        -

        This field cannot be returned in non-op_service scenarios.

        +

        This field is not returned for users without the op_service permission.

        Only the op_service permission can obtain this field.

        1. Currently, only one tag structure key is used, _sys_enterprise_project_id.
        2. Currently, key contains only one value.
        -

        This field cannot be returned in non-op_service scenarios.

        +

        This field is not returned for users without the op_service permission.

        resource_name

        diff --git a/docs/sfs/api-ref/sfs_02_0080.html b/docs/sfs/api-ref/sfs_02_0080.html index c3841c8f2..8019dc7d9 100644 --- a/docs/sfs/api-ref/sfs_02_0080.html +++ b/docs/sfs/api-ref/sfs_02_0080.html @@ -7,7 +7,7 @@

        Policy-based authorization is useful if you want to allow or deny the access to an API.

        Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the ecs:servers:list action.

        -

        Supported Actions

        SFS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

        +

        Supported Actions

        SFS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. See the following common concepts related to policies:

        • Permissions: Statements in a policy that allow or deny certain operations.
        • APIs: REST APIs that can be called by a user who has been granted specific permissions.
        • Actions: Specific operations that are allowed or denied.
        • Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.
        • IAM Project: Authorization scope of a custom policy. A custom policy can be applied to IAM projects and takes effect for the user groups in IAM projects.

          The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.

        diff --git a/docs/sfs/api-ref/sfs_02_0088.html b/docs/sfs/api-ref/sfs_02_0088.html index c3f6b9e5d..b268251ab 100644 --- a/docs/sfs/api-ref/sfs_02_0088.html +++ b/docs/sfs/api-ref/sfs_02_0088.html @@ -18,6 +18,10 @@ + +
        diff --git a/docs/sfs/api-ref/sfs_02_0092.html b/docs/sfs/api-ref/sfs_02_0092.html index 931437870..dd8955008 100644 --- a/docs/sfs/api-ref/sfs_02_0092.html +++ b/docs/sfs/api-ref/sfs_02_0092.html @@ -8,7 +8,13 @@

        2026-01-07

        +

        2026-01-21

        +

        Updated the following content:

        + +

        2026-01-07

        Updated the following content:

        Added descriptions about the 500 MB/s/TiB and 1,000 MB/s/TiB SFS Turbo file system types.

        diff --git a/docs/sfs/api-ref/sfs_02_0112.html b/docs/sfs/api-ref/sfs_02_0112.html index cafcf7d31..627c63866 100644 --- a/docs/sfs/api-ref/sfs_02_0112.html +++ b/docs/sfs/api-ref/sfs_02_0112.html @@ -52,9 +52,9 @@

        String

        The header used to specify the file system creation.

        +

        The header field used to specify the file system creation.

        Enumerated value:

        -
        • SFS
        +
        • SFS (creating a file system)

        Host

        @@ -66,6 +66,49 @@

        The host address.

        x-obs-server-side-encryption

        +

        No

        +

        String

        +

        The header field that specifies the file system encryption mode. If this header is not specified, file system encryption is disabled.

        +

        If this is your first time creating an encrypted file system, you need to create an IAM agency to grant the op_svc_sfs account the KMS administrator permissions. For details, see Creating an IAM Agency for Encryption.

        +

        Enumerated value:

        +
        • kms (creating an encrypted file system using server-side encryption)
        +

        x-obs-server-side-data-encryption

        +

        No

        +

        String

        +

        The header field that specifies the algorithm used for server-side encryption. If file system encryption is enabled but this header is not included, the AES256 algorithm is used for data encryption.

        +

        Enumerated values:

        +
        • AES256 (using the AES256 algorithm)
        +

        x-obs-server-side-encryption-kms-key-id

        +

        No

        +

        String

        +

        The header field that specifies the encryption key ID used for server-side encryption. For how to obtain the key ID, see Obtaining a KMS Key ID.

        +

        If you specify kms for encryption but do not specify a key ID, the default key will be used. If the default key is not found, the system will create one and use it.

        +

        x-obs-sse-kms-key-project-id

        +

        No

        +

        String

        +

        The header field that specifies the ID of the project where the server-side encryption key belongs. For how to obtain the project ID, see Obtaining a Project ID.

        +

        Specify the project ID (not an enterprise project ID) that matches the KMS key ID specified by x-obs-server-side-encryption-kms-key-id.

        +
        @@ -97,8 +140,7 @@
      • (Optional) Response Body

        A response body contains information other than the response header. It is usually sent in a structured format (JSON or XML) defined by the response header parameter Content-type.

        -

        Example Request

        Creating a file system in example (with the host address Host: example-sfs-01.sfs3.example.region.com:443):

        -
        PUT / HTTP/1.1
        +

        Example Request: Creating a File System

        Creating a file system in the example region (with the host address Host: example-sfs-01.sfs3.example.region.com:443):
        PUT / HTTP/1.1
         Host: example-sfs-01.sfs3.example.region.com:443
         Date: Wed, 07 Jun 2023 02:38:09 GMT
         x-obs-bucket-type: SFS
        @@ -110,7 +152,8 @@ x-obs-az-redundancy:3az
             <Location>example</Location>
         </CreateBucketConfiguration>
        -

        Example Response

        HTTP/1.1 200 OK
        +
        +

        Example Response: Creating a File System

        HTTP/1.1 200 OK
         Server: OBS
         X-Obs-Request-Id: 0000018893B8058EC0470388BE6EDE88
         Location: /example-sfs-01
        @@ -118,16 +161,60 @@ X-Obs-Id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCTRa4voOUvr50ncznQT/hligMxL4so2z
         Date: Wed, 07 Jun 2023 02:38:11 GMT
         Content-Length: 0
        +

        Example Request: Creating an Encrypted File System Using the Default Key

        Creating an encrypted file system using the default key in the example region:
        PUT / HTTP/1.1 
        +Host: example-sfs-02.sfs3.example.region.com:443
        +Date: Wed, 07 Jun 2023 02:38:09 GMT
        +x-obs-bucket-type: SFS
        +Authorization: OBS FNEX1B77SXDIB3TFMSZZ:0Xsnu4hJVOI7VWH0wIQczVN+rbg=
        +Content-Length: 85
        +x-obs-server-side-encryption: kms
        +<CreateBucketConfiguration>
        +    <Location>example</Location>
        +</CreateBucketConfiguration>
        +
        +
        +

        Example Response: Creating an Encrypted File System Using the Default Key

        HTTP/1.1 200 OK
        +Server: OBS
        +X-Obs-Request-Id: 0000018893B8058EC0470388BE6EDE88
        +Location: /example-sfs-02
        +X-Obs-Id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCTRa4voOUvr50ncznQT/hligMxL4so2z
        +Date: Wed, 07 Jun 2023 02:38:11 GMT
        +Content-Length: 0
        +
        +

        Example Request: Creating an Encrypted File System Using a Custom Key

        Creating an encrypted file system using the custom key in the example region (with the key ID d8309a24-41ca-4a72-82f7-f699e39529a9 and the key's project ID c80a2157ba1d46c0825265947342077c):
        PUT / HTTP/1.1 
        +Host: example-sfs-03.sfs3.example.region.com:443
        +Date: Wed, 07 Jun 2023 02:38:09 GMT 
        +x-obs-bucket-type: SFS 
        +Authorization: OBS H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw= 
        +Content-Length: 85 
        +x-obs-server-side-encryption: kms
        +x-obs-server-side-encryption-kms-key-id:d8309a24-41ca-4a72-82f7-f699e39529a9
        +x-obs-sse-kms-key-project-id:c80a2157ba1d46c0825265947342077c
        +<CreateBucketConfiguration> 
        +    <Location>example</Location> 
        +</CreateBucketConfiguration>
        +
        +
        +

        Example Response: Creating an Encrypted File System Using a Custom Key

        HTTP/1.1 200 OK
        +Server: OBS
        +X-Obs-Request-Id: 0000018893B8058EC0470388BE6EDE88
        +Location: /example-sfs-03
        +X-Obs-Id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCTRa4voOUvr50ncznQT/hligMxL4so2z
        +x-obs-server-side-encryption-kms-key-id:d8309a24-41ca-4a72-82f7-f699e39529a9
        +x-obs-sse-kms-key-project-id:c80a2157ba1d46c0825265947342077c
        +Date: Wed, 07 Jun 2023 02:38:11 GMT
        +Content-Length: 0
        +

        Status Codes

        -

        Status Code

        +
        - - - diff --git a/docs/sfs/api-ref/sfs_02_0191.html b/docs/sfs/api-ref/sfs_02_0191.html new file mode 100644 index 000000000..57c7f5929 --- /dev/null +++ b/docs/sfs/api-ref/sfs_02_0191.html @@ -0,0 +1,78 @@ + + +

        Obtaining a KMS Key ID

        +

        Scenarios

        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 Using an API

        You can call the Querying the List of CMKs API of KMS to obtain the key ID.

        +

        The API used to obtain a key ID is POST https://{Endpoint}/v1.0/{project_id}/kms/list-keys. {Endpoint} is the IAM endpoint, and you can obtain it from Regions and Endpoints. You can obtain {project_id} by referring to Obtaining a Project ID.

        +

        The following shows an example request and response. For details about the parameters, see Querying the List of CMKs.

        +

        Example request:

        +
        {
        +     "limit": "2",
        +     "marker": "1"
        +}
        +

        Example response: key_id indicates the key ID.

        +
        {
        +  "keys" : [ "0d0466b0-e727-4d9c-b35d-f84bb474a37f"],
        +  "key_details" : [ {
        +    "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
        +    "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd",
        +    "key_alias" : "test",
        +    "realm" : "aaa",
        +    "key_description" : "key_description",
        +    "creation_date" : "1502799822000",
        +    "scheduled_deletion_date" : "",
        +    "key_spec" : "AES_256",
        +    "key_usage" : "ENCRYPT_DECRYPT",
        +    "key_state" : "2",
        +    "default_key_flag" : "0",
        +    "key_type" : "1",
        +    "expiration_time" : "1501578672000",
        +    "origin" : "kms",
        +    "key_rotation_enabled" : "true",
        +    "sys_enterprise_project_id" : "0",
        +    "partition_type" : "1"
        +}
        +  ],
        +  "next_marker" : "",
        +  "truncated" : "false",
        +  "total" : 1
        +}
        +
        +

        Creating a KMS Key and Obtaining Its ID Using an API

        If no key is found, you can call the Creating a CMK API of KMS to create one.

        +

        The API used to create a key is POST https://{Endpoint}/v1.0/{project_id}/kms/create-key. {Endpoint} is the IAM endpoint, and you can obtain it from Regions and Endpoints. You can obtain {project_id} by referring to Obtaining a Project ID.

        +

        The following shows an example request and response. For details about the parameters, see Creating a CMK.

        +

        Example request:

        +
        {
        +     "key_alias": "test"
        +}
        +

        Example response: key_id indicates the key ID.

        +
        {
        +  "key_info" : {
        +    "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
        +    "domain_id" : "b168fe00ff56492495a7d22974df2d0b"
        +  }
        +} 
        +
        +

        Querying the ID of a KMS Key on the Console

        1. Log in to the KMS console and choose Key Management Service.
        2. Select the desired region in the upper left corner.
        3. On the Custom Keys tab, copy the ID of the desired key.

          Figure 1 Copying the key ID
          +

        +
        +

        Creating a KMS Key and Obtaining Its ID on the Console

        1. Log in to the KMS console and choose Key Management Service.
        1. Select the desired region in the upper left corner.
        2. Click Create Key in the upper right corner. On the displayed page, set the parameters and click OK.

          Figure 2 Creating a key
          +

        3. On the Custom Keys tab, copy the ID of the desired key.

          Figure 3 Copying the key ID
          +

        +
        +
        +
        + +
        + + + \ No newline at end of file diff --git a/docs/sfs/api-ref/sfs_02_0192.html b/docs/sfs/api-ref/sfs_02_0192.html new file mode 100644 index 000000000..f89b69fa5 --- /dev/null +++ b/docs/sfs/api-ref/sfs_02_0192.html @@ -0,0 +1,20 @@ + + +

        Creating an IAM Agency for Encryption

        +

        Scenarios

        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. The created agency takes effect in about 10 minutes.

        +
        +

        Creating an Agency on the Console

        1. Log in to the IAM console.
        2. In the navigation pane on the left, choose Agencies.
        3. Click Create Agency in the upper right corner. On the displayed page, set the parameters based on your requirements. Mandatory parameters are described as follows:

          +
          • Agency Name: Enter a name, for example, SFSAccessKMS.
          • Agency Type: Select Account.
          • Delegated Account: Enter op_svc_sfs.
          • Validity Period: Select Unlimited. After the configuration is complete, click OK.
          +

        4. After the agency is created, click Authorize in the Operation column.
        5. Select a policy.

          Search for and select the KMS Administrator policy and click Next.

          +

          +

        6. Select a scope.

          All resources is preselected. You can select Region-specific projects as required. Click OK.

          +

          +

        +
        +
        +
        + +
        +

        Status Code

        Description

        +

        Description

        200

        +

        200

        The file system is created.

        +

        The file system is created.