Querying the Key Instance
Function
This API is used to query a key instance. You can use tags to filter and check CMK details.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
kms:cmk:listKeysByTag
List
KeyId *
-
kms:cmkTag:listInstance
-
URI
POST /v1.0/{project_id}/kms/{resource_instances}/action
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A |
| resource_instances | Yes | String | Definition Resource instance. The value is resource_instances. Constraints N/A Range The value is fixed at resource_instances. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | String | Definition Number of records to be queried Constraints Range 1 to 1000 Default Value If action is set to filter, the default value is 10. |
| offset | No | String | Definition Index location. The query starts from the next data specified by offset. When you query resources on subsequent pages, set offset to the location returned in the response body for the previous query. Constraints Range 0 to 1000 Default Value If the action is set to filter, offset is set to 0 by default. |
| action | No | String | Definition Operation ID Constraints N/A Range Default Value N/A |
| tags | No | Array of Tag objects | Definition Tag list, which is the value pairs of tag keys and values. Constraints
Range N/A Default Value N/A |
| matches | No | Array of TagItem objects | Definition Search field Constraints Range N/A Default Value N/A |
| sequence | No | String | Definition A 36-byte serial number of a request message, for example, 919c82d4-8046-4722-9094-35c3c6524cff. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| resources | Array of ActionResources objects | Definition Resource instance list Range N/A |
| total_count | Integer | Definition Total number of records Range N/A |
| Parameter | Type | Description |
|---|---|---|
| resource_id | String | Definition Resource ID Range N/A |
| resource_detail | KeyDetails object | Key details. |
| resource_name | String | Definition Resource name Range N/A |
| tags | Array of TagItem objects | Definition Tag list. If there is no tag, the array is empty by default. Range N/A |
Example Requests
Query the key instance whose tag key is key1 and tag value is value1 or value2. The start position is 100 and 100 results are displayed.
{
"offset" : "100",
"limit" : "100",
"action" : "filter",
"tags" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
} ]
} Example Responses
Status code: 200
Request succeeded.
{
"resources" : [ {
"resource_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
"resource_detail" : [ {
"key_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
"domain_id" : "4B688Fb77412Aee5570E7ecdbeB5afdc",
"key_alias" : "tagTest_xmdmi",
"key_description" : "123",
"creation_date" : 1521449277000,
"scheduled_deletion_date" : "",
"key_state" : 2,
"default_key_flag" : 0,
"key_type" : 1,
"key_rotation_enabled" : false,
"expiration_time" : "",
"origin" : "kms",
"sys_enterprise_project_id" : "0",
"realm" : "test"
} ],
"resource_name" : "tagTest_xmdmi",
"tags" : [ {
"key" : "key",
"value" : "testValue!"
}, {
"key" : "haha",
"value" : "testValue"
} ]
} ],
"total_count" : 1
} SDK Sample Code
The SDK sample code is as follows.
Query the key instance whose tag key is key1 and tag value is value1 or value2. The start position is 100 and 100 results are displayed.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.kms.v2.region.KmsRegion; import com.huaweicloud.sdk.kms.v2.*; import com.huaweicloud.sdk.kms.v2.model.*; import java.util.List; import java.util.ArrayList; public class ListKmsByTagsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); KmsClient client = KmsClient.newBuilder() .withCredential(auth) .withRegion(KmsRegion.valueOf("<YOUR REGION>")) .build(); ListKmsByTagsRequest request = new ListKmsByTagsRequest(); request.withResourceInstances("{resource_instances}"); ListKmsByTagsRequestBody body = new ListKmsByTagsRequestBody(); List<String> listTagsValues = new ArrayList<>(); listTagsValues.add("value1"); listTagsValues.add("value2"); List<Tag> listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("key1") .withValues(listTagsValues) ); body.withTags(listbodyTags); body.withAction("filter"); body.withOffset("100"); body.withLimit("100"); request.withBody(body); try { ListKmsByTagsResponse response = client.listKmsByTags(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Query the key instance whose tag key is key1 and tag value is value1 or value2. The start position is 100 and 100 results are displayed.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkms.v2.region.kms_region import KmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkms.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = KmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(KmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListKmsByTagsRequest() request.resource_instances = "{resource_instances}" listValuesTags = [ "value1", "value2" ] listTagsbody = [ Tag( key="key1", values=listValuesTags ) ] request.body = ListKmsByTagsRequestBody( tags=listTagsbody, action="filter", offset="100", limit="100" ) response = client.list_kms_by_tags(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Query the key instance whose tag key is key1 and tag value is value1 or value2. The start position is 100 and 100 results are displayed.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kms.KmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kms.NewKmsClient(hcClient) request := &model.ListKmsByTagsRequest{} request.ResourceInstances = "{resource_instances}" var listValuesTags = []string{ "value1", "value2", } keyTags:= "key1" var listTagsbody = []model.Tag{ { Key: &keyTags, Values: &listValuesTags, }, } actionListKmsByTagsRequestBody:= "filter" offsetListKmsByTagsRequestBody:= "100" limitListKmsByTagsRequestBody:= "100" request.Body = &model.ListKmsByTagsRequestBody{ Tags: &listTagsbody, Action: &actionListKmsByTagsRequestBody, Offset: &offsetListKmsByTagsRequestBody, Limit: &limitListKmsByTagsRequestBody, } response, err := client.ListKmsByTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot