# 查询资源标签 - ListResourceTag #### 功能介绍 查询指定实例的标签信息 标签管理服务需要使用该接口查询指定实例的全部标签数据 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v1/{project_id}/{resource_type}/{resource_id}/tags 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource_type | 是 | String | **参数解释:** 资源类型 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | resource_id | 是 | String | **参数解释:** 资源ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释:** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | tags | Array of [WorkspaceTag] objects | **参数解释:** 标签列表 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | 表4WorkspaceTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释:** 键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做字符集校验)，key不能为空或者空字符串，不能为空格，校验和使用之前先trim 前后半角空格。 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | | values | Array of strings | **参数解释:** 值列表。每个值最大长度255个unicode字符，校验和使用之前先trim 前后半角空格。 value可为空数组但不可缺省。 如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认值**: 不涉及 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码 **约束限制：** 无 **取值范围：** Secmaster.000000\~Secmaster.99999 **默认取值：** 不涉及 | | error_msg | String | **参数解释：** 错误描述 **约束限制：** 无 **取值范围：** 无 **默认取值：** 不涉及 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码 **约束限制：** 无 **取值范围：** Secmaster.000000\~Secmaster.99999 **默认取值：** 不涉及 | | error_msg | String | **参数解释：** 错误描述 **约束限制：** 无 **取值范围：** 无 **默认取值：** 不涉及 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码 **约束限制：** 无 **取值范围：** Secmaster.000000\~Secmaster.99999 **默认取值：** 不涉及 | | error_msg | String | **参数解释：** 错误描述 **约束限制：** 无 **取值范围：** 无 **默认取值：** 不涉及 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码 **约束限制：** 无 **取值范围：** Secmaster.000000\~Secmaster.99999 **默认取值：** 不涉及 | | error_msg | String | **参数解释：** 错误描述 **约束限制：** 无 **取值范围：** 无 **默认取值：** 不涉及 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码 **约束限制：** 无 **取值范围：** Secmaster.000000\~Secmaster.99999 **默认取值：** 不涉及 | | error_msg | String | **参数解释：** 错误描述 **约束限制：** 无 **取值范围：** 无 **默认取值：** 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** OK ``` { "tags" : [ { "key" : "tag_name", "values" : [ "tag_value1", "tag_value2" ] }, { "key" : "tag_name2", "values" : [ "tag_value2" ] } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class ListResourceTagSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); ListResourceTagRequest request = new ListResourceTagRequest(); request.withResourceType("{resource_type}"); request.withResourceId("{resource_id}"); try { ListResourceTagResponse response = client.listResourceTag(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()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("")) \ .build() try: request = ListResourceTagRequest() request.resource_type = "{resource_type}" request.resource_id = "{resource_id}" response = client.list_resource_tag(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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 := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListResourceTagRequest{} request.ResourceType = "{resource_type}" request.ResourceId = "{resource_id}" response, err := client.ListResourceTag(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ListResourceTag&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 参数非法 | | 401 | 鉴权失败 | | 403 | 权限不足 | | 404 | 资源未找到 | | 500 | 系统异常 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。