diff --git a/docs/kms/api-ref/.placeholder b/docs/kms/api-ref/.placeholder
deleted file mode 100644
index e69de29bb..000000000
diff --git a/docs/kms/api-ref/ALL_META.TXT.json b/docs/kms/api-ref/ALL_META.TXT.json
new file mode 100644
index 000000000..0ed2b96ea
--- /dev/null
+++ b/docs/kms/api-ref/ALL_META.TXT.json
@@ -0,0 +1,482 @@
+[
+ {
+ "uri":"en-us_topic_00384375969.html",
+ "product_code":"kms",
+ "code":"1",
+ "des":"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 ",
+ "doc_type":"api",
+ "kw":"API Usage Guidelines,API Reference",
+ "title":"API Usage Guidelines",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0010.html",
+ "product_code":"kms",
+ "code":"2",
+ "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":"APIs",
+ "title":"APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0012.html",
+ "product_code":"kms",
+ "code":"3",
+ "des":"This API is used to create customer master keys (CMKs) used to encrypt data encryption keys (DEKs).Default Master Keys are created by services integrated with KMS. Names ",
+ "doc_type":"api",
+ "kw":"Creating a CMK,APIs,API Reference",
+ "title":"Creating a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0013.html",
+ "product_code":"kms",
+ "code":"4",
+ "des":"This API allows you to enable a CMK. Only an enabled CMK can be used.Only a disabled CMK can be enabled.URI formatPOST /v1.0/{project_id}/kms/enable-keyPOST /v1.0/{projec",
+ "doc_type":"api",
+ "kw":"Enabling a CMK,APIs,API Reference",
+ "title":"Enabling a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0014.html",
+ "product_code":"kms",
+ "code":"5",
+ "des":"This API allows you to disable a CMK. A disabled CMK cannot be used.Only an enabled CMK can be disabled.URI formatPOST /v1.0/{project_id}/kms/disable-keyPOST /v1.0/{proje",
+ "doc_type":"api",
+ "kw":"Disabling a CMK,APIs,API Reference",
+ "title":"Disabling a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0015.html",
+ "product_code":"kms",
+ "code":"6",
+ "des":"This API enables you to schedule the deletion of a CMK. A CMK can be scheduled to be deleted after 7 to 1096 days.URI formatPOST /v1.0/{project_id}/kms/schedule-key-delet",
+ "doc_type":"api",
+ "kw":"Scheduling the Deletion of a CMK,APIs,API Reference",
+ "title":"Scheduling the Deletion of a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0016.html",
+ "product_code":"kms",
+ "code":"7",
+ "des":"This API enables you to cancel the scheduled deletion of a CMK.You can cancel the scheduled deletion for a CMK only when the CMK's status is Scheduled deletion.URI format",
+ "doc_type":"api",
+ "kw":"Canceling the Scheduled Deletion of a CMK,APIs,API Reference",
+ "title":"Canceling the Scheduled Deletion of a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0017.html",
+ "product_code":"kms",
+ "code":"8",
+ "des":"This API allows you to query the list of all CMKs.URI formatPOST /v1.0/{project_id}/kms/list-keysPOST /v1.0/{project_id}/kms/list-keysParameter descriptionParametersParam",
+ "doc_type":"api",
+ "kw":"Querying the List of CMKs,APIs,API Reference",
+ "title":"Querying the List of CMKs",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0018.html",
+ "product_code":"kms",
+ "code":"9",
+ "des":"This API allows you to query the details about a CMK.By default, the performance threshold for querying CMK details is 1000 TPS per customer. To apply for higher performa",
+ "doc_type":"api",
+ "kw":"Querying the Information About a CMK,APIs,API Reference",
+ "title":"Querying the Information About a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0019.html",
+ "product_code":"kms",
+ "code":"10",
+ "des":"This API generates a 512-bit random number.URI formatPOST /v1.0/{project_id}/kms/gen-randomPOST /v1.0/{project_id}/kms/gen-randomParameter descriptionParameter descriptio",
+ "doc_type":"api",
+ "kw":"Creating a Random Number,APIs,API Reference",
+ "title":"Creating a Random Number",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0020.html",
+ "product_code":"kms",
+ "code":"11",
+ "des":"This API allows you to create a DEK. A returned result includes the plaintext and the ciphertext of a DEK.By default, the performance threshold for creating DEKs is 1000 ",
+ "doc_type":"api",
+ "kw":"Creating a DEK,APIs,API Reference",
+ "title":"Creating a DEK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0021.html",
+ "product_code":"kms",
+ "code":"12",
+ "des":"This API allows you to create a plaintext-free DEK, that is, the returned result of this API includes only the ciphertext of the DEK.By default, the performance threshold",
+ "doc_type":"api",
+ "kw":"Creating a Plaintext-Free DEK,APIs,API Reference",
+ "title":"Creating a Plaintext-Free DEK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0022.html",
+ "product_code":"kms",
+ "code":"13",
+ "des":"This API enables you to encrypt a DEK using a specified CMK.By default, the performance threshold for encrypting DEKs is 1000 TPS per customer. To apply for higher perfor",
+ "doc_type":"api",
+ "kw":"Encrypting a DEK,APIs,API Reference",
+ "title":"Encrypting a DEK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0023.html",
+ "product_code":"kms",
+ "code":"14",
+ "des":"This API enables you to decrypt a DEK using a specified CMK.Data encryption results are used for decryption.By default, the performance threshold for decrypting DEKs is 1",
+ "doc_type":"api",
+ "kw":"Decrypting a DEK,APIs,API Reference",
+ "title":"Decrypting a DEK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0024.html",
+ "product_code":"kms",
+ "code":"15",
+ "des":"This API is used to query the number of instances, that is, the number of CMKs created.Default Master Keys are automatically created by services and are not included in t",
+ "doc_type":"api",
+ "kw":"Querying the Number of Instances,APIs,API Reference",
+ "title":"Querying the Number of Instances",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0025.html",
+ "product_code":"kms",
+ "code":"16",
+ "des":"This API is used to query the quota of a user, that is, the allocated total number of CMKs that can be created by a user and the number of CMKs that has been created by t",
+ "doc_type":"api",
+ "kw":"Querying the Quota of a User,APIs,API Reference",
+ "title":"Querying the Quota of a User",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0026.html",
+ "product_code":"kms",
+ "code":"17",
+ "des":"This API enables you to change the alias of a CMK.A Default Master Key (the alias suffix of which is /default) does not allow alias changes.A CMK in Scheduled deletion st",
+ "doc_type":"api",
+ "kw":"Changing the Alias of a CMK,APIs,API Reference",
+ "title":"Changing the Alias of a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0027.html",
+ "product_code":"kms",
+ "code":"18",
+ "des":"This API enables you to change the description of a CMK.A Default Master Key (the alias suffix of which is /default) does not allow alias changes.A CMK in Scheduled delet",
+ "doc_type":"api",
+ "kw":"Changing the Description of a CMK,APIs,API Reference",
+ "title":"Changing the Description of a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0028.html",
+ "product_code":"kms",
+ "code":"19",
+ "des":"This API enables you to create a grant to grant permissions on a CMK to a user so that the user can perform operations on the CMK.A Default Master Key (the alias suffix o",
+ "doc_type":"api",
+ "kw":"Creating a Grant,APIs,API Reference",
+ "title":"Creating a Grant",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0029.html",
+ "product_code":"kms",
+ "code":"20",
+ "des":"This API allows you to revoke a grant.Only the user who created the CMK can revoke a grant.URI formatPOST /v1.0/{project_id}/kms/revoke-grantPOST /v1.0/{project_id}/kms/r",
+ "doc_type":"api",
+ "kw":"Revoking a Grant,APIs,API Reference",
+ "title":"Revoking a Grant",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0030.html",
+ "product_code":"kms",
+ "code":"21",
+ "des":"This API enables users to retire a grant.For example, user A grants operation permissions on CMK A/key to user B and authorizes user C to retire the grant. By doing this,",
+ "doc_type":"api",
+ "kw":"Retiring a Grant,APIs,API Reference",
+ "title":"Retiring a Grant",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0031.html",
+ "product_code":"kms",
+ "code":"22",
+ "des":"This API enables you to query grants on a CMK.URI formatPOST /v1.0/{project_id}/kms/list-grantsPOST /v1.0/{project_id}/kms/list-grantsParameter descriptionParameter descr",
+ "doc_type":"api",
+ "kw":"Querying Grants on a CMK,APIs,API Reference",
+ "title":"Querying Grants on a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0032.html",
+ "product_code":"kms",
+ "code":"23",
+ "des":"This API enables you to query grants that can be retired.URI formatPOST /v1.0/{project_id}/kms/list-retirable-grantsPOST /v1.0/{project_id}/kms/list-retirable-grantsParam",
+ "doc_type":"api",
+ "kw":"Querying Grants That Can Be Retired,APIs,API Reference",
+ "title":"Querying Grants That Can Be Retired",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0035.html",
+ "product_code":"kms",
+ "code":"24",
+ "des":"This API enables you to obtain necessary parameters to import a CMK, including a CMK import token and a CMK encryption public key.The returned public key type is RSA_2048",
+ "doc_type":"api",
+ "kw":"Obtaining CMK Import Parameters,APIs,API Reference",
+ "title":"Obtaining CMK Import Parameters",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0036.html",
+ "product_code":"kms",
+ "code":"25",
+ "des":"This API allows you to import CMK material.URI formatPOST /v1.0/{project_id}/kms/import-key-materialPOST /v1.0/{project_id}/kms/import-key-materialParameter descriptionPa",
+ "doc_type":"api",
+ "kw":"Importing CMK Material,APIs,API Reference",
+ "title":"Importing CMK Material",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0037.html",
+ "product_code":"kms",
+ "code":"26",
+ "des":"This API allows you to delete CMK material.URI formatPOST /v1.0/{project_id}/kms/delete-imported-key-materialPOST /v1.0/{project_id}/kms/delete-imported-key-materialParam",
+ "doc_type":"api",
+ "kw":"Deleting CMK Material,APIs,API Reference",
+ "title":"Deleting CMK Material",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0038.html",
+ "product_code":"kms",
+ "code":"27",
+ "des":"This API allows you to enable rotation for a CMK.The default rotation interval is 365 days.CMKs created using imported key materials and Default Master Keys do not suppor",
+ "doc_type":"api",
+ "kw":"Enabling Rotation for a CMK,APIs,API Reference",
+ "title":"Enabling Rotation for a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0039.html",
+ "product_code":"kms",
+ "code":"28",
+ "des":"This API enables you to change the rotation interval for a CMK.URI formatPOST /v1.0/{project_id}/kms/update-key-rotation-intervalPOST /v1.0/{project_id}/kms/update-key-ro",
+ "doc_type":"api",
+ "kw":"Changing the Rotation Interval for a CMK,APIs,API Reference",
+ "title":"Changing the Rotation Interval for a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0040.html",
+ "product_code":"kms",
+ "code":"29",
+ "des":"This API allows you to disable rotation for a CMK.URI formatPOST /v1.0/{project_id}/kms/disable-key-rotationPOST /v1.0/{project_id}/kms/disable-key-rotationParameter desc",
+ "doc_type":"api",
+ "kw":"Disabling Rotation for a CMK,APIs,API Reference",
+ "title":"Disabling Rotation for a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0041.html",
+ "product_code":"kms",
+ "code":"30",
+ "des":"This API enables you to query the rotation status of a CMK.URI formatPOST /v1.0/{project_id}/kms/get-key-rotation-statusPOST /v1.0/{project_id}/kms/get-key-rotation-statu",
+ "doc_type":"api",
+ "kw":"Querying the Rotation Status of a CMK,APIs,API Reference",
+ "title":"Querying the Rotation Status of a CMK",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0042.html",
+ "product_code":"kms",
+ "code":"31",
+ "des":"This API allows you to query CMK instances.You can use the tag filtering function to query the detailed information about a specified CMK.URI formatPOST /v1.0/{project_id",
+ "doc_type":"api",
+ "kw":"Querying CMK Instances,APIs,API Reference",
+ "title":"Querying CMK Instances",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0043.html",
+ "product_code":"kms",
+ "code":"32",
+ "des":"This API allows you to query tags of a specified CMK.TMS may use this API to query all tags of a specified CMK.URI formatGET /v1.0/{project_id}/kms/{key_id}/tagsGET /v1.0",
+ "doc_type":"api",
+ "kw":"Querying CMK Tags,APIs,API Reference",
+ "title":"Querying CMK Tags",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0044.html",
+ "product_code":"kms",
+ "code":"33",
+ "des":"This API enables you to query all tag sets of a specified project.URI formatGET /v1.0/{project_id}/kms/tagsGET /v1.0/{project_id}/kms/tagsParameter descriptionParameter d",
+ "doc_type":"api",
+ "kw":"Querying Project Tags,APIs,API Reference",
+ "title":"Querying Project Tags",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0045.html",
+ "product_code":"kms",
+ "code":"34",
+ "des":"This API enables you to add or delete CMK tags in batches.URI formatPOST /v1.0/{project_id}/kms/{key_id}/tags/actionPOST /v1.0/{project_id}/kms/{key_id}/tags/actionParame",
+ "doc_type":"api",
+ "kw":"Adding or Deleting CMK Tags in Batches,APIs,API Reference",
+ "title":"Adding or Deleting CMK Tags in Batches",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0046.html",
+ "product_code":"kms",
+ "code":"35",
+ "des":"This API allows you to add a CMK tag.URI formatPOST /v1.0/{project_id}/kms/{key_id}/tagsPOST /v1.0/{project_id}/kms/{key_id}/tagsParameter descriptionParameter descriptio",
+ "doc_type":"api",
+ "kw":"Adding a CMK Tag,APIs,API Reference",
+ "title":"Adding a CMK Tag",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0047.html",
+ "product_code":"kms",
+ "code":"36",
+ "des":"This API enables you to delete a CMK tag.URI formatDELETE /v1.0/{project_id}/kms/{key_id}/tags/{key}DELETE /v1.0/{project_id}/kms/{key_id}/tags/{key}Parameter description",
+ "doc_type":"api",
+ "kw":"Deleting a CMK Tag,APIs,API Reference",
+ "title":"Deleting a CMK Tag",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0048.html",
+ "product_code":"kms",
+ "code":"37",
+ "des":"This API is used to query the API versions.URI formatGET /GET /Parameter descriptionNoneNoneNoneThe following describes how to query the version information.Example reque",
+ "doc_type":"api",
+ "kw":"Querying All API Versions,APIs,API Reference",
+ "title":"Querying All API Versions",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0049.html",
+ "product_code":"kms",
+ "code":"38",
+ "des":"This API is used to query the version of an API.URI formatGET /{version_id}GET /{version_id}Parameter descriptionParameter descriptionParameterMandatoryTypeDescriptionver",
+ "doc_type":"api",
+ "kw":"Querying a Specified API Version,APIs,API Reference",
+ "title":"Querying a Specified API Version",
+ "githuburl":""
+ },
+ {
+ "uri":"dew_02_0307.html",
+ "product_code":"kms",
+ "code":"39",
+ "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":"Permissions Policies and Supported Actions",
+ "title":"Permissions Policies and Supported Actions",
+ "githuburl":""
+ },
+ {
+ "uri":"dew_02_0308.html",
+ "product_code":"kms",
+ "code":"40",
+ "des":"This chapter describes fine-grained permissions management for your KMS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul",
+ "doc_type":"api",
+ "kw":"Introduction,Permissions Policies and Supported Actions,API Reference",
+ "title":"Introduction",
+ "githuburl":""
+ },
+ {
+ "uri":"dew_02_0309.html",
+ "product_code":"kms",
+ "code":"41",
+ "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":"Encryption Key Management,Permissions Policies and Supported Actions,API Reference",
+ "title":"Encryption Key Management",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0300.html",
+ "product_code":"kms",
+ "code":"42",
+ "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":"Appendix",
+ "title":"Appendix",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0301.html",
+ "product_code":"kms",
+ "code":"43",
+ "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":"Status Codes,Appendix,API Reference",
+ "title":"Status Codes",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_8888.html",
+ "product_code":"kms",
+ "code":"44",
+ "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":"Error Code,Appendix,API Reference",
+ "title":"Error Code",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0009.html",
+ "product_code":"kms",
+ "code":"45",
+ "des":"A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:Log in to the management console.Click the username",
+ "doc_type":"api",
+ "kw":"Obtaining a Project ID,Appendix,API Reference",
+ "title":"Obtaining a Project ID",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0305.html",
+ "product_code":"kms",
+ "code":"46",
+ "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":"API Permissions",
+ "title":"API Permissions",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0306.html",
+ "product_code":"kms",
+ "code":"47",
+ "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":"Encryption Key Management,API Permissions,API Reference",
+ "title":"Encryption Key Management",
+ "githuburl":""
+ },
+ {
+ "uri":"kms_02_0304.html",
+ "product_code":"kms",
+ "code":"48",
+ "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",
+ "title":"Change History",
+ "githuburl":""
+ }
+]
\ No newline at end of file
diff --git a/docs/kms/api-ref/CLASS.TXT.json b/docs/kms/api-ref/CLASS.TXT.json
new file mode 100644
index 000000000..34f31c1f9
--- /dev/null
+++ b/docs/kms/api-ref/CLASS.TXT.json
@@ -0,0 +1,434 @@
+[
+ {
+ "desc":"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 ",
+ "product_code":"kms",
+ "title":"API Usage Guidelines",
+ "uri":"en-us_topic_00384375969.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"1"
+ },
+ {
+ "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":"kms",
+ "title":"APIs",
+ "uri":"kms_02_0010.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"2"
+ },
+ {
+ "desc":"This API is used to create customer master keys (CMKs) used to encrypt data encryption keys (DEKs).Default Master Keys are created by services integrated with KMS. Names ",
+ "product_code":"kms",
+ "title":"Creating a CMK",
+ "uri":"kms_02_0012.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"3"
+ },
+ {
+ "desc":"This API allows you to enable a CMK. Only an enabled CMK can be used.Only a disabled CMK can be enabled.URI formatPOST /v1.0/{project_id}/kms/enable-keyPOST /v1.0/{projec",
+ "product_code":"kms",
+ "title":"Enabling a CMK",
+ "uri":"kms_02_0013.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"4"
+ },
+ {
+ "desc":"This API allows you to disable a CMK. A disabled CMK cannot be used.Only an enabled CMK can be disabled.URI formatPOST /v1.0/{project_id}/kms/disable-keyPOST /v1.0/{proje",
+ "product_code":"kms",
+ "title":"Disabling a CMK",
+ "uri":"kms_02_0014.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"5"
+ },
+ {
+ "desc":"This API enables you to schedule the deletion of a CMK. A CMK can be scheduled to be deleted after 7 to 1096 days.URI formatPOST /v1.0/{project_id}/kms/schedule-key-delet",
+ "product_code":"kms",
+ "title":"Scheduling the Deletion of a CMK",
+ "uri":"kms_02_0015.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"6"
+ },
+ {
+ "desc":"This API enables you to cancel the scheduled deletion of a CMK.You can cancel the scheduled deletion for a CMK only when the CMK's status is Scheduled deletion.URI format",
+ "product_code":"kms",
+ "title":"Canceling the Scheduled Deletion of a CMK",
+ "uri":"kms_02_0016.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"7"
+ },
+ {
+ "desc":"This API allows you to query the list of all CMKs.URI formatPOST /v1.0/{project_id}/kms/list-keysPOST /v1.0/{project_id}/kms/list-keysParameter descriptionParametersParam",
+ "product_code":"kms",
+ "title":"Querying the List of CMKs",
+ "uri":"kms_02_0017.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"8"
+ },
+ {
+ "desc":"This API allows you to query the details about a CMK.By default, the performance threshold for querying CMK details is 1000 TPS per customer. To apply for higher performa",
+ "product_code":"kms",
+ "title":"Querying the Information About a CMK",
+ "uri":"kms_02_0018.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"9"
+ },
+ {
+ "desc":"This API generates a 512-bit random number.URI formatPOST /v1.0/{project_id}/kms/gen-randomPOST /v1.0/{project_id}/kms/gen-randomParameter descriptionParameter descriptio",
+ "product_code":"kms",
+ "title":"Creating a Random Number",
+ "uri":"kms_02_0019.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"10"
+ },
+ {
+ "desc":"This API allows you to create a DEK. A returned result includes the plaintext and the ciphertext of a DEK.By default, the performance threshold for creating DEKs is 1000 ",
+ "product_code":"kms",
+ "title":"Creating a DEK",
+ "uri":"kms_02_0020.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"11"
+ },
+ {
+ "desc":"This API allows you to create a plaintext-free DEK, that is, the returned result of this API includes only the ciphertext of the DEK.By default, the performance threshold",
+ "product_code":"kms",
+ "title":"Creating a Plaintext-Free DEK",
+ "uri":"kms_02_0021.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"12"
+ },
+ {
+ "desc":"This API enables you to encrypt a DEK using a specified CMK.By default, the performance threshold for encrypting DEKs is 1000 TPS per customer. To apply for higher perfor",
+ "product_code":"kms",
+ "title":"Encrypting a DEK",
+ "uri":"kms_02_0022.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"13"
+ },
+ {
+ "desc":"This API enables you to decrypt a DEK using a specified CMK.Data encryption results are used for decryption.By default, the performance threshold for decrypting DEKs is 1",
+ "product_code":"kms",
+ "title":"Decrypting a DEK",
+ "uri":"kms_02_0023.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"14"
+ },
+ {
+ "desc":"This API is used to query the number of instances, that is, the number of CMKs created.Default Master Keys are automatically created by services and are not included in t",
+ "product_code":"kms",
+ "title":"Querying the Number of Instances",
+ "uri":"kms_02_0024.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"15"
+ },
+ {
+ "desc":"This API is used to query the quota of a user, that is, the allocated total number of CMKs that can be created by a user and the number of CMKs that has been created by t",
+ "product_code":"kms",
+ "title":"Querying the Quota of a User",
+ "uri":"kms_02_0025.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"16"
+ },
+ {
+ "desc":"This API enables you to change the alias of a CMK.A Default Master Key (the alias suffix of which is /default) does not allow alias changes.A CMK in Scheduled deletion st",
+ "product_code":"kms",
+ "title":"Changing the Alias of a CMK",
+ "uri":"kms_02_0026.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"17"
+ },
+ {
+ "desc":"This API enables you to change the description of a CMK.A Default Master Key (the alias suffix of which is /default) does not allow alias changes.A CMK in Scheduled delet",
+ "product_code":"kms",
+ "title":"Changing the Description of a CMK",
+ "uri":"kms_02_0027.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"18"
+ },
+ {
+ "desc":"This API enables you to create a grant to grant permissions on a CMK to a user so that the user can perform operations on the CMK.A Default Master Key (the alias suffix o",
+ "product_code":"kms",
+ "title":"Creating a Grant",
+ "uri":"kms_02_0028.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"19"
+ },
+ {
+ "desc":"This API allows you to revoke a grant.Only the user who created the CMK can revoke a grant.URI formatPOST /v1.0/{project_id}/kms/revoke-grantPOST /v1.0/{project_id}/kms/r",
+ "product_code":"kms",
+ "title":"Revoking a Grant",
+ "uri":"kms_02_0029.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"20"
+ },
+ {
+ "desc":"This API enables users to retire a grant.For example, user A grants operation permissions on CMK A/key to user B and authorizes user C to retire the grant. By doing this,",
+ "product_code":"kms",
+ "title":"Retiring a Grant",
+ "uri":"kms_02_0030.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"21"
+ },
+ {
+ "desc":"This API enables you to query grants on a CMK.URI formatPOST /v1.0/{project_id}/kms/list-grantsPOST /v1.0/{project_id}/kms/list-grantsParameter descriptionParameter descr",
+ "product_code":"kms",
+ "title":"Querying Grants on a CMK",
+ "uri":"kms_02_0031.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"22"
+ },
+ {
+ "desc":"This API enables you to query grants that can be retired.URI formatPOST /v1.0/{project_id}/kms/list-retirable-grantsPOST /v1.0/{project_id}/kms/list-retirable-grantsParam",
+ "product_code":"kms",
+ "title":"Querying Grants That Can Be Retired",
+ "uri":"kms_02_0032.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"23"
+ },
+ {
+ "desc":"This API enables you to obtain necessary parameters to import a CMK, including a CMK import token and a CMK encryption public key.The returned public key type is RSA_2048",
+ "product_code":"kms",
+ "title":"Obtaining CMK Import Parameters",
+ "uri":"kms_02_0035.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"24"
+ },
+ {
+ "desc":"This API allows you to import CMK material.URI formatPOST /v1.0/{project_id}/kms/import-key-materialPOST /v1.0/{project_id}/kms/import-key-materialParameter descriptionPa",
+ "product_code":"kms",
+ "title":"Importing CMK Material",
+ "uri":"kms_02_0036.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"25"
+ },
+ {
+ "desc":"This API allows you to delete CMK material.URI formatPOST /v1.0/{project_id}/kms/delete-imported-key-materialPOST /v1.0/{project_id}/kms/delete-imported-key-materialParam",
+ "product_code":"kms",
+ "title":"Deleting CMK Material",
+ "uri":"kms_02_0037.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"26"
+ },
+ {
+ "desc":"This API allows you to enable rotation for a CMK.The default rotation interval is 365 days.CMKs created using imported key materials and Default Master Keys do not suppor",
+ "product_code":"kms",
+ "title":"Enabling Rotation for a CMK",
+ "uri":"kms_02_0038.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"27"
+ },
+ {
+ "desc":"This API enables you to change the rotation interval for a CMK.URI formatPOST /v1.0/{project_id}/kms/update-key-rotation-intervalPOST /v1.0/{project_id}/kms/update-key-ro",
+ "product_code":"kms",
+ "title":"Changing the Rotation Interval for a CMK",
+ "uri":"kms_02_0039.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"28"
+ },
+ {
+ "desc":"This API allows you to disable rotation for a CMK.URI formatPOST /v1.0/{project_id}/kms/disable-key-rotationPOST /v1.0/{project_id}/kms/disable-key-rotationParameter desc",
+ "product_code":"kms",
+ "title":"Disabling Rotation for a CMK",
+ "uri":"kms_02_0040.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"29"
+ },
+ {
+ "desc":"This API enables you to query the rotation status of a CMK.URI formatPOST /v1.0/{project_id}/kms/get-key-rotation-statusPOST /v1.0/{project_id}/kms/get-key-rotation-statu",
+ "product_code":"kms",
+ "title":"Querying the Rotation Status of a CMK",
+ "uri":"kms_02_0041.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"30"
+ },
+ {
+ "desc":"This API allows you to query CMK instances.You can use the tag filtering function to query the detailed information about a specified CMK.URI formatPOST /v1.0/{project_id",
+ "product_code":"kms",
+ "title":"Querying CMK Instances",
+ "uri":"kms_02_0042.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"31"
+ },
+ {
+ "desc":"This API allows you to query tags of a specified CMK.TMS may use this API to query all tags of a specified CMK.URI formatGET /v1.0/{project_id}/kms/{key_id}/tagsGET /v1.0",
+ "product_code":"kms",
+ "title":"Querying CMK Tags",
+ "uri":"kms_02_0043.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"32"
+ },
+ {
+ "desc":"This API enables you to query all tag sets of a specified project.URI formatGET /v1.0/{project_id}/kms/tagsGET /v1.0/{project_id}/kms/tagsParameter descriptionParameter d",
+ "product_code":"kms",
+ "title":"Querying Project Tags",
+ "uri":"kms_02_0044.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"33"
+ },
+ {
+ "desc":"This API enables you to add or delete CMK tags in batches.URI formatPOST /v1.0/{project_id}/kms/{key_id}/tags/actionPOST /v1.0/{project_id}/kms/{key_id}/tags/actionParame",
+ "product_code":"kms",
+ "title":"Adding or Deleting CMK Tags in Batches",
+ "uri":"kms_02_0045.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"34"
+ },
+ {
+ "desc":"This API allows you to add a CMK tag.URI formatPOST /v1.0/{project_id}/kms/{key_id}/tagsPOST /v1.0/{project_id}/kms/{key_id}/tagsParameter descriptionParameter descriptio",
+ "product_code":"kms",
+ "title":"Adding a CMK Tag",
+ "uri":"kms_02_0046.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"35"
+ },
+ {
+ "desc":"This API enables you to delete a CMK tag.URI formatDELETE /v1.0/{project_id}/kms/{key_id}/tags/{key}DELETE /v1.0/{project_id}/kms/{key_id}/tags/{key}Parameter description",
+ "product_code":"kms",
+ "title":"Deleting a CMK Tag",
+ "uri":"kms_02_0047.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"36"
+ },
+ {
+ "desc":"This API is used to query the API versions.URI formatGET /GET /Parameter descriptionNoneNoneNoneThe following describes how to query the version information.Example reque",
+ "product_code":"kms",
+ "title":"Querying All API Versions",
+ "uri":"kms_02_0048.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"37"
+ },
+ {
+ "desc":"This API is used to query the version of an API.URI formatGET /{version_id}GET /{version_id}Parameter descriptionParameter descriptionParameterMandatoryTypeDescriptionver",
+ "product_code":"kms",
+ "title":"Querying a Specified API Version",
+ "uri":"kms_02_0049.html",
+ "doc_type":"api",
+ "p_code":"2",
+ "code":"38"
+ },
+ {
+ "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":"kms",
+ "title":"Permissions Policies and Supported Actions",
+ "uri":"dew_02_0307.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"39"
+ },
+ {
+ "desc":"This chapter describes fine-grained permissions management for your KMS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul",
+ "product_code":"kms",
+ "title":"Introduction",
+ "uri":"dew_02_0308.html",
+ "doc_type":"api",
+ "p_code":"39",
+ "code":"40"
+ },
+ {
+ "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":"kms",
+ "title":"Encryption Key Management",
+ "uri":"dew_02_0309.html",
+ "doc_type":"api",
+ "p_code":"39",
+ "code":"41"
+ },
+ {
+ "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":"kms",
+ "title":"Appendix",
+ "uri":"kms_02_0300.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"42"
+ },
+ {
+ "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":"kms",
+ "title":"Status Codes",
+ "uri":"kms_02_0301.html",
+ "doc_type":"api",
+ "p_code":"42",
+ "code":"43"
+ },
+ {
+ "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":"kms",
+ "title":"Error Code",
+ "uri":"kms_02_8888.html",
+ "doc_type":"api",
+ "p_code":"42",
+ "code":"44"
+ },
+ {
+ "desc":"A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:Log in to the management console.Click the username",
+ "product_code":"kms",
+ "title":"Obtaining a Project ID",
+ "uri":"kms_02_0009.html",
+ "doc_type":"api",
+ "p_code":"42",
+ "code":"45"
+ },
+ {
+ "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":"kms",
+ "title":"API Permissions",
+ "uri":"kms_02_0305.html",
+ "doc_type":"api",
+ "p_code":"42",
+ "code":"46"
+ },
+ {
+ "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":"kms",
+ "title":"Encryption Key Management",
+ "uri":"kms_02_0306.html",
+ "doc_type":"api",
+ "p_code":"46",
+ "code":"47"
+ },
+ {
+ "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":"kms",
+ "title":"Change History",
+ "uri":"kms_02_0304.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"48"
+ }
+]
\ No newline at end of file
diff --git a/docs/kms/api-ref/PARAMETERS.txt b/docs/kms/api-ref/PARAMETERS.txt
new file mode 100644
index 000000000..6da8d5f07
--- /dev/null
+++ b/docs/kms/api-ref/PARAMETERS.txt
@@ -0,0 +1,3 @@
+version=""
+language="en-us"
+type=""
\ No newline at end of file
diff --git a/docs/kms/api-ref/dew_02_0307.html b/docs/kms/api-ref/dew_02_0307.html
new file mode 100644
index 000000000..94f0572b0
--- /dev/null
+++ b/docs/kms/api-ref/dew_02_0307.html
@@ -0,0 +1,13 @@
+
+
+
This chapter describes fine-grained permissions management for your KMS. If your account does not need individual IAM users, then you may skip over this chapter.
+
By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
+
You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
+
Policy-based authorization is useful if you want to allow or deny the access to an API.
+
+
An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. 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.
+
Supported Actions
You can use system-defined policies provided in IAM, or create custom policies to supplement the system-defined policies, implementing refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
+
Permission: A statement in a policy that allows or denies certain operations.
APIs: REST APIs that can be called in a custom policy.
Actions: Added to a custom policy to control permissions for specific operations.
Dependent actions: When assigning an action to users, you also need to assign dependent permissions for that action to take effect.
IAM projects or enterprise project: Scope of users a permission is granted to. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect in IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Project.
√: supported; x: not supported
+
+
+
KMS supports the following actions that can be defined in custom policies:
+
Manage keys, such as creating keys and querying keys.
+
diff --git a/docs/kms/api-ref/en-us_image_0218728478.jpg b/docs/kms/api-ref/en-us_image_0218728478.jpg
new file mode 100644
index 000000000..b0e263d9b
Binary files /dev/null and b/docs/kms/api-ref/en-us_image_0218728478.jpg differ
diff --git a/docs/kms/api-ref/en-us_topic_00384375969.html b/docs/kms/api-ref/en-us_topic_00384375969.html
new file mode 100644
index 000000000..3e778c8fb
--- /dev/null
+++ b/docs/kms/api-ref/en-us_topic_00384375969.html
@@ -0,0 +1,8 @@
+
+
+
API Usage Guidelines
+
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.
This API is used to create customer master keys (CMKs) used to encrypt data encryption keys (DEKs).
+
Default Master Keys are created by services integrated with KMS. Names of Default Master Keys end with /default. Therefore, in naming your CMKs, do not choose those ending with /default.
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/create-key
+
Parameter description
+
Table 1 Parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_alias
+
+
Yes
+
+
String
+
+
Alias of a non-default master key (The alias's length ranges from 1 to 255 characters and matches the regular expression ^[a-zA-Z0-9:/_-]{1,255}$. In addition, it must be different from the alias of a Default Master Key created by the system.)
+
+
+
key_description
+
+
No
+
+
String
+
+
CMK description (The value ranges from 0 to 255 characters.)
+
+
+
origin
+
+
No
+
+
String
+
+
Origin of a CMK. The default value is kms. The following values are enumerated:
kms indicates that the CMK material is generated by KMS.
external indicates that the CMK material is imported.
This API allows you to query the list of all CMKs.
+
+
URI
URI format
POST /v1.0/{project_id}/kms/list-keys
+
Parameter description
+
Table 1 Parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
limit
+
+
No
+
+
String
+
+
This parameter specifies the number of entries returned. If the specified number is smaller than the actual number of existing entries, true will be returned for the response parameter truncated, indicating that the query results will be displayed in separate pages. The value is within the range of the maximum number of CMKs, for example, 100.
+
+
+
marker
+
+
No
+
+
String
+
+
This parameter marks the starting location in a pagination query. If the truncated value is true, you can send consecutive requests to obtain more record entries. The marker value must be set to the next_marker value in the response, for example, 10.
+
+
+
key_state
+
+
No
+
+
String
+
+
State of a CMK that matches the regular expression ^[1-5]{1}$. The following values are enumerated:
1 indicates that the CMK is waiting to be activated.
2 indicates that the CMK is enabled.
3 indicates that the CMK is disabled.
4 indicates that the CMK is scheduled for deletion.
5 indicates that the CMK is waiting to be imported.
This parameter indicates the marker value required for obtaining the next page of query results. If the truncated value is false, the next_marker parameter is left blank.
+
+
+
total
+
+
Yes
+
+
Integer
+
+
Total number of keys.
+
+
+
truncated
+
+
Yes
+
+
String
+
+
This parameter indicates whether there are more results displayed in another page.
If the value is true, there are more results.
If the value is false, the current page is the last page.
+
+
+
+
+
+
+
+
Examples
The following shows an example when limit is set to 2 and marker is set to 1.
Number of bits of a random number. The value is 512.
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
+
Table 3 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
random_data
+
+
Yes
+
+
String
+
+
Random numbers are expressed in hexadecimal format. Two characters indicate one byte. Length of a random number must be consistent with the random_data_length value entered by a user.
+
+
+
+
+
+
+
Examples
The following example describes how to create a random number with the length of 512 bits.
This API allows you to create a DEK. A returned result includes the plaintext and the ciphertext of a DEK.
+
By default, the performance threshold for creating DEKs is 1000 TPS per customer. To apply for higher performance, submit a service ticket.
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/create-datakey
+
Parameter description
+
Table 1 Parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
encryption_context
+
+
No
+
+
Object
+
+
Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.
+
If this parameter is specified during encryption, it is also required for decryption.
+
Example: {"Key1":"Value1","Key2":"Value2"}
+
+
+
datakey_length
+
+
Yes
+
+
String
+
+
Number of bits of a key. The value is 512.
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
+
Table 3 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
CMK ID
+
+
+
plain_text
+
+
Yes
+
+
String
+
+
The plaintext of a DEK is expressed in hexadecimal format, and two characters indicate one byte.
+
+
+
cipher_text
+
+
Yes
+
+
String
+
+
The ciphertext of a DEK is expressed in hexadecimal format, and two characters indicate one byte.
+
+
+
+
+
+
+
Examples
The following example describes how to create a DEK whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f and length is 512 bits.
This API allows you to create a plaintext-free DEK, that is, the returned result of this API includes only the ciphertext of the DEK.
+
By default, the performance threshold for creating plaintext-free DEKs is 1000 TPS per customer. To apply for higher performance, submit a service ticket.
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/create-datakey-without-plaintext
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
encryption_context
+
+
No
+
+
Object
+
+
Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.
+
If this parameter is specified during encryption, it is also required for decryption.
+
Example: {"Key1":"Value1","Key2":"Value2"}
+
+
+
datakey_length
+
+
Yes
+
+
String
+
+
Number of bits of a key. The value is 512.
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
+
Table 3 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
CMK ID
+
+
+
cipher_text
+
+
Yes
+
+
String
+
+
The ciphertext of a DEK is expressed in hexadecimal format, and two characters indicate one byte.
+
+
+
+
+
+
+
Examples
The following example describes how to create a plaintext free DEK whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.
This API enables you to encrypt a DEK using a specified CMK.
+
By default, the performance threshold for encrypting DEKs is 1000 TPS per customer. To apply for higher performance, submit a service ticket.
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/encrypt-datakey
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
encryption_context
+
+
No
+
+
Object
+
+
Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.
+
If this parameter is specified during encryption, it is also required for decryption.
+
Example: {"Key1":"Value1","Key2":"Value2"}
+
+
+
plain_text
+
+
Yes
+
+
String
+
+
Hexadecimal character string concatenated from plaintext of a DEK and the plaintext digest (32-byte character string generated using SHA256)
Number of bytes of a DEK in plaintext. The value is 64.
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
+
Table 3 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
CMK ID
+
+
+
cipher_text
+
+
Yes
+
+
String
+
+
The ciphertext of a DEK is expressed in hexadecimal format, and two characters indicate one byte.
+
+
+
datakey_length
+
+
Yes
+
+
String
+
+
Number of bytes in the length of a DEK
+
+
+
+
+
+
+
Examples
In the following example, the 512-bit plaintext DEK (7549d9aea901767bf3c0b3e14b10722eaf6f59053bbd82045d04e075e809a0fe6ccab48f8e5efe74e4b18ff0512525e527b10331100f357bf42125d8d5ced94f) generated from the customer master key whose key ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f can be obtained through the API in Creating a DEK.
+
The digest of the plaintext DEK is fbc8ac72b0785ca7fe33eb6776ce3990b11e32b299d9c0a9ee0305fb9540f797. The method for calculating the digest is as follows:
The value of plain_text (a hexadecimal character string concatenated from plaintext of the DEK and the plaintext digest) is 7549d9aea901767bf3c0b3e14b10722eaf6f59053bbd82045d04e075e809a0fe6ccab48f8e5efe74e4b18ff0512525e527b10331100f357bf42125d8d5ced94f fbc8ac72b0785ca7fe33eb6776ce3990b11e32b299d9c0a9ee0305fb9540f797.
This API enables you to decrypt a DEK using a specified CMK.
+
Data encryption results are used for decryption.
+
By default, the performance threshold for decrypting DEKs is 1000 TPS per customer. To apply for higher performance, submit a service ticket.
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/decrypt-datakey
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
encryption_context
+
+
No
+
+
Object
+
+
Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.
+
If this parameter is specified during encryption, it is also required for decryption.
+
Example: {"Key1":"Value1","Key2":"Value2"}
+
+
+
cipher_text
+
+
Yes
+
+
String
+
+
This parameter indicates the hexadecimal character string of the DEK ciphertext and the metadata. The value is the cipher_text value in the encryption result of a DEK.
+
+
+
datakey_cipher_length
+
+
Yes
+
+
String
+
+
Number of bytes of a key. The value is 64.
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
+
Table 3 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
data_key
+
+
Yes
+
+
String
+
+
Hexadecimal character string of the plaintext of a DEK
+
+
+
datakey_length
+
+
Yes
+
+
String
+
+
Number of bytes in the length of the plaintext of a DEK
+
+
+
datakey_dgst
+
+
Yes
+
+
String
+
+
Hexadecimal character string corresponding to the SHA-256 hash value of the plaintext of a DEK
+
+
+
+
+
+
+
Examples
The following is an example about how to use a CMK (ID: 0d0466b0-e727-4d9c-b35d-f84bb474a37f) to decrypt a DEK (ciphertext: 020098005273E14E6E8E95F5463BECDC27E80AF820B9FC086CB47861899149F67CF07DAFF2810B7D27BDF19AB7632488E0926A48DB2FC85BEA905119411B46244C5E6B8036C60A0B0B4842FFE6994518E89C19B1C1D688D9043BCD6053EA7BA0652642CE59F2543C80669139F4F71ABB9BD9A24330643034363662302D653732372D346439632D623335642D66383462623437346133376600000000D34457984F9730D57F228C210FD22CA6017913964B21D4ECE45D81092BB9112E; length: 64 bits).
This API is used to query the quota of a user, that is, the allocated total number of CMKs that can be created by a user and the number of CMKs that has been created by the user.
This API enables you to change the alias of a CMK.
+
A Default Master Key (the alias suffix of which is /default) does not allow alias changes.
A CMK in Scheduled deletion status does not allow alias changes.
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/update-key-alias
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
key_alias
+
+
Yes
+
+
String
+
+
Alias of a CMK whose length is 1 to 255 characters and which matches the regular expression ^[a-zA-Z0-9:/_-]{1,255}$. Suffix of the alias cannot be /default.
Name of a grant which can be 1 to 255 characters in length and matches the regular expression ^[a-zA-Z0-9:/_-]{1,255}$
+
+
+
retiring_principal
+
+
No
+
+
String
+
+
Indicates the ID of the retiring user. The value is between 1 to 64 bytes and meets the regular expression "^[a-zA-Z0-9]{1,64}$".
+
Example: 0d0466b00d0466b00d0466b00d0466b0
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
+
Table 3 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
grant_id
+
+
Yes
+
+
String
+
+
64-byte ID of a grant
+
+
+
+
+
+
+
Examples
The following example shows how to grant the describe-key, create-datakey, and encrypt-datakey permissions of CMK (ID: bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e) to the user whose ID is 13gg44z4g2sglzk0egw0u726zoyzvrs8. The authorization name is my_grant, and the user (ID: 13gg44z4g2sglzk0egw0u726zoyzvrs8) can retire a grant.
The following example describes how to revoke a grant whose grant ID is 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d and the CMK ID is bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e.
For example, user A grants operation permissions on CMK A/key to user B and authorizes user C to retire the grant. By doing this, users A, B, and C all can cancel the permissions. After the canceling, user B does not have permissions on CMK A/key anymore.
+
The following are allowed to call this API:
+
The user who granted the permissions
The user indicated by parameter retiring_principal
The user indicated by parameter grantee_principal when retire-grant has been selected
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/retire-grant
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
grant_id
+
+
Yes
+
+
String
+
+
64-byte ID of a grant that meets the regular expression ^[A-Fa-f0-9]{64}$
The following example describes how to retire a grant whose grant ID is 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d and the CMK ID is bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e.
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
limit
+
+
No
+
+
String
+
+
This parameter specifies the number of entries returned. If the specified number is smaller than the actual number of existing entries, true will be returned for the response parameter truncated, indicating that the query results will be displayed in separate pages.
+
The value is within the range of the maximum number of grants, for example, 100.
+
+
+
marker
+
+
No
+
+
String
+
+
This parameter marks the starting location in a pagination query.
+
If the truncated value is true, you can send consecutive requests to obtain more record entries. The marker value must be set to the next_marker value in the response, for example, 10.
Indicates the ID of the authorized user. The value is between 1 to 64 bytes and meets the regular expression "^[a-zA-Z0-9]{1,64}$".
+
Example: 0d0466b00d0466b00d0466b00d0466b0
+
+
+
operations
+
+
Yes
+
+
Array of strings
+
+
Permissions that can be granted. Values: create-datakey, create-datakey-without-plaintext, encrypt-datakey, decrypt-datakey, describe-key, create-grant, retire-grant
+
create-grant cannot be the only value.
+
+
+
issuing_principal
+
+
Yes
+
+
String
+
+
Indicates the ID of the user who created the grant. The value is between 1 to 64 bytes and meets the regular expression "^[a-zA-Z0-9]{1,64}$".
+
Example: 0d0466b00d0466b00d0466b00d0466b0
+
+
+
creation_date
+
+
Yes
+
+
String
+
+
Creation time. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.
+
Example: 1497341531000
+
+
+
name
+
+
No
+
+
String
+
+
Name of a grant which can be 1 to 255 characters in length and matches the regular expression ^[a-zA-Z0-9:/_-]{1,255}$
+
+
+
retiring_principal
+
+
No
+
+
String
+
+
Indicates the ID of the retiring user. The value is between 1 to 64 bytes and meets the regular expression "^[a-zA-Z0-9]{1,64}$".
+
Example: 0d0466b00d0466b00d0466b00d0466b0
+
+
+
+
+
+
+
Examples
The following example describes how to query the grant list of a CMK whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.
This API enables you to query grants that can be retired.
+
+
URI
URI format
POST /v1.0/{project_id}/kms/list-retirable-grants
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
limit
+
+
No
+
+
String
+
+
This parameter specifies the number of entries returned. If the specified number is smaller than the actual number of existing entries, true will be returned for the response parameter truncated, indicating that the query results will be displayed in separate pages.
+
The value is within the range of the maximum number of grants, for example, 100.
+
+
+
marker
+
+
No
+
+
String
+
+
This parameter marks the starting location in a pagination query.
+
If the truncated value is true, you can send consecutive requests to obtain more record entries. The marker value must be set to the next_marker value in the response, for example, 10.
This API enables you to obtain necessary parameters to import a CMK, including a CMK import token and a CMK encryption public key.
+
The returned public key type is RSA_2048 by default.
+
+
+
URI
URI format
POST /v1.0/{project_id}/kms/get-parameters-for-import
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
wrapping_algorithm
+
+
Yes
+
+
String
+
+
Encryption algorithm for CMK material. The following values are enumerated:
RSAES_PKCS1_V1_5
RSAES_OAEP_SHA_1
RSAES_OAEP_SHA_256
+
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
+
Table 3 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key_id
+
+
Yes
+
+
String
+
+
ID of a CMK in Base64 format
+
+
+
import_token
+
+
Yes
+
+
String
+
+
CMK import token
+
+
+
expiration_time
+
+
Yes
+
+
String
+
+
Expiration time of the import parameter. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.
+
+
+
public_key
+
+
Yes
+
+
String
+
+
Public key (in Base64 format) used to encrypt CMK material
+
+
+
+
+
+
+
Examples
The following example describes how to obtain the imported parameter of a CMK (ID: bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e; encryption algorithm: RSAES_OAEP_SHA_1).
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
import_token
+
+
Yes
+
+
String
+
+
CMK import token in Base64 format that matches the regular expression ^[0-9a-zA-Z+/=]{200,6144}$
+
+
+
encrypted_key_material
+
+
Yes
+
+
String
+
+
Encrypted CMK material in Base64 format that matches the regular expression ^[0-9a-zA-Z+/=]{344,360}$
+
+
+
expiration_time
+
+
No
+
+
String
+
+
Expiration time of the key material. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970. KMS will delete the key material within 24 hours after the expiration.
+
Example: 1550291833
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
None
+
+
Examples
The following example describes how to import the CMK material and the import-token to the CMK whose ID is bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e, and set the expiration time of the CMK material to 1521578672.
You can use the tag filtering function to query the detailed information about a specified CMK.
+
+
URI
URI format
POST /v1.0/{project_id}/kms/resource_instances/action
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
tags
+
+
No
+
+
Array of objects
+
+
list of tags, including tag keys and tag values.
key indicates the tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of key contains a maximum of 36 characters.
value indicates the tag value. Each tag value can contain a maximum of 43 characters. The relationship between values is AND.
+
+
+
+
limit
+
+
No
+
+
String
+
+
Number of queried records. If action is set to count, this parameter does not need to be set. If action is set to filter, the default value is 10.
+
The value ranges from 1 to 1000.
+
+
+
offset
+
+
No
+
+
String
+
+
Index location. The query starts from the next piece of data indexed by this parameter. When data on the first page is queried, the value of this parameter queried on previous page is contained. If action is count, this parameter does not need to be set. If action is set to filter, the default value is 0.
+
The value must be a numeral and cannot be a negative number.
+
+
+
action
+
+
Yes
+
+
String
+
+
Operation ID, which can be set to filter or count.
+
filter: indicates filtering.
count: indicates the number of queried records.
+
+
+
matches
+
+
No
+
+
Array of objects
+
+
Search field.
+
key indicates the field to be matched, for example, resource_name.
value indicates the value to be matched, which contains a maximum of 255 characters and cannot be empty.
This API allows you to query tags of a specified CMK.
+
+
TMS may use this API to query all tags of a specified CMK.
+
URI
URI format
GET /v1.0/{project_id}/kms/{key_id}/tags
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
+
+
+
+
+
Requests
None
+
+
Responses
+
Table 2 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
tags
+
+
Yes
+
+
Array of objects
+
+
list of tags, including tag keys and tag values.
key indicates the tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of key contains a maximum of 36 characters.
value indicates the tag value. Each tag value can contain a maximum of 43 characters. The relationship between values is AND.
+
+
+
+
existTagNum
+
+
Yes
+
+
Integer
+
+
Number of key tags.
+
+
+
+
+
+
+
Examples
The following example describes how to query CMK tags.
This API enables you to query all tag sets of a specified project.
+
+
URI
URI format
GET /v1.0/{project_id}/kms/tags
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
+
+
+
+
+
Requests
None
+
+
Responses
+
Table 2 Response parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
tags
+
+
Yes
+
+
Array of objects
+
+
list of tags, including tag keys and tag values.
key indicates the tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of key contains a maximum of 36 characters.
value indicates the tag value. Each tag value can contain a maximum of 43 characters. The relationship between values is AND.
+
+
+
+
+
+
+
+
Examples
The following example describes how to query project tags.
This API enables you to add or delete CMK tags in batches.
+
+
URI
URI format
POST /v1.0/{project_id}/kms/{key_id}/tags/action
+
Parameter description
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
key_id
+
+
Yes
+
+
String
+
+
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
+
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
+
+
+
+
+
+
+
+
Requests
+
Table 2 Request parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
tags
+
+
Yes
+
+
Array of objects
+
+
list of tags, including tag keys and tag values.
key indicates the tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of key contains a maximum of 36 characters.
value indicates the tag value. Each tag value can contain a maximum of 43 characters. The relationship between values is AND.
+
+
+
+
action
+
+
Yes
+
+
String
+
+
Operation ID.
+
The value can be create or delete.
+
+
+
sequence
+
+
No
+
+
String
+
+
36-byte serial number of a request message
+
Example: 919c82d4-8046-4722-9094-35c3c6524cff
+
+
+
+
+
+
+
Responses
None
+
+
Examples
The following example describes how to add tags, the keys and values of which are key1, key, value1, and value3 respectively.
The value contains a maximum of 36 Unicode characters. The value of key cannot be empty, and cannot contain the following characters: ASCII (0-31) and *<>\=
+
+
+
value
+
+
Yes
+
+
String
+
+
Value.
+
Each value contains a maximum of 43 Unicode characters and can be an empty string. The value cannot contain the following characters: ASCII (0-31) and *<>\=
+
+
+
+
+
+
+
Responses
None
+
+
Examples
The following example describes how to add a tag, the key and value of which are DEV and DEV1 respectively.
If the APIs of this version support microversions, the supported maximum microversion is returned. If the microversion is not supported, empty character string is returned.
+
+
+
status
+
+
Yes
+
+
String
+
+
Version status. Valid values are as follows:
+
CURRENT: widely used version
SUPPORTED: earlier version which is still supported
DEPRECATED: deprecated version which may be deleted later
+
+
+
updated
+
+
Yes
+
+
String
+
+
Version release time, which must be UTC time. For example, the release time of v1 is 2014-06-28T12:20:21Z.
+
+
+
min_version
+
+
No
+
+
String
+
+
If the APIs of this version support microversions, the supported minimum microversion is returned. If the microversion is not supported, empty character string is returned.
+
+
+
+
+
+
+
Table 3 links field description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
href
+
+
Yes
+
+
String
+
+
API URL
+
+
+
rel
+
+
Yes
+
+
String
+
+
The default value is self.
+
+
+
+
+
+
+
Examples
The following describes how to query the version information.
If the APIs of this version support microversions, the supported maximum microversion is returned. If the microversion is not supported, empty character string is returned.
+
+
+
status
+
+
Yes
+
+
String
+
+
Version status. Valid values are as follows:
+
CURRENT: widely used version
SUPPORTED: earlier version which is still supported
DEPRECATED: deprecated version which may be deleted later
+
+
+
updated
+
+
Yes
+
+
String
+
+
Version release time, which must be UTC time. For example, the release time of v1.0 is 2014-06-28T12:20:21Z.
+
+
+
min_version
+
+
No
+
+
String
+
+
If the APIs of this version support microversions, the supported minimum microversion is returned. If the microversion is not supported, empty character string is returned.
+
+
+
+
+
+
+
Table 4 links field data structure description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
href
+
+
Yes
+
+
String
+
+
API URL
+
+
+
rel
+
+
Yes
+
+
String
+
+
The default value is self.
+
+
+
+
+
+
+
Examples
The following uses the v1.0 version as an example.
Optimized descriptions in sections "Permissions Policies and Supported Actions".
+
+
+
2021-10-20
+
+
This issue is the twelfth official release.
+
Added section "Permissions and Supported Actions".
Added description about default KMS performance thresholds in "CMK Management".
+
+
+
2021-09-22
+
+
This issue is the eleventh official release.
+
Modified the error code format in the "Error Codes" section.
+
+
+
2019-12-10
+
+
This is the tenth official release.
+
Added the section "Enabling Rotation for a CMK".
Added the section "Changing the Rotation Interval for a CMK".
Added the section "Disabling Rotation for a CMK".
Added the section "Querying the Rotation Status of a CMK".
+
+
+
2019-03-13
+
+
This is the ninth official release.
+
Added the section "API Permissions".
+
+
+
2018-09-30
+
+
This is the eighth official release.
+
Added the section "Querying All API Versions."
Added the section "Querying a Specified API Version."
+
+
+
2018-07-30
+
+
This is the seventh official release.
+
Modified the section "Error Codes": added error codes KMS.0417, KMS.0418, and their descriptions.
Modified the descriptions about status codes returned following each request. The normal status codes and exception status codes are described separately.
Modified section "Status Codes": added status code 204 and its description.
Modified the description of the resource_detail parameter in the section "Querying CMK Instances".
+
+
+
2018-03-30
+
+
This issue is the sixth official release.
+
Added the section "Obtaining CMK Import Parameters".
Added the section "Importing CMK Material".
Added the section "Deleting CMK Material".
Added the section "Querying CMK Instances".
Added the section "Querying CMK Tags".
Added the section "Querying Project Tags".
Added the section "Adding or Deleting CMK Tags in Batches".
Added the section "Adding a CMK Tag".
Added the section "Deleting a CMK Tag".
Optimized error codes and modified the section "Error Codes".
Added error codes KMS.0309, KMS.0310, and KMS.0401-KMS.0413 to the common error codes.
Added error codes and their description for importing CMK material.
Added error codes and their description for deleting CMK material.
+
+
+
+
2017-10-30
+
+
This is the fifth official release.
+
Added the section "Creating a Grant".
Added the section "Revoking a Grant".
Added the section "Retiring a Grant".
Added the section "Querying Grants on a CMK".
Added the section "Querying Grants That Can Be Retired".
Optimized request parameter description in the section "Creating a CMK".
Optimized request and response parameter description in the section "Querying the List of CMKs".
Optimized response parameter description in the section "Querying the Information About a CMK".
Optimized response parameter description in the section "Creating a Random Number".
Optimized response parameter description in the section "Querying the Quota of a User".
Optimized error codes and modified the section "Error Codes".
Added public error code KMS.0308 and its description.
Added error codes and their description for creating a grant.
Added error codes and their description for querying grants on a CMK.
Added error codes and their description for querying grants that can be retired.
Added error codes and their description for revoking a grant.
Added error codes and their description for retiring a grant.
+
+
+
+
2017-06-30
+
+
This is the fourth official release.
+
Added sections "Changing the Alias of a CMK" and "Changing the Description of a CMK".
Optimized the type of parameter keys in the section "Querying the List of CMKs".
Optimized response parameter tables in sections "Querying the Number of Instances" and "Querying Quotas".
Optimized error codes and modified the section "Error Code".
Added error codes and their description for changing the alias of a CMK.
Added error codes and their description for changing the description of a CMK.
+
+
+
+
2017-02-08
+
+
This is the third official release.
+
Added sections "Querying the Number of Instances" and "Querying Quotas".
+
+
+
2016-12-30
+
+
This is the second official release.
+
Optimized error codes and modified the section "Error Codes".
Added description about parameter encryption_context to the following sections:
+
diff --git a/docs/kms/api-ref/public_sys-resources/ExpandCollapse.js b/docs/kms/api-ref/public_sys-resources/ExpandCollapse.js
new file mode 100644
index 000000000..116ddaabf
--- /dev/null
+++ b/docs/kms/api-ref/public_sys-resources/ExpandCollapse.js
@@ -0,0 +1 @@
+var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}};
\ No newline at end of file
diff --git a/docs/kms/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/kms/api-ref/public_sys-resources/caution_3.0-en-us.png
new file mode 100644
index 000000000..60f607621
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/caution_3.0-en-us.png differ
diff --git a/docs/kms/api-ref/public_sys-resources/commonltr.css b/docs/kms/api-ref/public_sys-resources/commonltr.css
new file mode 100644
index 000000000..c5480b0ab
--- /dev/null
+++ b/docs/kms/api-ref/public_sys-resources/commonltr.css
@@ -0,0 +1 @@
+body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}
\ No newline at end of file
diff --git a/docs/kms/api-ref/public_sys-resources/commonltr_print.css b/docs/kms/api-ref/public_sys-resources/commonltr_print.css
new file mode 100644
index 000000000..a59823141
--- /dev/null
+++ b/docs/kms/api-ref/public_sys-resources/commonltr_print.css
@@ -0,0 +1 @@
+body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm}
\ No newline at end of file
diff --git a/docs/kms/api-ref/public_sys-resources/commonrtl.css b/docs/kms/api-ref/public_sys-resources/commonrtl.css
new file mode 100644
index 000000000..f261da752
--- /dev/null
+++ b/docs/kms/api-ref/public_sys-resources/commonrtl.css
@@ -0,0 +1,2 @@
+/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
+*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}
\ No newline at end of file
diff --git a/docs/kms/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/kms/api-ref/public_sys-resources/danger_3.0-en-us.png
new file mode 100644
index 000000000..47a9c7235
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/danger_3.0-en-us.png differ
diff --git a/docs/kms/api-ref/public_sys-resources/delta.gif b/docs/kms/api-ref/public_sys-resources/delta.gif
new file mode 100644
index 000000000..0d1b1f674
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/delta.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/deltaend.gif b/docs/kms/api-ref/public_sys-resources/deltaend.gif
new file mode 100644
index 000000000..cc7da0fc8
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/deltaend.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/kms/api-ref/public_sys-resources/icon-arrowdn.gif
new file mode 100644
index 000000000..84eec9be2
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-arrowdn.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/kms/api-ref/public_sys-resources/icon-arrowrt.gif
new file mode 100644
index 000000000..39583d168
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-arrowrt.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-caution.gif b/docs/kms/api-ref/public_sys-resources/icon-caution.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-caution.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-danger.gif b/docs/kms/api-ref/public_sys-resources/icon-danger.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-danger.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-huawei.gif b/docs/kms/api-ref/public_sys-resources/icon-huawei.gif
new file mode 100644
index 000000000..a31d60f89
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-huawei.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-note.gif b/docs/kms/api-ref/public_sys-resources/icon-note.gif
new file mode 100644
index 000000000..31be2b039
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-note.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-notice.gif b/docs/kms/api-ref/public_sys-resources/icon-notice.gif
new file mode 100644
index 000000000..409070650
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-notice.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-tip.gif b/docs/kms/api-ref/public_sys-resources/icon-tip.gif
new file mode 100644
index 000000000..c47bae05c
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-tip.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/icon-warning.gif b/docs/kms/api-ref/public_sys-resources/icon-warning.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/icon-warning.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/imageResize.js b/docs/kms/api-ref/public_sys-resources/imageResize.js
new file mode 100644
index 000000000..37309ce3b
--- /dev/null
+++ b/docs/kms/api-ref/public_sys-resources/imageResize.js
@@ -0,0 +1,18 @@
+/** IDP renames $ to $$$,jQueryHW2 */
+var $$$, jQueryHW2;
+jQueryHW2 = $$$ = $;
+
+function image_size(a) {
+ $$$(window).on('load', function () {
+ $$$(a).each(function () {
+ var e = $$$(this);
+ var f = e.width();
+ var d = e.height();
+ var b = f;
+ var c = d;
+ e.click(function () {
+ tb_show("", this.src, false)
+ })
+ })
+ })
+};
\ No newline at end of file
diff --git a/docs/kms/api-ref/public_sys-resources/imageclose.gif b/docs/kms/api-ref/public_sys-resources/imageclose.gif
new file mode 100644
index 000000000..3a3344af4
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/imageclose.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/imageclosehover.gif b/docs/kms/api-ref/public_sys-resources/imageclosehover.gif
new file mode 100644
index 000000000..8699d5e36
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/imageclosehover.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/imagemax.gif b/docs/kms/api-ref/public_sys-resources/imagemax.gif
new file mode 100644
index 000000000..99c07dc25
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/imagemax.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/imagemaxhover.gif b/docs/kms/api-ref/public_sys-resources/imagemaxhover.gif
new file mode 100644
index 000000000..d01d77d6e
Binary files /dev/null and b/docs/kms/api-ref/public_sys-resources/imagemaxhover.gif differ
diff --git a/docs/kms/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js b/docs/kms/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
new file mode 100644
index 000000000..88f4844bf
--- /dev/null
+++ b/docs/kms/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
@@ -0,0 +1,2 @@
+/*! jQuery Migrate v1.2.1 | (c) 2005, 2013 jQuery Foundation, Inc. and other contributors | jquery.org/license */
+jQueryHW2.migrateMute===void 0&&(jQueryHW2.migrateMute=!0),function(e,t,n){function r(n){}function a(t,a,i,o){if(Object.defineProperty)try{return Object.defineProperty(t,a,{configurable:!0,enumerable:!0,get:function(){return r(o),i},set:function(e){r(o),i=e}}),n}catch(s){}e._definePropertyBroken=!0,t[a]=i}var i={};e.migrateWarnings=[],!e.migrateMute,e.migrateTrace===n&&(e.migrateTrace=!0),e.migrateReset=function(){i={},e.migrateWarnings.length=0},"BackCompat"===document.compatMode&&r("jQueryHW2 is not compatible with Quirks Mode");var o=e("",{size:1}).attr("size")&&e.attrFn,s=e.attr,u=e.attrHooks.value&&e.attrHooks.value.get||function(){return null},c=e.attrHooks.value&&e.attrHooks.value.set||function(){return n},l=/^(?:input|button)$/i,d=/^[238]$/,p=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,f=/^(?:checked|selected)$/i;a(e,"attrFn",o||{},"jQueryHW2.attrFn is deprecated"),e.attr=function(t,a,i,u){var c=a.toLowerCase(),g=t&&t.nodeType;return u&&(4>s.length&&r("jQueryHW2.fn.attr( props, pass ) is deprecated"),t&&!d.test(g)&&(o?a in o:e.isFunction(e.fn[a])))?e(t)[a](i):("type"===a&&i!==n&&l.test(t.nodeName)&&t.parentNode&&r("Can't change the 'type' of an input or button in IE 6/7/8"),!e.attrHooks[c]&&p.test(c)&&(e.attrHooks[c]={get:function(t,r){var a,i=e.prop(t,r);return i===!0||"boolean"!=typeof i&&(a=t.getAttributeNode(r))&&a.nodeValue!==!1?r.toLowerCase():n},set:function(t,n,r){var a;return n===!1?e.removeAttr(t,r):(a=e.propFix[r]||r,a in t&&(t[a]=!0),t.setAttribute(r,r.toLowerCase())),r}},f.test(c)&&r("jQueryHW2.fn.attr('"+c+"') may use property instead of attribute")),s.call(e,t,a,i))},e.attrHooks.value={get:function(e,t){var n=(e.nodeName||"").toLowerCase();return"button"===n?u.apply(this,arguments):("input"!==n&&"option"!==n&&r("jQueryHW2.fn.attr('value') no longer gets properties"),t in e?e.value:null)},set:function(e,t){var a=(e.nodeName||"").toLowerCase();return"button"===a?c.apply(this,arguments):("input"!==a&&"option"!==a&&r("jQueryHW2.fn.attr('value', val) no longer sets properties"),e.value=t,n)}};var g,h,v=e.fn.init,m=e.parseJSON,y=/^([^<]*)(<[\w\W]+>)([^>]*)$/;e.fn.init=function(t,n,a){var i;return t&&"string"==typeof t&&!e.isPlainObject(n)&&(i=y.exec(e.trim(t)))&&i[0]&&("<"!==t.charAt(0)&&r("$(html) HTML strings must start with '<' character"),i[3]&&r("$(html) HTML text after last tag is ignored"),"#"===i[0].charAt(0)&&(r("HTML string cannot start with a '#' character"),e.error("JQMIGRATE: Invalid selector string (XSS)")),n&&n.context&&(n=n.context),e.parseHTML)?v.call(this,e.parseHTML(i[2],n,!0),n,a):v.apply(this,arguments)},e.fn.init.prototype=e.fn,e.parseJSON=function(e){return e||null===e?m.apply(this,arguments):(r("jQueryHW2.parseJSON requires a valid JSON string"),null)},e.uaMatch=function(e){e=e.toLowerCase();var t=/(chrome)[ \/]([\w.]+)/.exec(e)||/(webkit)[ \/]([\w.]+)/.exec(e)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(e)||/(msie) ([\w.]+)/.exec(e)||0>e.indexOf("compatible")&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(e)||[];return{browser:t[1]||"",version:t[2]||"0"}},e.browser||(g=e.uaMatch(navigator.userAgent),h={},g.browser&&(h[g.browser]=!0,h.version=g.version),h.chrome?h.webkit=!0:h.webkit&&(h.safari=!0),e.browser=h),a(e,"browser",e.browser,"jQueryHW2.browser is deprecated"),e.sub=function(){function t(e,n){return new t.fn.init(e,n)}e.extend(!0,t,this),t.superclass=this,t.fn=t.prototype=this(),t.fn.constructor=t,t.sub=this.sub,t.fn.init=function(r,a){return a&&a instanceof e&&!(a instanceof t)&&(a=t(a)),e.fn.init.call(this,r,a,n)},t.fn.init.prototype=t.fn;var n=t(document);return r("jQueryHW2.sub() is deprecated"),t},e.ajaxSetup({converters:{"text json":e.parseJSON}});var b=e.fn.data;e.fn.data=function(t){var a,i,o=this[0];return!o||"events"!==t||1!==arguments.length||(a=e.data(o,t),i=e._data(o,t),a!==n&&a!==i||i===n)?b.apply(this,arguments):(r("Use of jQueryHW2.fn.data('events') is deprecated"),i)};var j=/\/(java|ecma)script/i,w=e.fn.andSelf||e.fn.addBack;e.fn.andSelf=function(){return r("jQueryHW2.fn.andSelf() replaced by jQueryHW2.fn.addBack()"),w.apply(this,arguments)},e.clean||(e.clean=function(t,a,i,o){a=a||document,a=!a.nodeType&&a[0]||a,a=a.ownerDocument||a,r("jQueryHW2.clean() is deprecated");var s,u,c,l,d=[];if(e.merge(d,e.buildFragment(t,a).childNodes),i)for(c=function(e){return!e.type||j.test(e.type)?o?o.push(e.parentNode?e.parentNode.removeChild(e):e):i.appendChild(e):n},s=0;null!=(u=d[s]);s++)e.nodeName(u,"script")&&c(u)||(i.appendChild(u),u.getElementsByTagName!==n&&(l=e.grep(e.merge([],u.getElementsByTagName("script")),c),d.splice.apply(d,[s+1,0].concat(l)),s+=l.length));return d});var Q=e.event.add,x=e.event.remove,k=e.event.trigger,N=e.fn.toggle,T=e.fn.live,M=e.fn.die,S="ajaxStart|ajaxStop|ajaxSend|ajaxComplete|ajaxError|ajaxSuccess",C=RegExp("\\b(?:"+S+")\\b"),H=/(?:^|\s)hover(\.\S+|)\b/,A=function(t){return"string"!=typeof t||e.event.special.hover?t:(H.test(t)&&r("'hover' pseudo-event is deprecated, use 'mouseenter mouseleave'"),t&&t.replace(H,"mouseenter$1 mouseleave$1"))};e.event.props&&"attrChange"!==e.event.props[0]&&e.event.props.unshift("attrChange","attrName","relatedNode","srcElement"),e.event.dispatch&&a(e.event,"handle",e.event.dispatch,"jQueryHW2.event.handle is undocumented and deprecated"),e.event.add=function(e,t,n,a,i){e!==document&&C.test(t)&&r("AJAX events should be attached to document: "+t),Q.call(this,e,A(t||""),n,a,i)},e.event.remove=function(e,t,n,r,a){x.call(this,e,A(t)||"",n,r,a)},e.fn.error=function(){var e=Array.prototype.slice.call(arguments,0);return r("jQueryHW2.fn.error() is deprecated"),e.splice(0,0,"error"),arguments.length?this.bind.apply(this,e):(this.triggerHandler.apply(this,e),this)},e.fn.toggle=function(t,n){if(!e.isFunction(t)||!e.isFunction(n))return N.apply(this,arguments);r("jQueryHW2.fn.toggle(handler, handler...) is deprecated");var a=arguments,i=t.guid||e.guid++,o=0,s=function(n){var r=(e._data(this,"lastToggle"+t.guid)||0)%o;return e._data(this,"lastToggle"+t.guid,r+1),n.preventDefault(),a[r].apply(this,arguments)||!1};for(s.guid=i;a.length>o;)a[o++].guid=i;return this.click(s)},e.fn.live=function(t,n,a){return r("jQueryHW2.fn.live() is deprecated"),T?T.apply(this,arguments):(e(this.context).on(t,this.selector,n,a),this)},e.fn.die=function(t,n){return r("jQueryHW2.fn.die() is deprecated"),M?M.apply(this,arguments):(e(this.context).off(t,this.selector||"**",n),this)},e.event.trigger=function(e,t,n,a){return n||C.test(e)||r("Global events are undocumented and deprecated"),k.call(this,e,t,n||document,a)},e.each(S.split("|"),function(t,n){e.event.special[n]={setup:function(){var t=this;return t!==document&&(e.event.add(document,n+"."+e.guid,function(){e.event.trigger(n,null,t,!0)}),e._data(this,n,e.guid++)),!1},teardown:function(){return this!==document&&e.event.remove(document,n+"."+e._data(this,n)),!1}}})}(jQueryHW2,window);
\ No newline at end of file
diff --git a/docs/kms/api-ref/public_sys-resources/jquery-ui.min.js b/docs/kms/api-ref/public_sys-resources/jquery-ui.min.js
new file mode 100644
index 000000000..50b036f4d
--- /dev/null
+++ b/docs/kms/api-ref/public_sys-resources/jquery-ui.min.js
@@ -0,0 +1,6 @@
+/*! jQuery UI - v1.13.2 - 2022-07-14
+* http://jqueryui.com
+* Includes: widget.js, position.js, data.js, disable-selection.js, effect.js, effects/effect-blind.js, effects/effect-bounce.js, effects/effect-clip.js, effects/effect-drop.js, effects/effect-explode.js, effects/effect-fade.js, effects/effect-fold.js, effects/effect-highlight.js, effects/effect-puff.js, effects/effect-pulsate.js, effects/effect-scale.js, effects/effect-shake.js, effects/effect-size.js, effects/effect-slide.js, effects/effect-transfer.js, focusable.js, form-reset-mixin.js, jquery-patch.js, keycode.js, labels.js, scroll-parent.js, tabbable.js, unique-id.js, widgets/accordion.js, widgets/autocomplete.js, widgets/button.js, widgets/checkboxradio.js, widgets/controlgroup.js, widgets/datepicker.js, widgets/dialog.js, widgets/draggable.js, widgets/droppable.js, widgets/menu.js, widgets/mouse.js, widgets/progressbar.js, widgets/resizable.js, widgets/selectable.js, widgets/selectmenu.js, widgets/slider.js, widgets/sortable.js, widgets/spinner.js, widgets/tabs.js, widgets/tooltip.js
+* Copyright jQuery Foundation and other contributors; Licensed MIT */
+
+!function(t){"use strict";"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)}(function(V){"use strict";V.ui=V.ui||{};V.ui.version="1.13.2";var n,i=0,a=Array.prototype.hasOwnProperty,r=Array.prototype.slice;V.cleanData=(n=V.cleanData,function(t){for(var e,i,s=0;null!=(i=t[s]);s++)(e=V._data(i,"events"))&&e.remove&&V(i).triggerHandler("remove");n(t)}),V.widget=function(t,i,e){var s,n,o,a={},r=t.split(".")[0],l=r+"-"+(t=t.split(".")[1]);return e||(e=i,i=V.Widget),Array.isArray(e)&&(e=V.extend.apply(null,[{}].concat(e))),V.expr.pseudos[l.toLowerCase()]=function(t){return!!V.data(t,l)},V[r]=V[r]||{},s=V[r][t],n=V[r][t]=function(t,e){if(!this||!this._createWidget)return new n(t,e);arguments.length&&this._createWidget(t,e)},V.extend(n,s,{version:e.version,_proto:V.extend({},e),_childConstructors:[]}),(o=new i).options=V.widget.extend({},o.options),V.each(e,function(e,s){function n(){return i.prototype[e].apply(this,arguments)}function o(t){return i.prototype[e].apply(this,t)}a[e]="function"==typeof s?function(){var t,e=this._super,i=this._superApply;return this._super=n,this._superApply=o,t=s.apply(this,arguments),this._super=e,this._superApply=i,t}:s}),n.prototype=V.widget.extend(o,{widgetEventPrefix:s&&o.widgetEventPrefix||t},a,{constructor:n,namespace:r,widgetName:t,widgetFullName:l}),s?(V.each(s._childConstructors,function(t,e){var i=e.prototype;V.widget(i.namespace+"."+i.widgetName,n,e._proto)}),delete s._childConstructors):i._childConstructors.push(n),V.widget.bridge(t,n),n},V.widget.extend=function(t){for(var e,i,s=r.call(arguments,1),n=0,o=s.length;n",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=V(e||this.defaultElement||this)[0],this.element=V(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=V(),this.hoverable=V(),this.focusable=V(),this.classesElementLookup={},e!==this&&(V.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=V(e.style?e.ownerDocument:e.document||e),this.window=V(this.document[0].defaultView||this.document[0].parentWindow)),this.options=V.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:V.noop,_create:V.noop,_init:V.noop,destroy:function(){var i=this;this._destroy(),V.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:V.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return V.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=V.widget.extend({},this.options[t]),n=0;n
