yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

sfs_api_260228

Browse Source 
Reviewed-by: Miskanin, Jan <jan.miskanin@t-systems.com>
Co-authored-by: lizaoxu <lizaoxu@huawei.com>
Co-committed-by: lizaoxu <lizaoxu@huawei.com>
This commit is contained in:
Zaoxu, Li
2026-04-27 08:13:23 +00:00
committed by zuul
parent d0d66eeb73
commit f8f1b77f86
34 changed files with 803 additions and 561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/sfs/api-ref/ALL_META.TXT.json
View File

@ -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",

22
docs/sfs/api-ref/CLASS.TXT.json
View File

@ -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"
}
]

13
docs/sfs/api-ref/CreateShare.html
View File

@ -257,17 +257,8 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p>The file system bandwidth.</p>
<p>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.</p>
<p>Specify <strong>20M</strong> for a 20 MB/s/TiB file system, <strong>40M</strong> for a 40 MB/s/TiB file system, <strong>125M</strong> for a 125 MB/s/TiB file system, and <strong>250M</strong> for a 250 MB/s/TiB file system. Specify <strong>500M</strong> for a 500 MB/s/TiB file system and <strong>1000M</strong> for a 1,000 MB/s/TiB file system.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p>vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p>The vault ID.</p>
<p>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.</p>
<p>Specify <strong>20M</strong> for a 20 MB/s/TiB file system and specify <strong>40M</strong> for a 40 MB/s/TiB file system. Specify <strong>125M</strong> for a 125 MB/s/TiB file system and specify <strong>250M</strong> for a 250 MB/s/TiB file system. Specify <strong>500M</strong> for a 500 MB/s/TiB file system and specify <strong>1000M</strong> for a 1,000 MB/s/TiB file system. </p>
</td>
</tr>
</tbody>

420
docs/sfs/api-ref/ListShares.html
View File

File diff suppressed because it is too large Load Diff

218
docs/sfs/api-ref/ShowClientIpInfo.html
View File

File diff suppressed because it is too large Load Diff

4
docs/sfs/api-ref/ShowJobDetail.html
View File

@ -124,7 +124,7 @@
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>The task type.</p>
<p>Enumerated values:</p>
<p>Enumeration values:</p>
<ul><li><p><strong>create_share</strong>: creating a file system</p>
</li><li><p><strong>hpc_create_share</strong>: creating a file system</p>
</li><li><p><strong>delete_share</strong>: deleting a file system</p>
@ -207,7 +207,7 @@
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p>The subtask type.</p>
<p>Enumerated values:</p>
<p>Enumeration values:</p>
<ul><li><p><strong>create_share</strong>: creating a file system</p>
</li><li><p><strong>hpc_create_share</strong>: creating a file system</p>
</li><li><p><strong>delete_share</strong>: deleting a file system</p>

382
docs/sfs/api-ref/ShowShare.html
View File

File diff suppressed because it is too large Load Diff

BIN
docs/sfs/api-ref/en-us_image_0000002511210156.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 417 KiB

BIN
docs/sfs/api-ref/en-us_image_0000002511370156.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 266 KiB

BIN
docs/sfs/api-ref/en-us_image_0000002542835887.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 266 KiB

2
docs/sfs/api-ref/sfs_02_0001.html
View File

@ -4,7 +4,7 @@
<div id="body8662426"><p id="sfs_02_0001__p1645204610259">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://<em id="sfs_02_0001__aca1eab249b8e49e7a4c208db8c1c484f">Endpoint/uri</em>. In the URL, <strong id="sfs_02_0001__b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="sfs_02_0001__p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="sfs_02_0001__b3082532510259">Application/json</strong>.</p>
<p id="sfs_02_0001__p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
<p id="sfs_02_0001__p1622912567545">An endpoint is the <strong id="sfs_02_0001__b3883190111215">request address</strong> for calling an API. Endpoints vary depending on services and regions.</p>
<p id="sfs_02_0001__p1622912567545">An endpoint is the <strong id="sfs_02_0001__b143821865810">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0001__table10404183115620" frame="border" border="1" rules="all"><caption><b>Table 1 </b>SFS endpoint information</caption><thead align="left"><tr id="sfs_02_0001__row440411345616"><th align="left" class="cellrowborder" valign="top" width="21.98219821982198%" id="mcps1.3.5.2.5.1.1"><p id="sfs_02_0001__p1719113455551">Service Name</p>
</th>

6
docs/sfs/api-ref/sfs_02_0009.html
View File

@ -80,7 +80,7 @@
</table>
</div>
</div>
<p id="sfs_02_0009__en-us_topic_0121682347_p3759142614815">For example, in the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request method is <span class="parmname" id="sfs_02_0009__en-us_topic_0121682347_parmname1652714276561"><b>POST</b></span>. The request is as follows:</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p3759142614815">For example, in the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request method is <span class="parmname" id="sfs_02_0009__en-us_topic_0121682347_parmname73577117453"><b>POST</b></span>. The request is as follows:</p>
<div class="codecoloring" codetype="Java" id="sfs_02_0009__en-us_topic_0121682347_screen7888377244"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{{endpoint}}/v3/auth/tokens</span>
</pre></div></td></tr></table></div>
</div>
@ -156,7 +156,7 @@
<div class="note" id="sfs_02_0009__en-us_topic_0121682347_note13771123325011"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0009__en-us_topic_0121682347_p1513412221808">In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the <strong id="sfs_02_0009__en-us_topic_0121682347_b1411717123020">Authorization</strong> (signature authentication) and <strong id="sfs_02_0009__en-us_topic_0121682347_b91187122001">X-Sdk-Date</strong> (time when a request is sent) headers are automatically added in the request.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p1577123365010">For more details, see "Authentication Using AK/SK" in <a href="sfs_02_0011.html">Authentication</a>.</p>
</div></div>
<p id="sfs_02_0009__en-us_topic_0121682347_p9786614164616">The API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> does not require authentication. Therefore, only the <strong id="sfs_02_0009__en-us_topic_0121682347_b201361848185812">Content-Type</strong> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p9786614164616">The API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> does not require authentication. Therefore, only the <strong id="sfs_02_0009__en-us_topic_0121682347_b1098812376450">Content-Type</strong> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
<div class="codecoloring" codetype="Java" id="sfs_02_0009__en-us_topic_0121682347_screen73731462616"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{{endpoint}}/v3/auth/tokens</span>
<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span><span class="w"> </span><span class="n">application</span><span class="o">/</span><span class="n">json</span>
@ -165,7 +165,7 @@
</div>
<div class="section" id="sfs_02_0009__en-us_topic_0121682347_en-us_topic_0113746487_section1437471411"><h4 class="sectiontitle">(Optional) Request Body</h4><p id="sfs_02_0009__en-us_topic_0121682347_en-us_topic_0113746487_p76011911717">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 <strong id="sfs_02_0009__en-us_topic_0121682347_b190810592581">Content-Type</strong> header field. The request body transfers content except the request header.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p1847214711331">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.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p105261225101112">In the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="sfs_02_0009__en-us_topic_0121682347_i173931259123513">username</em>, <em id="sfs_02_0009__en-us_topic_0121682347_i15393155993513">domainname</em> (), <em id="sfs_02_0009__en-us_topic_0121682347_i20393559113515">$ADMIN_PASS</em> (login password), and <em id="sfs_02_0009__en-us_topic_0121682347_i14393205933515">xxxxxxxxxxxxxxxxxx</em> (project name) with the actual values. Obtain a project name from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p105261225101112">In the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="sfs_02_0009__en-us_topic_0121682347_i1834183534610">username</em>, <em id="sfs_02_0009__en-us_topic_0121682347_i133483534617">domainname</em> (), <em id="sfs_02_0009__en-us_topic_0121682347_i1434153520465">$ADMIN_PASS</em> (login password), and <em id="sfs_02_0009__en-us_topic_0121682347_i113410356465">xxxxxxxxxxxxxxxxxx</em> (project name) with the actual values. Obtain a project name from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<div class="note" id="sfs_02_0009__en-us_topic_0121682347_note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0009__en-us_topic_0121682347_p199011223194814">The <strong id="sfs_02_0009__en-us_topic_0121682347_b1186815753415">scope</strong> parameter specifies where a token takes effect. You can set <strong id="sfs_02_0009__en-us_topic_0121682347_b1246371618347">scope</strong> 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 <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</p>
</div></div>
<div class="codecoloring" codetype="Java" id="sfs_02_0009__en-us_topic_0121682347_screen6140617194816"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>

2
docs/sfs/api-ref/sfs_02_0011.html
View File

@ -14,7 +14,7 @@
<div class="section" id="sfs_02_0011__en-us_topic_0121671869_section2417768214391"><h4 class="sectiontitle">Token Authentication</h4><div class="note" id="sfs_02_0011__en-us_topic_0121671869_note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="sfs_02_0011__en-us_topic_0121671869_ul767015291815"><li id="sfs_02_0011__en-us_topic_0121671869_li192544361384">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.</li><li id="sfs_02_0011__en-us_topic_0121671869_li368213291286">Before using a token, ensure that it has sufficient time remaining before expiration. Using a near-expiry token may cause API call failures.</li></ul>
</div></div>
<p id="sfs_02_0011__en-us_topic_0121671869_p24084172174">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 <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a> API.</p>
<p id="sfs_02_0011__en-us_topic_0121671869_p18703477214">IMS is a project-level service. When you call the API, set <strong id="sfs_02_0011__en-us_topic_0121671869_b1442622113014">auth.scope</strong> in the request body to <strong id="sfs_02_0011__en-us_topic_0121671869_b9433321123019">project</strong>.</p>
<p id="sfs_02_0011__en-us_topic_0121671869_p18703477214">IMS is a project-level service. When you call the API, set <strong id="sfs_02_0011__en-us_topic_0121671869_b84973816563">auth.scope</strong> in the request body to <strong id="sfs_02_0011__en-us_topic_0121671869_b74989895610">project</strong>.</p>
<p id="sfs_02_0011__en-us_topic_0121671869_p5296182518188"></p>
<pre class="screen" id="sfs_02_0011__en-us_topic_0121671869_screen1830175615316">{
"auth": {

2
docs/sfs/api-ref/sfs_02_0014.html
View File

@ -41,7 +41,7 @@
"is_public": false
}
}</pre>
<ul id="sfs_02_0014__ul281147101818"><li id="sfs_02_0014__li10828476187"><strong id="sfs_02_0014__b135459819104">#sfs_crypt_key_id</strong>: Specifies the encryption key ID. If <strong id="sfs_02_0014__b39866814912">#sfs_crypt_key_id</strong>, <strong id="sfs_02_0014__b842352706102249">#sfs_crypt_domain_id</strong>, and <strong id="sfs_02_0014__b842352706102259">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li116161011887"><strong id="sfs_02_0014__b121083287124">#sfs_crypt_domain_id</strong>: Specifies the tenant domain ID. If <strong id="sfs_02_0014__b2978194911">#sfs_crypt_domain_id</strong>, <strong id="sfs_02_0014__b1042501305">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b1194457898">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li184110121816"><strong id="sfs_02_0014__b1589119542136">#sfs_crypt_alias</strong>: Specifies the encryption key alias. If <strong id="sfs_02_0014__b1913312304919">#sfs_crypt_alias</strong>, <strong id="sfs_02_0014__b1951830176">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b498430989">#sfs_crypt_domain_id</strong> exist at the same time, the data encryption function is enabled.</li></ul>
<ul id="sfs_02_0014__ul281147101818"><li id="sfs_02_0014__li10828476187"><strong id="sfs_02_0014__b135459819104">#sfs_crypt_key_id</strong>: Specifies the encryption key ID. If <strong id="sfs_02_0014__b39866814912">#sfs_crypt_key_id</strong>, <strong id="sfs_02_0014__b842352706102249">#sfs_crypt_domain_id</strong>, and <strong id="sfs_02_0014__b842352706102259">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li116161011887"><strong id="sfs_02_0014__b121083287124">#sfs_crypt_domain_id</strong>: Specifies the tenant domain ID. If <strong id="sfs_02_0014__b2978194911">#sfs_crypt_domain_id</strong>, <strong id="sfs_02_0014__b821435631">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b1914705447">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li184110121816"><strong id="sfs_02_0014__b1589119542136">#sfs_crypt_alias</strong>: Specifies the encryption key alias. If <strong id="sfs_02_0014__b1913312304919">#sfs_crypt_alias</strong>, <strong id="sfs_02_0014__b1685248114">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b482964856">#sfs_crypt_domain_id</strong> exist at the same time, the data encryption function is enabled.</li></ul>
</div>
</div>

6
docs/sfs/api-ref/sfs_02_0021.html
View File

@ -2,7 +2,7 @@
<h1 class="topictitle1">Creating a Shared File System</h1>
<div id="body8662426"><div class="section" id="sfs_02_0021__sc880cc1b32be442c93ddc31872c5bba9"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0021__ae318f91bf2b84f57b1588f802d79ed7d">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. </p>
<div class="note" id="sfs_02_0021__n2a30d91894504b8fbfa7a7a5499eca05"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0021__p15051317781">This API is an asynchronous API. If the returned status code is <strong id="sfs_02_0021__b10626324203017">200</strong>, the API request is successfully delivered and received. Later, you can query the status and path of the shared file system by referring to <a href="sfs_02_0024.html">Querying Details About a Shared File System</a> to identify whether the creation is complete and successful. If the status of the shared file system becomes <strong id="sfs_02_0021__b11784184552512">available</strong> or the shared path is generated, the creation is successful.</p>
<div class="note" id="sfs_02_0021__n2a30d91894504b8fbfa7a7a5499eca05"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0021__p113471953154619">This API is an asynchronous API. If the returned status code is <strong id="sfs_02_0021__b10601726104014">200</strong>, the API request is successfully delivered and received. Later, you can query the status and path of the shared file system by referring to <a href="sfs_02_0024.html">Querying Details About a Shared File System</a> to identify whether the creation is complete and successful. If the status of the shared file system becomes <strong id="sfs_02_0021__b360172684016">available</strong> or the shared path is generated, the creation is successful.</p>
</div></div>
<div class="notice" id="sfs_02_0021__note4501195513299"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="sfs_02_0021__p158428563292">After a shared file system is created successfully, it can be used only after you add share access rules by referring to <a href="sfs_02_0029.html">Adding a File System Access Rule</a>.</p>
</div></div>
@ -24,7 +24,7 @@
</td>
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0021__ac77b318c2668498189dbee0fbb5fdb09">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0021__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0021__p1026134246">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>
@ -233,7 +233,7 @@
</tbody>
</table>
</div>
</li><li id="sfs_02_0021__li85221729152117">Description of the <strong id="sfs_02_0021__b547506798">share</strong> field
</li><li id="sfs_02_0021__li85221729152117">Description of the <strong id="sfs_02_0021__b1458556951">share</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__en-us_topic_0064390794_table28597308" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__en-us_topic_0064390794_row26120409"><th align="left" class="cellrowborder" valign="top" width="18.84%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="sfs_02_0021__p1873317135612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.91%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="sfs_02_0021__p473111755617">Type</p>

2
docs/sfs/api-ref/sfs_02_0023.html
View File

@ -20,7 +20,7 @@
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0023__a44681b00405a4900b71337efb5638781">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0023__ac49305b5a17847b4b8291b0ce7fe0617">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0023__p10793311240">Specifies the project ID of the operator.</p>
</td>
</tr>
<tr id="sfs_02_0023__r171525a5ce674cbab69a9a60adb51843"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0023__ae5666fd5d9594ca3ada9813d824aec12">all_tenants</p>

2
docs/sfs/api-ref/sfs_02_0024.html
View File

@ -29,7 +29,7 @@
</td>
<td class="cellrowborder" valign="top" width="20.217978202179786%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0024__a1e454347116f4d32a6ddab1f23458dea">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.91500849915009%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0024__a4f33abc5c1084642a0be5319cf1f297a">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="49.91500849915009%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0024__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0025.html
View File

@ -31,7 +31,7 @@
</td>
<td class="cellrowborder" valign="top" width="20.217978202179786%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0025__a5e09b054a39446f0a7813f37d73fc4bb">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.91500849915009%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0025__a09f81380795242328f7b3934b675d964">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="49.91500849915009%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0025__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0026.html
View File

@ -29,7 +29,7 @@
</td>
<td class="cellrowborder" valign="top" width="19.17%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0026__en-us_topic_0064390795_p220903181347">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.309999999999995%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0026__adc9f3a14f69f4632ac569830b59123b9">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="48.309999999999995%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0026__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0027.html
View File

@ -31,7 +31,7 @@
</td>
<td class="cellrowborder" valign="top" width="19.88%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0027__ac6fa3b3eee82486c975a26a1df39dc4e">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.88%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0027__a4aa4e6fe53a941cd886a5f622400d338">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="47.88%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0027__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

6
docs/sfs/api-ref/sfs_02_0029.html
View File

@ -31,7 +31,7 @@
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0029__abf640452fc5e406bb823506eccfc3179">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.344934493449344%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0029__a6e5fab7f9bd34ef49b348c6248bad26a">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="49.344934493449344%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0029__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
<tr id="sfs_02_0029__row1189816611118"><td class="cellrowborder" valign="top" width="17.95179517951795%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0029__p88981669112">vpc_ip_base_acl</p>
@ -227,14 +227,14 @@
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0029__p5201165514816">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p72011155134814">Specifies the time when the access rule was created. This parameter exists only when the value of <strong id="sfs_02_0029__b789430517">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p72011155134814">Specifies the time when the access rule was created. This parameter exists only when the value of <strong id="sfs_02_0029__b130285002">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
</td>
</tr>
<tr id="sfs_02_0029__row147971753154819"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0029__p1463583132213">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0029__p1520115553482">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p1720135512481">Specifies the time when the access rule was updated. This parameter exists only when the value of <strong id="sfs_02_0029__b393542902">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p1720135512481">Specifies the time when the access rule was updated. This parameter exists only when the value of <strong id="sfs_02_0029__b1766298040">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0030.html
View File

@ -31,7 +31,7 @@
</td>
<td class="cellrowborder" valign="top" width="18.279999999999998%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0030__a23e80aa107554437b2a2cc9d93ced01a">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0030__a7f2f8b0f2c4a484499c65c3e2a6cb2e6">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0030__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0031.html
View File

@ -29,7 +29,7 @@
</td>
<td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0031__a98fb9af656a541fb849dfae43da42811">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.75%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0031__ac650082eebc04454bd7512859110c8d0">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="45.75%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0031__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0032.html
View File

@ -20,7 +20,7 @@
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0032__ab5b3a85c0cbd4e9b8fa4058ee0714927">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.48514851485149%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0032__en-us_topic_0076901826_p7089989">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="51.48514851485149%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0032__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
<tr id="sfs_02_0032__r0d2a51699d5a49da898264abc9f1b128"><td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0032__a2d281854f2eb4cddbf8e566e0d239477">project_id</p>

2
docs/sfs/api-ref/sfs_02_0034.html
View File

@ -31,7 +31,7 @@
</td>
<td class="cellrowborder" valign="top" width="21.93%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0034__a582ca5c66a514507a75aca16841d8b47">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.62%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0034__abfe5b79c46fc49e8a0a9562a7a4ee510">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="45.62%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0034__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0035.html
View File

@ -31,7 +31,7 @@
</td>
<td class="cellrowborder" valign="top" width="19.88%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0035__ac30571b6991542e5934d578a18801382">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.59%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0035__a06f18709bc764f818dedfef3939d8c11">Specifies the project ID of the operator.</p>
<td class="cellrowborder" valign="top" width="52.59%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0035__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0039.html
View File

@ -63,7 +63,7 @@
</td>
<td class="cellrowborder" valign="top" width="64.56%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="sfs_02_0039__p172864425217">Only the op_service permission can obtain this field.</p>
<ol id="sfs_02_0039__ol13281444125215"><li id="sfs_02_0039__li928134475211">Currently, only one resource_tag structure key is used, <strong id="sfs_02_0039__b5237534359">_sys_enterprise_project_id</strong>.</li><li id="sfs_02_0039__li828174412525">Currently, <strong id="sfs_02_0039__b834933063519">key</strong> contains only one value.</li></ol>
<p id="sfs_02_0039__p42864485214">This field cannot be returned in non-op_service scenarios.</p>
<p id="sfs_02_0039__p42864485214">This field is not returned for users without the op_service permission.</p>
</td>
</tr>
</tbody>

2
docs/sfs/api-ref/sfs_02_0043.html
View File

@ -337,7 +337,7 @@
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.2.2.1.4.1.3 "><p id="sfs_02_0043__p678712042612">Only the op_service permission can obtain this field.</p>
<ol id="sfs_02_0043__ol2078702010263"><li id="sfs_02_0043__li978713202266">Currently, only one tag structure key is used, <strong id="sfs_02_0043__b175413154417">_sys_enterprise_project_id</strong>.</li><li id="sfs_02_0043__li5787220192610">Currently, <strong id="sfs_02_0043__b59619143448">key</strong> contains only one value.</li></ol>
<p id="sfs_02_0043__p1878752022615">This field cannot be returned in non-op_service scenarios.</p>
<p id="sfs_02_0043__p1878752022615">This field is not returned for users without the op_service permission.</p>
</td>
</tr>
<tr id="sfs_02_0043__row128361914162515"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.1 "><p id="sfs_02_0043__p88361514202515">resource_name</p>

2
docs/sfs/api-ref/sfs_02_0080.html
View File

@ -7,7 +7,7 @@
<div class="note" id="sfs_02_0080__note12194154412428"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0080__p12572232548">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="sfs_02_0080__p72721744174218">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 <strong id="sfs_02_0080__b983516555436">ecs:servers:list</strong> action.</p>
<div class="section" id="sfs_02_0080__section54925131575"><h4 class="sectiontitle">Supported Actions</h4><p id="sfs_02_0080__p1024315617012">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:</p>
<div class="section" id="sfs_02_0080__section54925131575"><h4 class="sectiontitle">Supported Actions</h4><p id="sfs_02_0080__p1024315617012">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:</p>
<ul id="sfs_02_0080__ul831515201117"><li id="sfs_02_0080__li1431518203113">Permissions: Statements in a policy that allow or deny certain operations.</li><li id="sfs_02_0080__li33119583019">APIs: REST APIs that can be called by a user who has been granted specific permissions.</li><li id="sfs_02_0080__li123156201611">Actions: Specific operations that are allowed or denied.</li><li id="sfs_02_0080__li37709201923">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.</li><li id="sfs_02_0080__li375039151114">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.<div class="note" id="sfs_02_0080__note63781251228"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0080__p176629551222">The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.</p>
</div></div>
</li></ul>

4
docs/sfs/api-ref/sfs_02_0088.html
View File

@ -18,6 +18,10 @@
</li>
<li class="ulchildlink"><strong><a href="sfs_02_0090.html">Obtaining a Project ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_02_0191.html">Obtaining a KMS Key ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_02_0192.html">Creating an IAM Agency for Encryption</a></strong><br>
</li>
</ul>
</div>

8
docs/sfs/api-ref/sfs_02_0092.html
View File

@ -8,7 +8,13 @@
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0092__row11479825205611"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p0551451124920">2026-01-07</p>
<tbody><tr id="sfs_02_0092__row842014425332"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p2082293203215">2026-01-21</p>
</td>
<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.1.1.3.1.2 "><p id="sfs_02_0092__p19451192716329">Updated the following content:</p>
<ul id="sfs_02_0092__ul094082703914"><li id="sfs_02_0092__li89401127183916">Added support for server-side encryption for general purpose file systems and added related description.</li><li id="sfs_02_0092__li8940527103911">Added section <a href="sfs_02_0191.html">Obtaining a KMS Key ID</a>.</li><li id="sfs_02_0092__li1894082712396">Added section <a href="sfs_02_0192.html">Creating an IAM Agency for Encryption</a>.</li></ul>
</td>
</tr>
<tr id="sfs_02_0092__row11479825205611"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p0551451124920">2026-01-07</p>
</td>
<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.1.1.3.1.2 "><p id="sfs_02_0092__p9395102620492">Updated the following content:</p>
<p id="sfs_02_0092__p192537525568">Added descriptions about the 500 MB/s/TiB and 1,000 MB/s/TiB SFS Turbo file system types.</p>

105
docs/sfs/api-ref/sfs_02_0112.html
View File

File diff suppressed because it is too large Load Diff

78
docs/sfs/api-ref/sfs_02_0191.html Normal file
View File

@ -0,0 +1,78 @@
<a name="sfs_02_0191"></a><a name="sfs_02_0191"></a>
<h1 class="topictitle1">Obtaining a KMS Key ID</h1>
<div id="body0000002369624938"><div class="section" id="sfs_02_0191__section137061610165617"><h4 class="sectiontitle">Scenarios</h4><p id="sfs_02_0191__p1037012119562">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:</p>
<ul id="sfs_02_0191__ul1237061195611"><li id="sfs_02_0191__li15370171117566"><a href="#sfs_02_0191__section11713201013562">Querying the ID of a KMS Key Using an API</a></li><li id="sfs_02_0191__li437081155615"><a href="#sfs_02_0191__section271871075611">Creating a KMS Key and Obtaining Its ID Using an API</a></li><li id="sfs_02_0191__li837041145618"><a href="#sfs_02_0191__section672081015563">Querying the ID of a KMS Key on the Console</a></li><li id="sfs_02_0191__li137015114566"><a href="#sfs_02_0191__section1672220107566">Creating a KMS Key and Obtaining Its ID on the Console</a></li></ul>
</div>
<div class="section" id="sfs_02_0191__section11713201013562"><a name="sfs_02_0191__section11713201013562"></a><a name="section11713201013562"></a><h4 class="sectiontitle">Querying the ID of a KMS Key Using an API</h4><p id="sfs_02_0191__p18370161117566">You can call the <a href="https://docs.otc.t-systems.com/key-management-service/api-ref/apis/key_management_service/cmk_management/querying_the_list_of_cmks.html" target="_blank" rel="noopener noreferrer">Querying the List of CMKs</a> API of KMS to obtain the key ID.</p>
<p id="sfs_02_0191__p176621618317">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 <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. You can obtain {project_id} by referring to <a href="sfs_02_0090.html">Obtaining a Project ID</a>.</p>
<p id="sfs_02_0191__p83779551922">The following shows an example request and response. For details about the parameters, see <a href="https://docs.otc.t-systems.com/key-management-service/api-ref/apis/key_management_service/cmk_management/querying_the_list_of_cmks.html" target="_blank" rel="noopener noreferrer">Querying the List of CMKs</a>.</p>
<p id="sfs_02_0191__p12943125125815"><strong id="sfs_02_0191__b20834125417166">Example request:</strong></p>
<pre class="screen" id="sfs_02_0191__screen77074135599">{
"limit": "2",
"marker": "1"
}</pre>
<p id="sfs_02_0191__p1937071175612"><strong id="sfs_02_0191__b76214181951">Example response</strong>: <strong id="sfs_02_0191__b54262391711">key_id</strong> indicates the key ID.</p>
<pre class="screen" id="sfs_02_0191__screen3370111113563">{
"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
}</pre>
</div>
<div class="section" id="sfs_02_0191__section271871075611"><a name="sfs_02_0191__section271871075611"></a><a name="section271871075611"></a><h4 class="sectiontitle">Creating a KMS Key and Obtaining Its ID Using an API</h4><p id="sfs_02_0191__p737114112569">If no key is found, you can call the <a href="https://docs.otc.t-systems.com/key-management-service/api-ref/apis/key_management_service/cmk_management/creating_a_cmk.html" target="_blank" rel="noopener noreferrer">Creating a CMK</a> API of KMS to create one.</p>
<p id="sfs_02_0191__p29354191432">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 <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. You can obtain {project_id} by referring to <a href="sfs_02_0090.html">Obtaining a Project ID</a>.</p>
<p id="sfs_02_0191__p274174613512">The following shows an example request and response. For details about the parameters, see <a href="https://docs.otc.t-systems.com/key-management-service/api-ref/apis/key_management_service/cmk_management/creating_a_cmk.html" target="_blank" rel="noopener noreferrer">Creating a CMK</a>.</p>
<p id="sfs_02_0191__p1239917613113"><strong id="sfs_02_0191__b043252672119">Example request:</strong></p>
<pre class="screen" id="sfs_02_0191__screen84518101513">{
"key_alias": "test"
}</pre>
<p id="sfs_02_0191__p1537151113568"><strong id="sfs_02_0191__b138352413220">Example response</strong>: <strong id="sfs_02_0191__b7383024132215">key_id</strong> indicates the key ID.</p>
<pre class="screen" id="sfs_02_0191__screen12371411185619">{
"key_info" : {
"key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"domain_id" : "b168fe00ff56492495a7d22974df2d0b"
}
} </pre>
</div>
<div class="section" id="sfs_02_0191__section672081015563"><a name="sfs_02_0191__section672081015563"></a><a name="section672081015563"></a><h4 class="sectiontitle">Querying the ID of a KMS Key on the Console</h4><ol id="sfs_02_0191__ol1783103110818"><li id="sfs_02_0191__li83831424181914"><span>Log in to the <span id="sfs_02_0191__ph590010420232">KMS</span> console and choose <strong id="sfs_02_0191__b10209155192513">Key Management Service</strong>.</span></li><li id="sfs_02_0191__li77831313813"><span>Select the desired region in the upper left corner.</span></li><li id="sfs_02_0191__li1478353119810"><span>On the <strong id="sfs_02_0191__b133361326299">Custom Keys</strong> tab, copy the ID of the desired key.</span><p><div class="fignone" id="sfs_02_0191__fig1955214141416"><span class="figcap"><b>Figure 1 </b>Copying the key ID</span><br><span><img id="sfs_02_0191__image1055212141418" src="en-us_image_0000002542835887.png" title="Click to enlarge" class="imgResize"></span></div>
</p></li></ol>
</div>
<div class="section" id="sfs_02_0191__section1672220107566"><a name="sfs_02_0191__section1672220107566"></a><a name="section1672220107566"></a><h4 class="sectiontitle">Creating a KMS Key and Obtaining Its ID on the Console</h4><ol id="sfs_02_0191__ol9153555134511"><li id="sfs_02_0191__li1632916589451"><span>Log in to the <span id="sfs_02_0191__ph1737735612513">KMS</span> console and choose <strong id="sfs_02_0191__b15377256192511">Key Management Service</strong>.</span></li></ol><ol start="2" id="sfs_02_0191__ol18851926594"><li id="sfs_02_0191__li158516265915"><span>Select the desired region in the upper left corner.</span></li><li id="sfs_02_0191__li88511426695"><span>Click <strong id="sfs_02_0191__b31101347304">Create Key</strong> in the upper right corner. On the displayed page, set the parameters and click <strong id="sfs_02_0191__b159201506306">OK</strong>.</span><p><div class="fignone" id="sfs_02_0191__fig7208143916212"><span class="figcap"><b>Figure 2 </b>Creating a key</span><br><span><img id="sfs_02_0191__image182091439322" src="en-us_image_0000002511210156.png" title="Click to enlarge" class="imgResize"></span></div>
</p></li><li id="sfs_02_0191__li207205810518"><span>On the <strong id="sfs_02_0191__b826410152269">Custom Keys</strong> tab, copy the ID of the desired key.</span><p><div class="fignone" id="sfs_02_0191__fig117201881853"><span class="figcap"><b>Figure 3 </b>Copying the key ID</span><br><span><img id="sfs_02_0191__image17720581055" src="en-us_image_0000002511370156.png" title="Click to enlarge" class="imgResize"></span></div>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0088.html">Appendix</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

20
docs/sfs/api-ref/sfs_02_0192.html Normal file
View File

@ -0,0 +1,20 @@
<a name="sfs_02_0192"></a><a name="sfs_02_0192"></a>
<h1 class="topictitle1">Creating an IAM Agency for Encryption</h1>
<div id="body0000002403224649"><div class="section" id="sfs_02_0192__section15769140141514"><h4 class="sectiontitle">Scenarios</h4><p id="sfs_02_0192__p1280313012151">If this is your first time using file system encryption with the account, you need to create an IAM agency to grant account <strong id="sfs_02_0192__b20601344123214">op_svc_sfs</strong> the KMS Administrator permissions. The created agency takes effect in about 10 minutes.</p>
</div>
<div class="section" id="sfs_02_0192__section17770110121516"><h4 class="sectiontitle">Creating an Agency on the Console</h4><ol id="sfs_02_0192__ol0508195111155"><li id="sfs_02_0192__li125081951141512"><span>Log in to the IAM console.</span></li><li id="sfs_02_0192__li12508155119158"><span>In the navigation pane on the left, choose <strong id="sfs_02_0192__b1836911169312">Agencies</strong>.</span></li><li id="sfs_02_0192__li16508251161510"><span>Click <strong id="sfs_02_0192__b5671182516412">Create Agency</strong> in the upper right corner. On the displayed page, set the parameters based on your requirements. Mandatory parameters are described as follows:</span><p><p id="sfs_02_0192__p1299554192710"></p>
<ul id="sfs_02_0192__ul836644119232"><li id="sfs_02_0192__li1136644192312"><strong id="sfs_02_0192__b9736146663">Agency Name</strong>: Enter a name, for example, <strong id="sfs_02_0192__b11818171118615">SFSAccessKMS</strong>.</li><li id="sfs_02_0192__li636664162311"><strong id="sfs_02_0192__b11802051212">Agency Type</strong>: Select <strong id="sfs_02_0192__b11802058218">Account</strong>.</li><li id="sfs_02_0192__li9366124122313"><strong id="sfs_02_0192__b1192717381766">Delegated Account</strong>: Enter <strong id="sfs_02_0192__b1392012538616">op_svc_sfs</strong>.</li><li id="sfs_02_0192__li136684112315"><strong id="sfs_02_0192__b13923815213">Validity Period</strong>: Select <strong id="sfs_02_0192__b53931782029">Unlimited</strong>. After the configuration is complete, click <strong id="sfs_02_0192__b939378522">OK</strong>.</li></ul>
</p></li><li id="sfs_02_0192__li1650825171519"><span>After the agency is created, click <strong id="sfs_02_0192__b789613221683">Authorize</strong> in the <strong id="sfs_02_0192__b843610191381">Operation</strong> column.</span></li><li id="sfs_02_0192__li1325652182613"><span>Select a policy.</span><p><p id="sfs_02_0192__p426114342615">Search for and select the <strong id="sfs_02_0192__b97211139151114">KMS Administrator</strong> policy and click <strong id="sfs_02_0192__b6191201111010">Next</strong>.</p>
<p id="sfs_02_0192__p1780413019151"></p>
</p></li><li id="sfs_02_0192__li146412462713"><span>Select a scope.</span><p><p id="sfs_02_0192__p666212317414"><strong id="sfs_02_0192__b2410205141216">All resources</strong> is preselected. You can select <strong id="sfs_02_0192__b48603401137">Region-specific projects</strong> as required. Click <strong id="sfs_02_0192__b3385518125">OK</strong>.</p>
<p id="sfs_02_0192__p1880415071520"></p>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0088.html">Appendix</a></div>
</div>
</div>