文档首页/ 标签管理服务 TMS/ 最佳实践/ 标签设计原则和命名示例
更新时间:2024-04-07 GMT+08:00

标签设计原则和命名示例

标签设计的原则

企业上云后,云上创建的资源不断增加,有些大型企业资源数量达到十万、百万级别,一个账号内存在大量资源,企业需要进行分类管理。单纯通过人工进行资源的分类,效率低下,操作困难,此时需要借助云上的自动化平台化能力来解决。

华为云推荐您使用标签对资源进行标记,进而实现资源的分组分类。通过标签对资源的业务归属、财务归属等资源属性进行标记,例如:按所属部门、地域或项目等。

命名标准化

命名标准化原则是指标签采用标准化命名原则,使后续基于标签的自动化能力,帮助平台能力高效的实施。

例如:

  • 标签命名使用英文时,建议使用统一大小写的英文字母,避免大小写混杂。
  • 标签命名使用中文时,建议尽量简洁,且键/值长度均不超过6个字符(中文字符在数据库中占位较长,避免超过上限)。

语义一致简洁

同一类资源的分类建议使用同一个标签来标识。例如:如已使用标签键purpose来标识资源的用途分类,则避免再使用use、用途等相同语义的标签。

标签键值含义明确清晰,避免使用一个标签键值代表两类含义。

事先制定标签规范

规划创建资源时,需要同步规划标签,并优先规划标签键。规划标签时,需先将对应的标签键/标签值预先定义完成。分类所有资源对象时都必须绑定已规划的标签键及其对应的标签值。

避免包含企业隐私信息

标签的键/值信息尽量不要使用涉及企业或个人的隐私信息,例如企业保密项目的名称、项目的收入数据、个人的电话号码和邮件地址等。

标签键设计示例

下表列举了常见业务维度的标签命名示例。涉及英文标签命名时,建议统一使用小写英文字母。

业务维度

标签键(key

标签值(value

组织架构

headquarters

subcompany

department

team

group

相关名称

业务架构

product

module

service

microservice

相关名称

角色架构

role

user

网络管理员

审计管理员

运维管理员

研发人员

测试人员

用途类标签

purpose

用途值

项目环境类标签

project

task

environment

项目相关值

成本分账

costcenter

businessunit

部门相关值

订单

order

订单ID