更新时间:2024-11-07 GMT+08:00

查询标签键列表

功能介绍

查询指定区域的所有标签键。

调用方法

请参见如何调用API

URI

GET /v1.0/tag-keys

表1 Query参数

参数

是否必选

参数类型

描述

region_id

String

区域ID

limit

Integer

查询记录数。

最小为1,最大为200,未输入时默认为200。

marker

String

分页位置标识(索引)。从marker指定索引的下一条数据开始查询。说明:查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据响应体中marker值配入此参数,当返回的next_marker为空时表示查询到最后一页。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。说明:由于TMS是全局服务,因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

keys

Array of strings

标签键列表

page_info

PageInfoTagKeys object

分页信息

表4 PageInfoTagKeys

参数

参数类型

描述

next_marker

String

分页位置标识(索引)

current_count

Integer

当前页标签键的数量

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表6 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表8 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表10 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 404

表11 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表12 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 405

表13 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表14 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 406

表15 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表16 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 409

表17 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表18 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 410

表19 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表20 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 412

表21 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表22 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 429

表23 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表24 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 500

表25 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表26 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 501

表27 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表28 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 503

表29 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表30 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

请求示例

查询标签键列表。

GET https://{Endpoint}/v1.0/tag-keys?limit=10&marker=xxx

响应示例

状态码: 200

OK

{
  "keys" : [ "ENV1", "ENV2" ],
  "page_info" : [ {
    "next_marker" : "xxxxx",
    "current_count" : 10
  } ]
}

SDK代码示例

SDK代码示例如下。

 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.tms.v1.region.TmsRegion;
import com.huaweicloud.sdk.tms.v1.*;
import com.huaweicloud.sdk.tms.v1.model.*;


public class ListTagKeysSolution {

    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");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        TmsClient client = TmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(TmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTagKeysRequest request = new ListTagKeysRequest();
        try {
            ListTagKeysResponse response = client.listTagKeys(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdktms.v1.region.tms_region import TmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdktms.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"]

    credentials = GlobalCredentials(ak, sk)

    client = TmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(TmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTagKeysRequest()
        response = client.list_tag_keys(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    tms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := tms.NewTmsClient(
        tms.TmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTagKeysRequest{}
	response, err := client.ListTagKeys(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

409

Conflict

410

Gone

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

错误码

请参见错误码