diff --git a/docs/kms/api-ref/ALL_META.TXT.json b/docs/kms/api-ref/ALL_META.TXT.json index 445553cb0..81b9dbb22 100644 --- a/docs/kms/api-ref/ALL_META.TXT.json +++ b/docs/kms/api-ref/ALL_META.TXT.json @@ -848,65 +848,11 @@ "title":"Querying a Specified API Version", "githuburl":"" }, - { - "uri":"topic_300000012.html", - "node_id":"topic_300000012.xml", - "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":"MAC", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"kms" - } - ], - "title":"MAC", - "githuburl":"" - }, - { - "uri":"GenerateMac.html", - "node_id":"generatemac.xml", - "product_code":"kms", - "code":"49", - "des":"This API is used to generate a MAC.This API is supported only for keys whose key_usage is GENERATE_VERIFY_MAC.POST /v1.0/{project_id}/kms/generate-macStatus code: 200Stat", - "doc_type":"api", - "kw":"Generating a MAC,MAC,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"kms" - } - ], - "title":"Generating a MAC", - "githuburl":"" - }, - { - "uri":"VerifyMac.html", - "node_id":"verifymac.xml", - "product_code":"kms", - "code":"50", - "des":"This API is used to verify a MAC.This API is supported only for keys whose key_usage is GENERATE_VERIFY_MAC.POST /v1.0/{project_id}/kms/verify-macStatus code: 200Status c", - "doc_type":"api", - "kw":"Verifying a MAC,MAC,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"kms" - } - ], - "title":"Verifying a MAC", - "githuburl":"" - }, { "uri":"kms_02_0307.html", "node_id":"kms_02_0307.xml", "product_code":"kms", - "code":"51", + "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":"Permissions Policies and Supported Actions", @@ -924,7 +870,7 @@ "uri":"kms_02_0308.html", "node_id":"kms_02_0308.xml", "product_code":"kms", - "code":"52", + "code":"49", "des":"This chapter describes fine-grained permissions management for your KMS. If your account does not need individual IAM users, you may skip over this chapter.By default, ne", "doc_type":"api", "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", @@ -942,7 +888,7 @@ "uri":"kms_02_0309.html", "node_id":"kms_02_0309.xml", "product_code":"kms", - "code":"53", + "code":"50", "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", @@ -960,7 +906,7 @@ "uri":"kms_02_0300.html", "node_id":"kms_02_0300.xml", "product_code":"kms", - "code":"54", + "code":"51", "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", @@ -978,7 +924,7 @@ "uri":"kms_02_0301.html", "node_id":"kms_02_0301.xml", "product_code":"kms", - "code":"55", + "code":"52", "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", @@ -996,7 +942,7 @@ "uri":"kms_02_8887.html", "node_id":"kms_02_8887.xml", "product_code":"kms", - "code":"56", + "code":"53", "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", @@ -1014,7 +960,7 @@ "uri":"kms_02_0009.html", "node_id":"kms_02_0009.xml", "product_code":"kms", - "code":"57", + "code":"54", "des":"A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following steps:Log in to the management console.Click the username and ", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -1032,7 +978,7 @@ "uri":"kms_02_0305.html", "node_id":"kms_02_0305.xml", "product_code":"kms", - "code":"58", + "code":"55", "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", @@ -1050,7 +996,7 @@ "uri":"kms_02_0306.html", "node_id":"kms_02_0306.xml", "product_code":"kms", - "code":"59", + "code":"56", "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", @@ -1068,7 +1014,7 @@ "uri":"kms_02_0304.html", "node_id":"kms_02_0304.xml", "product_code":"kms", - "code":"60", + "code":"57", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/kms/api-ref/CLASS.TXT.json b/docs/kms/api-ref/CLASS.TXT.json index 209c7e15f..fe462a055 100644 --- a/docs/kms/api-ref/CLASS.TXT.json +++ b/docs/kms/api-ref/CLASS.TXT.json @@ -422,33 +422,6 @@ "p_code":"45", "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":"MAC", - "uri":"topic_300000012.html", - "doc_type":"api", - "p_code":"4", - "code":"48" - }, - { - "desc":"This API is used to generate a MAC.This API is supported only for keys whose key_usage is GENERATE_VERIFY_MAC.POST /v1.0/{project_id}/kms/generate-macStatus code: 200Stat", - "product_code":"kms", - "title":"Generating a MAC", - "uri":"GenerateMac.html", - "doc_type":"api", - "p_code":"48", - "code":"49" - }, - { - "desc":"This API is used to verify a MAC.This API is supported only for keys whose key_usage is GENERATE_VERIFY_MAC.POST /v1.0/{project_id}/kms/verify-macStatus code: 200Status c", - "product_code":"kms", - "title":"Verifying a MAC", - "uri":"VerifyMac.html", - "doc_type":"api", - "p_code":"48", - "code":"50" - }, { "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", @@ -456,7 +429,7 @@ "uri":"kms_02_0307.html", "doc_type":"api", "p_code":"", - "code":"51" + "code":"48" }, { "desc":"This chapter describes fine-grained permissions management for your KMS. If your account does not need individual IAM users, you may skip over this chapter.By default, ne", @@ -464,8 +437,8 @@ "title":"Introduction", "uri":"kms_02_0308.html", "doc_type":"api", - "p_code":"51", - "code":"52" + "p_code":"48", + "code":"49" }, { "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.", @@ -473,8 +446,8 @@ "title":"Encryption Key Management", "uri":"kms_02_0309.html", "doc_type":"api", - "p_code":"51", - "code":"53" + "p_code":"48", + "code":"50" }, { "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.", @@ -483,7 +456,7 @@ "uri":"kms_02_0300.html", "doc_type":"api", "p_code":"", - "code":"54" + "code":"51" }, { "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.", @@ -491,8 +464,8 @@ "title":"Status Codes", "uri":"kms_02_0301.html", "doc_type":"api", - "p_code":"54", - "code":"55" + "p_code":"51", + "code":"52" }, { "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.", @@ -500,8 +473,8 @@ "title":"Error Code", "uri":"kms_02_8887.html", "doc_type":"api", - "p_code":"54", - "code":"56" + "p_code":"51", + "code":"53" }, { "desc":"A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following steps:Log in to the management console.Click the username and ", @@ -509,8 +482,8 @@ "title":"Obtaining a Project ID", "uri":"kms_02_0009.html", "doc_type":"api", - "p_code":"54", - "code":"57" + "p_code":"51", + "code":"54" }, { "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.", @@ -518,8 +491,8 @@ "title":"API Permissions", "uri":"kms_02_0305.html", "doc_type":"api", - "p_code":"54", - "code":"58" + "p_code":"51", + "code":"55" }, { "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.", @@ -527,8 +500,8 @@ "title":"Encryption Key Management", "uri":"kms_02_0306.html", "doc_type":"api", - "p_code":"58", - "code":"59" + "p_code":"55", + "code":"56" }, { "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.", @@ -537,6 +510,6 @@ "uri":"kms_02_0304.html", "doc_type":"api", "p_code":"", - "code":"60" + "code":"57" } ] \ No newline at end of file diff --git a/docs/kms/api-ref/GenerateMac.html b/docs/kms/api-ref/GenerateMac.html deleted file mode 100644 index 30f7fd528..000000000 --- a/docs/kms/api-ref/GenerateMac.html +++ /dev/null @@ -1,184 +0,0 @@ - - -

Generating a MAC

-

Function

This API is used to generate a MAC.

-
-

Constraints

This API is supported only for keys whose key_usage is GENERATE_VERIFY_MAC.

-
-

URI

POST /v1.0/{project_id}/kms/generate-mac

- -
- - - - - - - - - - - -
Table 1 URI parameter

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

User token.

-

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

-

Content-Type

-

Yes

-

String

-

application/json

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

Parameter

-

Mandatory

-

Type

-

Description

-

key_id

-

Yes

-

String

-

ID of the key to be enabled. The value can be the key ID, alias (key_alias), or URN.

-
  • Key ID: A 36-byte string that matches the ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$ regular expression, for example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f
  • Alias: An identifier of a key. The value starts with alias/, for example, alias/4555.
  • URN: Each alias automatically matches a unique URN, for example, kms:eu-de-ring0:3ba44455500dd43127:alias:4555.
-

mac_algorithm

-

Yes

-

String

-

MAC algorithm. Possible values are as follows:

-
  • HMAC_SHA_256
  • HMAC_SHA_384
  • HMAC_SHA_512
-
NOTE:

The value must be the algorithm used for creating the key.

-
-

message

-

Yes

-

String

-

Message to be processed. The original message can contain 1 to 4,096 characters. Convert the original message to the Base64 format before importing it.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

key_id

-

String

-

Key ID

-

mac_algorithm

-

String

-

MAC algorithm

-

mac

-

String

-

MAC

-
-
-
-

Example Request

{
-  "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
-  "mac_algorithm" : "HMAC_SHA_256",
-  "message" : "ZmRzYQ=="
-}
-
-

Example Response

Status code: 200

-

Request succeeded.

-
{
-  "mac_algorithm" : "HMAC_SHA_256",
-  "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
-  "mac" : "9d266415acf82985bb44daf4990604f1931384c88fd21ef32b202396755dcfd7"
-}
-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

200

-

Request succeeded.

-
-
-

Exception status code. For details, see Status Codes.

-
-
-
-
-
Parent topic: MAC
-
-
- diff --git a/docs/kms/api-ref/VerifyMac.html b/docs/kms/api-ref/VerifyMac.html deleted file mode 100644 index cebfca03f..000000000 --- a/docs/kms/api-ref/VerifyMac.html +++ /dev/null @@ -1,194 +0,0 @@ - - -

Verifying a MAC

-

Function

This API is used to verify a MAC.

-
-

Constraints

This API is supported only for keys whose key_usage is GENERATE_VERIFY_MAC.

-
-

URI

POST /v1.0/{project_id}/kms/verify-mac

- -
- - - - - - - - - - - -
Table 1 URI parameter

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

User token.

-

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

-

Content-Type

-

Yes

-

String

-

application/json

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

Parameter

-

Mandatory

-

Type

-

Description

-

key_id

-

Yes

-

String

-

ID of the key to be enabled. The value can be the key ID, alias (key_alias), or URN.

-
  • Key ID: A 36-byte string that matches the ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$ regular expression, for example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f
  • Alias: An identifier of a key. The value starts with alias/, for example, alias/4555.
  • URN: Each alias automatically matches a unique URN, for example, kms:eu-de-ring0:3ba44455500dd43127:alias:4555.
-

mac_algorithm

-

Yes

-

String

-

MAC algorithm. Possible values are as follows:

-
  • HMAC_SHA_256
  • HMAC_SHA_384
  • HMAC_SHA_512
-
NOTE:

The value must be the algorithm used for creating the key.

-
-

message

-

Yes

-

String

-

Message to be processed. The original message can contain 1 to 4,096 characters. Convert the original message to the Base64 format before importing it.

-

mac

-

Yes

-

String

-

MAC to be verified

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

key_id

-

String

-

Key ID

-

mac_algorithm

-

String

-

MAC algorithm

-

mac_valid

-

Boolean

-

MAC verification result

-
-
-
-

Example Request

{
-  "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
-  "mac_algorithm" : "HMAC_SHA_256",
-  "message" : "ZmRzYQ==",
-  "mac" : "8549f9f5ef335184e23e6d477776f0fd338d02c59e48e52e8d81d158e2fc9262"
-}
-
-

Example Response

Status code: 200

-

Request succeeded.

-
{
-  "mac_algorithm" : "HMAC_SHA_256",
-  "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
-  "mac_valid" : true
-}
-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

200

-

Request succeeded.

-
-
-

Exception status code. For details, see Status Codes.

-
-
-
-
-
Parent topic: MAC
-
-
- diff --git a/docs/kms/api-ref/kms_02_0047.html b/docs/kms/api-ref/kms_02_0047.html index 8c18fef02..1b6096cd3 100644 --- a/docs/kms/api-ref/kms_02_0047.html +++ b/docs/kms/api-ref/kms_02_0047.html @@ -74,7 +74,7 @@

Responses

None

-

Examples

In the 0d0466b0e7274d9cb35df84bb474a37f project, delete the tag whose key value is testKey from the 0d0466b0e7274d9cb35df84bb474a37f key.

+

Examples

In the 0d0466b0e7274d9cb35df84bb474a37f project, delete the tag whose key value is testKey from the bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e key.

diff --git a/docs/kms/api-ref/kms_02_0304.html b/docs/kms/api-ref/kms_02_0304.html index 4ccd2fd18..7f416f6af 100644 --- a/docs/kms/api-ref/kms_02_0304.html +++ b/docs/kms/api-ref/kms_02_0304.html @@ -8,7 +8,13 @@ -

2025-11-19

+

2025-12-24

+ +

This is the thirty-first official release.

+

Deleted APIs for generating and verifying MACs.

+ + +

2025-11-19

This is the thirtieth official release.

Modified the URI in "Querying CMK Instances".

diff --git a/docs/kms/api-ref/kms_02_0308.html b/docs/kms/api-ref/kms_02_0308.html index 3a02d9a60..d92d60b51 100644 --- a/docs/kms/api-ref/kms_02_0308.html +++ b/docs/kms/api-ref/kms_02_0308.html @@ -8,7 +8,7 @@

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:

-
diff --git a/docs/kms/api-ref/topic_300000012.html b/docs/kms/api-ref/topic_300000012.html deleted file mode 100644 index 5a52c336b..000000000 --- a/docs/kms/api-ref/topic_300000012.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

MAC

-

-
-
- - -
-
Parent topic: Key Management Service
-
-
-