检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询标签键列表 功能介绍 查询指定区域的所有标签键。 调用方法 请参见如何调用API。 URI GET /v1.0/tag-keys 表1 Query参数 参数 是否必选 参数类型 描述 region_id 否 String 区域ID limit 否 Integer 查询记录数。
查询标签配额 功能介绍 查询标签的配额信息。 调用方法 请参见如何调用API。 URI GET /v1.0/tms/quotas 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。说明:由于TMS是全局服务
查询预定义标签列表 功能介绍 用于查询预定义标签列表。 调用方法 请参见如何调用API。 URI GET /v1.0/predefine_tags 表1 Query参数 参数 是否必选 参数类型 描述 key 否 String 键,支持模糊查询,不区分大小写,如果包含“non-URL-safe
修改预定义标签 功能介绍 修改预定义标签。 调用方法 请参见如何调用API。 URI PUT /v1.0/predefine_tags 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。说明:由于TMS
查询API版本列表 功能介绍 查询标签管理服务的API版本列表。 调用方法 请参见如何调用API。 URI GET / 请求参数 无 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 versions Array of VersionDetail objects
删除预定义标签 功能介绍 用于删除预定义标签。该接口支持幂等特性和处理批量数据。 调用方法 请参见如何调用API。 URI POST /v1.0/predefine_tags/action 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
批量移除标签 功能介绍 用于批量移除云服务多个资源的标签,每个资源最多支持移除10个标签,每次最多支持批量操作50个资源。 调用方法 请参见如何调用API。 URI POST /v1.0/resource-tags/batch-delete 请求参数 表1 请求Header参数 参数
批量添加标签 功能介绍 用于给云服务的多个资源添加标签,每个资源最多可添加10个标签,每次最多支持批量操作50个资源。 调用方法 请参见如何调用API。 URI POST /v1.0/resource-tags/batch-create 请求参数 表1 请求Header参数 参数
查询资源标签 功能介绍 查询单个资源上的标签。 调用方法 请参见如何调用API。 URI GET /v2.0/resources/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源ID 表2 Query
创建预定义标签 功能介绍 用于创建预定义标签。用户创建预定义标签后,可以使用预定义标签来给资源创建标签。 该接口支持幂等特性和处理批量数据。 调用方法 请参见如何调用API。 URI POST /v1.0/predefine_tags/action 请求参数 表1 请求Header
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 TMS.0002 Bad request. 请求数据非法 请检查请求参数 400 TMS.0007
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
状态码 正常 返回值 说明 200 OK GET和PUT操作正常返回。 201 Created POST操作正常返回。 202 Accepted 请求已被接受。 204 No Content 正常返回。 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401
支持审计的关键操作列表 云审计服务支持的标签管理服务操作列表如表1所示。 表1 云审计服务支持的TMS操作列表 操作名称 资源类型 事件名称 创建预定义标签 predefineTag addPredefineTag 删除预定义标签 predefineTag deletePredefineTag
用户权限 系统默认提供两种用户权限:用户管理权限和资源管理权限。 用户管理权限可以管理用户、用户组及其权限。 资源管理权限可以控制用户对云服务资源执行的操作。 对于资源标签的使用,您需要拥有对应云服务的相关权限。否则,您对云资源进行的标签操作可能无法生效。 请联系系统管理员为您所属的用户组添加对应云服务的相关权限
标签管理服务API授权列表项 表1 TMS授权项列表 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询预定义标签 GET /v1.0/predefine_tags tms:predefineTags:
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高
添加标签与创建标签键二者有什么不同? 添加标签时,仅设置标签“键”,则标签“值”默认为空值。在单击“确认”之后,将会有具体的标签与云资源关联。该功能支持批量操作。 创建标签键是在资源标签展示列表中添加“键”列,该“键”列下的所有“值”的默认状态为“无标签”,即默认不会有具体的标签与云资源关联
快速入门 本节通过调用TMS的API创建预定义标签。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token