forked from docs/doc-exports
gtema
83150ed5aa
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
434 lines
16 KiB
JSON
434 lines
16 KiB
JSON
[
|
|
{
|
|
"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"
|
|
}
|
|
] |