搜索查询标签分页展示(邀测)
功能介绍
搜索查询标签分页展示,该接口功能处于邀测阶段,后续将随功能公测将逐步开放。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/datamap/tags/search
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。 |
instance |
是 |
String |
实例ID,获取方法请参见实例ID和工作空间ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
tag_ids |
否 |
Array of strings |
标签id。 |
type |
否 |
String |
类型。 |
name |
否 |
String |
标签名称,用作搜索框筛选。 |
create_user |
否 |
String |
创建者,用作搜索框筛选。 |
start |
否 |
String |
开始时间。 |
end |
否 |
String |
结束时间。 |
offset |
否 |
Integer |
页码。 |
limit |
否 |
Integer |
每页大小。 |
sort_by |
否 |
String |
根据xx排序。 |
sort_order |
否 |
String |
升序/降序。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Integer |
每页大小。 |
offset |
Integer |
页码。 |
count |
Integer |
查询出来的条数。 |
quota |
Integer |
可创建标签数量配额额。 |
tags |
Array of OpenTag objects |
标签实体。 |
total |
Integer |
已创建的标签总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
标签名称。 |
description |
String |
标签描述。 |
tag_id |
String |
标签id。 |
create_time |
Long |
创建时间。 |
update_time |
Long |
修改时间。 |
create_user |
String |
创建人。 |
domain_id |
String |
用户domainId。 |
instance_id |
String |
实例ID。 |
project_id |
String |
项目ID。 |
create_user_id |
String |
创建人ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
{ "offset" : 1, "limit" : 10, "sort_order" : "desc", "name" : "test11", "start" : 1685548800000, "end" : 1688313599999, "sort_by" : "createTime" }
响应示例
状态码: 200
OK。
{ "limit" : 10, "offset" : 1, "count" : 1, "total" : 11, "quota" : 100, "tags" : [ { "name" : "test1123", "description" : "", "tag_id" : "8a94819c88a43c190188a4452ba40006", "create_time" : 1686383176612, "update_time" : 1686383176612, "create_user" : "username", "create_user_id" : "0833a573fe80d5401f6dc010a775569a", "domain_id" : "0833a5736980d53b0f22c0102ffcbfc0", "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc", "project_id" : "0833a5737480d53b2f25c010dc1a7b88" } ] }
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 46 47 48 49 |
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.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ShowTagsSolution { 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); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ShowTagsRequest request = new ShowTagsRequest(); TagRequest body = new TagRequest(); request.withBody(body); try { ShowTagsResponse response = client.showTags(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 31 32 33 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.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 = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowTagsRequest() request.body = TagRequest( ) response = client.show_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) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowTagsRequest{} request.Body = &model.TagRequest{ } response, err := client.ShowTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
400 |
BadRequest。 |
401 |
Unauthorized。 |
403 |
Forbidden。 |
404 |
Not Found。 |
500 |
InternalServerError。 |