华为云用户手册

防护效果 假如已添加 域名 “www.example.com”。可参照以下步骤验证防护效果： 清理浏览器缓存，在浏览器中输入防护域名，测试网站域名是否能正常访问。 不能正常访问，参照章节添加防护网站重新完成域名接入。 能正常访问，执行2。 参照操作步骤，将您的客户端IP来源地配置为拦截。 清理浏览器缓存，在浏览器中访问“http://www.example.com”页面，正常情况下，会阻断该来源地IP的访问请求，返回拦截页面。

DDoS攻击日志字段说明 字段 类型 字段说明 描述 id string 受攻击目的ip - attackTime long 攻击时间 - tenantId string 租户id - siteId string 站点id - attackType string 攻击来源类型 - avgBps long 攻击流量带宽平均值 - avgPps long 攻击数据包转发数平均值 - maxBps long 攻击流量带宽最大值 - maxPps long 攻击数据包转发数最大值 -

HTTP攻击日志字段说明 字段 类型 字段说明 描述 id string 攻击事件id - geo string 地理位置 其中c表示国家，r表示省份。 sip string 攻击源ip - attackTime string 攻击时间 - tenantId string 租户id - host string 域名 - hostId string 域名id - enterpriseProjectId string 企业项目id - projectId string 租户所在region的项目id - siteSn string 站点名 - rule string 规则id - ruleName sting 规则名 - method string 攻击请求方法 - url string 攻击请求url - requestHeader string 攻击请求头 - requestParams string 攻击请求参数 - cookie string 攻击请求cookie - requestBody string 攻击请求体 - status string 攻击响应码 Nginx作为Web服务器时，会处理客户端的请求并返回该响应码。 responseHeaders string 攻击响应头 - responseBody string 攻击响应体 - responseSize long 攻击响应体大小 - upstreamStatus string 上游服务器攻击响应码 Nginx作为反向代理服务器时，客户端的请求转发给上游服务器，由上游服务器返回的响应码。 upstreamResponseTime string 攻击响应时间 - processTime string 攻击处理时间 - attackCount long 攻击数 - attackCategory string 攻击类别 - attack string 攻击详情 attack中的key和value分别表示攻击类型和攻击数，action中的key和value分别表示该攻击类型的防护动作和防护次数。 maliciousData string 触发规则的恶意数据 - maliciousLocation string 恶意数据位置 - policyId string 策略id -

监控指标原始数据格式样例 [ { "metric": { // 命名空间 "namespace": "SYS.EdgeSec", "dimensions": [ { // 维度名称，例如防护网站 "name": "EdgeSec_instance_id", // 该维度下的监控对象ID，例如防护网站ID "value": "082db2f542e0438aa520035b3e99cd99" } ], // 指标ID "metric_name": "EdgeSec_http_2xx" }, // 生存时间，指标预定义 "ttl": 172800, // 指标值 "value": 0.0, // 指标单位 "unit": "Count", // 指标值类型 "type": "float", // 指标采集时间 "collect_time": 1637677359778 } ]

监控指标 表1 EdgeSec支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） requests 请求量 该指标用于统计测量对象近5分钟内EdgeSec返回的请求量的总数。 单位：次 采集方式：统计防护域名请求量的总数 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_http_2xx EdgeSec返回码（2XX） 该指标用于统计测量对象近5分钟内EdgeSec返回的2XX状态码的数量。 单位：次 采集方式：统计EdgeSec引擎返回的2XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_http_3xx EdgeSec返回码（3XX） 该指标用于统计测量对象近5分钟内EdgeSec返回的3XX状态码的数量。 单位：次 采集方式：统计EdgeSec引擎返回的3XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_http_4xx EdgeSec返回码（4XX） 该指标用于统计测量对象近5分钟内EdgeSec返回的4XX状态码的数量。 单位：次 采集方式：统计EdgeSec引擎返回的4XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_http_5xx EdgeSec返回码（5XX） 该指标用于统计测量对象近5分钟内EdgeSec返回的5XX状态码的数量。 单位：次 采集方式：统计EdgeSec引擎返回的5XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_fused_counts EdgeSec熔断量 该指标用于统计测量对象近5分钟内被EdgeSec熔断保护的请求数量。 单位：次 采集方式：统计防护域名被熔断保护的请求数量 ≥0 次 值类型：Float 防护域名 5分钟 inbound_traffic 入网总流量 该指标用于统计测量对象近5分钟内总入带宽的大小。 单位：Mbit 采集方式：统计近5分钟内总入带宽的大小 ≥0 Mbit 值类型：Float 防护域名 5分钟 outbound_traffic 出网总流量 该指标用于统计测量对象近5分钟内总出带宽的大小。 单位：Mbit 采集方式：统计近5分钟内总出带宽的大小 ≥0 Mbit 值类型：Float 防护域名 5分钟 EdgeSec_process_time_0 EdgeSec处理时延-区间[0-10ms) 该指标用于统计测量对象近5分钟内EdgeSec处理时延在区间[0-10ms)内的总数量 单位：次 采集方式：统计近5分钟内EdgeSec处理时延在区间[0-10ms)内的总数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_process_time_10 EdgeSec处理时延-区间[10-20ms) 该指标用于统计测量对象近5分钟内EdgeSec处理时延在区间[10-20ms)内的总数量 单位：次 采集方式：统计近5分钟内EdgeSec处理时延在区间[10-20ms)内的总数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_process_time_20 EdgeSec处理时延-区间[20-50ms) 该指标用于统计测量对象近5分钟内EdgeSec处理时延在区间[20-50ms)内的总数量 单位：次 采集方式：统计近5分钟内EdgeSec处理时延在区间[20-50ms)内的总数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_process_time_50 EdgeSec处理时延-区间[50-100ms) 该指标用于统计测量对象近5分钟内EdgeSec处理时延在区间[50-100ms)内的总数量 单位：次 采集方式：统计近5分钟内EdgeSec处理时延在区间[50-100ms)内的总数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_process_time_100 EdgeSec处理时延-区间[100-1000ms) 该指标用于统计测量对象近5分钟内EdgeSec处理时延在区间[100-1000ms)内的总数量 单位：次 采集方式：统计近5分钟内EdgeSec处理时延在区间[100-1000ms)内的总数量 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_process_time_1000 EdgeSec处理时延-区间[1000+ms) 该指标用于统计测量对象近5分钟内EdgeSec处理时延在区间[1000+ms)内的总数量 单位：次 采集方式：统计近5分钟内EdgeSec处理时延在区间[1000+ms)内的总数量 ≥0 次 值类型：Float 防护域名 5分钟 qps_peak QPS峰值 该指标用于统计近5分钟内防护域名的QPS峰值 单位：次 采集方式：统计近5分钟内防护域名的QPS峰值 ≥0 次 值类型：Float 防护域名 5分钟 qps_mean QPS均值 该指标用于统计近5分钟内防护域名的QPS均值 单位：次 采集方式：统计近5分钟内防护域名的QPS均值 ≥0 次 值类型：Float 防护域名 5分钟 EdgeSec_http_0 无返回的EdgeSec状态码 该指标用于统计测量对象近5分钟内EdgeSec无返回的状态响应码的数量 单位：次 采集方式：统计近5分钟内EdgeSec无返回的状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 upstream_code_2xx 业务返回码 （2XX） 该指标用于统计测量对象近5分钟内业务返回的2XX系列状态响应码的数量 单位：次 采集方式：统计近5分钟内业务返回的2XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 upstream_code_3xx 业务返回码 （3XX） 该指标用于统计测量对象近5分钟内业务返回的3XX系列状态响应码的数量 单位：次 采集方式：统计近5分钟内业务返回的3XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 upstream_code_4xx 业务返回码 （4XX） 该指标用于统计测量对象近5分钟内业务返回的4XX系列状态响应码的数量 单位：次 采集方式：统计近5分钟内业务返回的4XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 upstream_code_5xx 业务返回码 （5XX） 该指标用于统计近5分钟内业务返回的5XX系列状态响应码的数量 单位：次 采集方式：统计近5分钟内业务返回的5XX系列状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 upstream_code_0 无返回的业务状态码 该指标用于统计测量对象近5分钟内业务无返回的状态响应码的数量 单位：次 采集方式：统计近5分钟内业务无返回的状态响应码的数量 ≥0 次 值类型：Float 防护域名 5分钟 inbound_traffic_peak 入网流量的峰值 该指标用于统计近5分钟内防护域名入网流量的峰值 单位：Mbit/s 采集方式：统计近5分钟内防护域名入网流量的峰值 ≥0 Mbit/s 值类型：Float 防护域名 5分钟 inbound_traffic_mean 入网流量的均值 该指标用于统计近5分钟内防护域名入网流量的均值 单位：Mbit/s 采集方式：统计近5分钟内防护域名入网流量的均值 ≥0 Mbit/s 值类型：Float 防护域名 5分钟 outbound_traffic_peak 出网流量的峰值 该指标用于统计近5分钟内防护域名出网流量的峰值 单位：Mbit/s 采集方式：统计近5分钟内防护域名出网流量的峰值 ≥0 Mbit/s 值类型：Float 防护域名 5分钟 outbound_traffic_mean 出网流量的均值 该指标用于统计近5分钟内防护域名出网流量的均值 单位：Mbit/s 采集方式：统计近5分钟内防护域名出网流量的均值 ≥0 Mbit/s 值类型：Float 防护域名 5分钟 attacks 攻击总次数 该指标用于统计近5分钟内防护域名攻击请求量的总数 单位：次 采集方式：统计近5分钟内防护域名攻击请求量的总数 ≥0 次 值类型：Float 防护域名 5分钟 crawlers 爬虫攻击次数 该指标用于统计近5分钟内防护域名爬虫攻击请求量的总数 单位：次 采集方式：统计近5分钟内防护域名爬虫攻击请求量的总数 ≥0 次 值类型：Float 防护域名 5分钟 base_protection_counts web基础防护次数 该指标用于统计近5分钟内由Web基础防护规则防护的攻击数量 单位：次 采集方式：统计近5分钟内由Web基础防护规则防护的攻击数量 ≥0 次 值类型：Float 防护域名 5分钟 precise_protection_counts 精准防护次数 该指标用于统计近5分钟内由精准防护规则防护的攻击数量 单位：次 采集方式：统计近5分钟内由精准防护规则防护的攻击数量 ≥0 次 值类型：Float 防护域名 5分钟 cc_protection_counts cc防护次数 该指标用于统计近5分钟内由CC防护规则防护的攻击数量。 单位：次 采集方式：统计近5分钟内由CC防护规则防护的攻击数量。 ≥0 次 值类型：Float 防护域名 5分钟

防护规则配置方式 为了简化您的配置过程，边缘安全提供了自定义防护规则的配置方式。 此种方式适合域名业务较少或者域名业务适用的配置规则不相同的用户。 域名添加后，边缘安全会自动为该域名绑定一个防护策略，为域名配置的防护规则默认也添加到绑定该域名的防护策略。如果以后有适用于该防护策略的域名，可直接通过该策略添加防护域名，具体的操作请参见添加策略适用的防护域名。 入口 在左侧导航栏选择“网站设置”，进入“网站设置”页面。 在目标域名所在行的“防护策略”栏中，单击“已开启N项防护”，进入“防护策略”页面。 图3 网站列表 进入规则配置页面可配置的防护规则 表1 可配置的防护规则 防护规则 说明 参考文档 Web基础防护规则 覆盖OWASP（Open Web Application Security Project，简称OWASP）TOP 10中常见安全威胁，通过预置丰富的信誉库，对恶意扫描器、IP、网马等威胁进行检测和拦截。 配置Web基础防护规则防御常见Web攻击 CC攻击防护规则 可以自定义CC防护规则，限制访问者对您的网站上特定路径（URL）的访问频率，EdgeSec会根据您配置的规则，精准识别CC攻击以及有效缓解CC攻击。 配置CC攻击防护规则防御CC攻击 精准访问防护规则 精准访问防护策略可对HTTP首部、Cookie、访问URL、请求参数或者客户端IP进行条件组合，定制化防护策略，为您的网站带来更精准的防护。 配置精准访问防护规则 黑白名单规则 配置黑白名单规则，阻断、仅记录或放行指定IP的访问请求，即设置IP黑/白名单。 配置IP黑白名单规则规则拦截指定IP 攻击惩罚规则 当访问者的IP、Cookie或Params恶意请求被拦截时，您可以通过配置攻击惩罚，使边缘安全按配置的攻击惩罚时长来自动封禁访问者。 配置攻击惩罚标准 地理位置访问控制规则 针对指定国家、地区的来源IP自定义访问控制。 配置地理位置访问控制规则拦截特定区域请求 网站反爬虫规则 动态分析网站业务模型，结合人机识别技术和数据风控手段，精准识别爬虫行为。 配置网站反爬虫防护规则防御爬虫攻击 全局白名单规则 针对特定请求忽略某些攻击检测规则，用于处理误报事件。 配置全局白名单规则忽略误报 隐私屏蔽规则 隐私信息屏蔽，避免用户的密码等信息出现在事件日志中。 配置隐私屏蔽规则

引擎检测机制 边缘安全服务内置的防护规则，可帮助您防范常见的Web应用攻击，包括XSS攻击、SQL注入、爬虫检测、Webshell检测等。同时，您也可以根据自己网站防护的需要，灵活配置防护规则，边缘安全根据您配置的防护规则更好的防护您的网站业务。边缘安全引擎内置防护规则的检测流程如图 引擎检测图所示，自定义规则的检测顺序如图2所示。 图1 引擎检测图 图2 自定义防护规则的检测顺序 响应动作： pass：命中规则后无条件放行当前请求。 block：命中规则后拦截当前请求。 captcha：命中规则后执行人机验证动作。 redirect：命中规则后通知客户端执行重定向动作。 log：命中规则后仅记录攻击信息。 mask：命中规则后对相关敏感信息进行脱敏处理。

防护效果 假如已添加域名“www.example.com”，且配置了如图4所示的精准访问防护规则。可参照以下步骤验证防护效果： 清理浏览器缓存，在浏览器中输入防护域名，测试网站域名是否能正常访问。 不能正常访问，参照章节添加防护网站重新完成域名接入。 能正常访问，执行2。 清理浏览器缓存，在浏览器中访问“http://www.example.com/admin”页面或者包含/admin的任意页面，正常情况下，边缘安全会阻断满足条件的访问请求，返回拦截页面。

配置示例-不允许某一地区来源IP访问请求 假如防护域名“www.example.com”已接入边缘安全，当您不允许某一地区的IP可以访问防护域名，例如，不允许来源“北京”“新加坡”地区的IP可以访问防护域名，请参照以下步骤处理。 添加一条精准访问防护规则，字段为“地理位置”，设置“北京”“新加坡”地区“拦截”的防护动作。 开启精准访问防护规则。 图5 精准访问防护配置框 清理浏览器缓存，在浏览器中访问“http://www.example.com”页面。 当“北京”“新加坡”地区的源IP访问页面时，边缘安全将拦截该访问请求，拦截页面示例如图 拦截攻击请求所示。 图6 拦截攻击请求 返回边缘安全管理控制台，在左侧导航树中，单击“防护事件”，进入“防护事件”页面，您可以查看到“北京”“新加坡”地区的源IP都被拦截。

云审计 服务支持的EdgeSec操作列表 云审计服务（Cloud Trace Service， CTS ）记录了边缘安全相关的操作事件，方便用户日后的查询、审计和回溯，具体请参见《云审计服务用户指南》。 云审计服务支持的EdgeSec操作列表如表 云审计服务支持的EdgeSec操作列表所示。 表1 云审计服务支持的EdgeSec操作列表 操作名称 资源类型 事件名称 添加cdn域名调度任务 cdnDomainScheduleTask addCdnDomainScheduleTask 用户添加防护的域名 bsgDomainName addBsgDomainName 用户删除防护的域名信息 bsgDomainName deleteBsgDomainName 用户修改防护的域名信息 bsgDomainName updateBsgDomainName 用户开通服务 serviceInfo addServiceInfo 用户退订服务 serviceInfo deleteServiceInfo 添加ddos防护域名 ddosDomainNames addEdgeDDosDomainNames 删除ddos防护域名 ddosDomainNames deleteEdgeDDosDomainNames 更新ddos防护域名 ddosDomainNames updateEdgeDDosDomainNames 创建脚本反爬虫规则 EdgeSecAntiCrawlerRule createEdgeSecAntiCrawlerRule 删除脚本反爬虫规则 EdgeSecAntiCrawlerRule deleteEdgeSecAntiCrawlerRule 修改脚本反爬虫防护模式 EdgeSecAntiCrawlerRule switchEdgeSecAntiCrawlerRule 更新脚本反爬虫规则 EdgeSecAntiCrawlerRule updateEdgeSecAntiCrawlerRule 创建cc规则 EdgeSecCcRule createEdgeSecCcRule 删除cc规则 EdgeSecCcRule deleteEdgeSecCcRule 更新cc规则 EdgeSecCcRule updateEdgeSecCcRule 创建证书 EdgeSecCertificate createEdgeSecCertificate 删除证书 EdgeSecCertificate deleteEdgeSecCertificate 更新证书 EdgeSecCertificate updateEdgeSecCertificate 创建精准防护规则 EdgeSecCustomRule createEdgeSecCustomRule 删除精准防护规则 EdgeSecCustomRule deleteEdgeSecCustomRule 更新精准防护规则 EdgeSecCustomRule updateEdgeSecCustomRule 创建防护域名 EdgeSecDomain createEdgeSecDomain 删除防护域名 EdgeSecDomain deleteEdgeSecDomain 更新防护域名 EdgeSecDomain updateEdgeSecDomain 创建地理位置规则 EdgeSecGeoIpRule createEdgeSecGeoIpRule 删除地理位置规则 EdgeSecGeoIpRule deleteEdgeSecGeoIpRule 更新地理位置规则 EdgeSecGeoIpRule updateEdgeSecGeoIpRule 创建误报屏蔽规则 EdgeSecIgnoreRule createEdgeSecIgnoreRule 删除误报屏蔽规则 EdgeSecIgnoreRule deleteEdgeSecIgnoreRule 重置误报屏蔽规则 EdgeSecIgnoreRule recountEdgeSecIgnoreRule 更新误报屏蔽规则 EdgeSecIgnoreRule updateEdgeSecIgnoreRule 创建IP地址组 EdgeSecIpGroup CreateEdgeSecIpGroup 删除IP地址组 EdgeSecIpGroup DeleteEdgeSecIpGroup 更新IP地址组 EdgeSecIpGroup UpdateEdgeSecIpGroup 更新防护策略的域名 EdgeSecPolicy applyEdgeSecPolicy 创建防护策略 EdgeSecPolicy createEdgeSecPolicy 删除防护策略 EdgeSecPolicy deleteEdgeSecPolicy 更新防护策略 EdgeSecPolicy updateEdgeSecPolicy 创建隐私屏蔽规则 EdgeSecPrivacyMaskRule createEdgeSecPrivacyMaskRule 删除隐私屏蔽规则 EdgeSecPrivacyMaskRule deleteEdgeSecPrivacyMaskRule 更新隐私屏蔽规则 EdgeSecPrivacyMaskRule updateEdgeSecPrivacyMaskRule 创建攻击惩罚规则 EdgeSecPunishmentRule createEdgeSecPunishmentRule 删除攻击惩罚规则 EdgeSecPunishmentRule deleteEdgeSecPunishmentRule 更新攻击惩罚规则 EdgeSecPunishmentRule updateEdgeSecPunishmentRule 创建引用表 EdgeSecValueList createEdgeSecValueList 删除引用表 EdgeSecValueList deleteEdgeSecValueList 更新引用表 EdgeSecValueList updateEdgeSecValueList 创建IP黑白名单规则 EdgeSecWhiteBlackIpRule createEdgeSecWhiteBlackIpRule 删除IP黑白名单规则 EdgeSecWhiteBlackIpRule deleteEdgeSecWhiteBlackIpRule 更新IP黑白名单规则 EdgeSecWhiteBlackIpRule updateEdgeSecWhiteBlackIpRule 父主题： 云审计服务支持的关键操作

配置示例-拦截SQL注入攻击 假如防护域名“www.example.com”已接入边缘安全，您可以参照以下操作步骤验证是否拦截SQL注入攻击。 开启Web基础防护的“常规检测”，并将防护模式设置为“拦截”。 图4 开启“常规检测” 开启Web基础防护。 图5 开启Web基础防护 清理浏览器缓存，在浏览器中输入模拟SQL注入攻击（例如，http://www.example.com?id=' or 1=1）。 此时访问请求被拦截，拦截页面示例如图6 拦截攻击请求所示。 图6 拦截攻击请求 返回边缘安全管理控制台，在左侧导航树中，单击“防护事件”，进入“防护事件”页面，您可以查看该防护事件。

KooMap服务与其他服务的关系 使用KooMap卫星影像生产服务需要配套OBS服务，KooMap系统从OBS加载原始影像文件或矢量数据，再进行影像处理。 使用KooMap实景三维生产服务需要配套OBS服务，KooMap系统从OBS加载倾斜摄影影像，再进行影像建模。 使用KooMap AR地图运行服务基础版，建议您先购买AR地图生产服务或咨询人工客服购买AR地图数据采集服务和AR地图数据构建服务，对业务指定的区域进行AR地图采集和生产并部署上云后，再通过API和SDK访问AR地图运行服务。 父主题： 其他问题

如何退订KooMap服务 KooMap卫星影像生产服务开通后即开始计费，支持退订，具体操作请参见退订卫星影像生产服务。 KooMap实景三维生产服务开通后即开始计费，支持退订，具体操作请参见退订实景三维生产服务。 KooMap AR地图运行服务开通后即开始计费，支持退订，具体操作请参见退订AR地图运行服务。 如您不再使用KooMap服务且不想留存任何使用信息，可选择退租，即注销华为云账号，届时您将无法使用该账号访问包括KooMap在内的华为云服务，保存在华为云中的数据将会被删除，请您谨慎操作。 父主题： 服务退订

API合并推送报文 推送body参数 参数 参数类型 描述 ruleType int 规则类型： 1：订单管理 。 2：用量监控 。 4：卡状态变更监控。 templateName string 模板名称： api_rule_price_plan_expired：SIM卡套餐到期模板。 api_rule_flow_usage_remain：周期累计数据用量模板。 api_rule_sim_status_modify：卡状态变更模板。 templateParamsList array 包含多个卡信息的模板参数集合，最多包含500张卡的信息。 templateParamsList.templateParams array 单个卡信息的模板参数集合，建议按照key值进行解析，后续可能会添加其他key值。 SIM卡套餐到期（api_rule_price_plan_expired）报文示例： { "ruleType": 1, "templateName": "api_rule_price_plan_expired", "templateParamsList": [ { "templateParams": [ { "key": "cid", "value": "4441380627973120" }, { "key": "pricePlanName", "value": "中国移动每月30M联接服务" }, { "key": "daysToExpire", "value": "9" } ] }, { "templateParams": [...] } ... ] } 周期 累计数据用量（api_rule_flow_usage_remain）报文示例 { "ruleType": 2, "templateName": "api_rule_flow_usage", "templateParamsList": [ { "templateParams": [ { "key": "cid", "value": "4441380627973120" }, { "key": "pricePlanName", "value": "中国移动每月30M联接服务" }, { "key": "usageFlow", "value": "100" } ] }, { "templateParams": [...] } ... ] } 卡状态变更（api_rule_sim_status_modify）报文示例 { "ruleType": 4, "templateName": "api_rule_sim_status_modify", "templateParamsList": [ { "templateParams": [ { "key": "cid", "value": "2021080621060000T" }, { "key": "modifyTime", "value": "2022-05-16 03:24:08" }, { "key": "oldStatus", "value": "未激活" }, { "key": "newStatus", "value": "可激活" } ] }, { "templateParams": [...] } ... ] }

API推送失败提醒 用户只有在自动化规则选了API推送，且开启了推送失败提醒，当推送失败，消息中心会收到提醒信息。 自动化规则API推送失败提醒示例： 尊敬的{accountName}客户， 您好！您配置的自动化规则{ruleName}，在{pushTime}执行API推送时失败，推送地址: {pushUrl}，推送内容请查看附件。 本邮件由华为 全球SIM联接 系统自动发送，请勿直接回复！ 感谢您的配合与支持! 用户如果选择了API推送，并且勾选了“合并发送”，推送的报文与没有勾选“合并发送”的报文不同。 当前流量池周期累计数据用量不支持合并推送。 附件内容为推送失败的报文内容。

创建规则 登录全球SIM联接控制台，在左侧选择“自动化规则”进入自动化规则列表页面，单击“创建规则”进入创建自动化规则页面。 表1 创建规则参数说明 参数名称 说明 规则名称 自定义规则的名称，便于管理。 规则类型 规则的类型包括订单管理、用量监控、卡状态变更监控、流量池监控。 触发器 触发器的类型分为五种情况： SIM卡套餐到期：订单管理规则的触发器。 周期累计数据用量：用量监控规则的触发器。 卡状态变更：卡状态变更监控规则的触发器。 前向流量池周期累计数据用量：流量池监控规则的触发器。 后向流量池周期累计数据用量：流量池监控规则的触发器。 触发条件 触发条件的类型分为三种情况： 到期天数（天）：订单管理规则的触发条件。 剩余流量（MB）：用量监控规则或流量池监控规则的触发条件。 卡状态（未激活、可激活、在用、已停用、拆机）变更：卡状态变更监控规则的触发条件。 执行 选择规则触发后的通知方式，包括短信&邮件或API推送。 短信＆邮件： 提醒周期：根据需要设置短信提醒的周期。 发送短信：此处展示短信通知的模板示例。 API推送： API推送地址：选择指定的API推送地址。若先前未创建推送地址，可单击右侧“推送地址管理界面创建”按钮跳转到推送地址管理页面新增推送地址。 合并发送：若不勾选“合并发送”，API推送的报文请参考API推送报文；若勾选“合并发送”，API推送的报文请参考API合并推送报文。 提醒周期：根据需要设置API推送的提醒周期。 推送失败提醒：若开启了推送失败提醒，当推送失败时，用户会在消息中心收到API推送失败提醒，在消息接收管理中对应消息类型下配置消息接收人即可收到短信或邮件提醒。 筛选器 筛选器类型分为四种情况（默认情况下是监控您平台的所有SIM卡）： 主套餐：通过购卡下单时选择的套餐筛选，过滤出您想要监控的SIM卡。 标签：通过标签筛选，过滤出您想要监控的SIM卡。 前向流量池：通过前向流量池的名称筛选过滤您想要监控的SIM卡。 后向流量池：通过后向流量池的名称筛选过滤您想要监控的SIM卡。

API推送报文 推送body参数 参数 参数类型 描述 cid string 容器ID。 ruleType int 规则类型： 1：订单管理。 2：用量监控。 3：流量池监控。 4：卡状态变更监控。 templateName string 模板名称： api_rule_price_plan_expired：SIM卡套餐到期模板。 api_rule_flow_usage_remain：周期累计数据用量模板。 api_rule_sim_status_modify：卡状态变更模板。 api_sim_pool_rule_flow_usage_remain：流量池周期累计数据用量模板。 sim_pool_rule_flow_usage：前向流量池邮件发送模板。 sim_pool_rule_flow_usage_remain：前向流量池邮件发送模板。 back_pool_rule_flow_usage：后向流量池邮件发送模板。 api_back_pool_rule_flow_usage：后向流量池周期累计数据用量API推送模板。 templateParams list 模板参数集合，建议按照key值进行解析，后续可能会添加其他key值。 SIM卡套餐到期（api_rule_price_plan_expired） 【全球SIM联接】尊敬的{accountName}客户，您好！{cid}购买的套餐{pricePlanName}将在{daysToExpire}天后过期，请及时续费。 { "cid": "4441380627973120", "ruleType": 1, "templateName": "api_rule_price_plan_expired", "templateParams": [ { "key": "cid", "value": "4441380627973120" }, { "key": "pricePlanName", "value": "中国移动每月30M联接服务" }, { "key": "poolId", "value": "0" }, { "key": "daysToExpire", "value": "9" } ] } 周期累计数据用量（api_rule_flow_usage_remain） 【全球SIM联接】尊敬的{accountName}客户，您好！您的SIM卡（容器ID：{cid}）购买的套餐（{pricePlanName}）剩余流量已不足{remainFlow}MB，请合理使用，需要避免流量达量断网。 { "cid": "4441380627973120", "ruleType": 1, "templateName": "api_rule_flow_usage_remain", "templateParams": [ { "key": "cid", "value": "4441380627973120" }, { "key": "pricePlanName", "value": "中国移动每月30M联接服务" }, { "key": "remainFlow", "value": "100" } ] } 卡状态变更（api_rule_sim_status_modify） 【全球SIM联接】尊敬的{accountName}客户，您好！您的SIM卡（容器ID：{cid}）状态于{modifyTime}由{oldStatus}变为{newStatus}。 { "cid":"2021080621060000T", "ruleType":4, "templateName":"api_rule_sim_status_modify", "templateParams":[ { "key":"cid","value":"2021080621060000T" }, { "key":"modifyTime","value":"2022-05-16 03:24:08" }, { "key":"oldStatus","value":"未激活" }, { "key":"newStatus","value":"可激活" } ] } 流量池周期累计数据用量（api_sim_pool_rule_flow_usage_remain） 【全球SIM联接】尊敬的{accountName}客户，您好！{poolId}流量池名：{poolName}，套餐名称：{pricePlanName}，已用流量{remainFlow}MB，请合理使用，需要避免达量断网。 { "cid": "4441380627973120", "ruleType": 1, "templateName": "api_sim_pool_rule_flow_usage_remain", "templateParams": [ { "key": "poolId", "value": "4441380627973120" }, { "key": "poolName", "value": "xx流量池" }, { "key": "pricePlanName", "value": "中国移动每月30M联接服务" }, { "key": "remainFlow", "value": "100" } ] } 前向流量池邮件发送模板（sim_pool_rule_flow_usage） 【华为云】尊敬的{Account}客户，您好！您的前向流量池（流量池号：{poolId}, 流量池名称:{poolName}，套餐名称: {pricePlanName}）已用流量{usageFlow}MB，请合理使用，需要避免流量达量断网。 { "cid": "null", "ruleType": 3, "templateName": "api_back_pool_rule_flow_usage_remain", "templateParams": [ { "key": "poolId", "value": "4441380627973120" }, { "key": "poolName", "value": "xx流量池" }, { "key": "pricePlanName", "value": "中国电信消费级阶梯流量池联接服务" }, { "key": "usageFlow", "value": "100" } ] } 前向流量池邮件发送模板（sim_pool_rule_flow_usage_remain） 【华为云】尊敬的{Account}客户，您好！您的前向流量池（流量池号：{poolId}, 流量池名称:{poolName}，套餐名称: {pricePlanName}）剩余流量{remainFlow}MB，请合理使用，需要避免流量达量断网。 { "cid": "4441380627973120", "ruleType": 1, "templateName": "api_sim_pool_rule_flow_usage_remain", "templateParams": [ { "key": "poolId", "value": "4441380627973120" }, { "key": "poolName", "value": "xx流量池" }, { "key": "pricePlanName", "value": "中国移动每月30M联接服务" }, { "key": "remainFlow", "value": "100" } ] } 后向流量池邮件发送模板（back_pool_rule_flow_usage） 【华为云】尊敬的{Account}客户，您好！您的后向流量池（流量池号：{poolId}, 流量池名称:{poolName}，套餐名称: {pricePlanName}）已用流量{usageFlow}MB，请合理使用，避免产生过量的费用。 { "cid": "null", "ruleType": 3, "templateName": "api_back_pool_rule_flow_usage_remain", "templateParams": [ { "key": "poolId", "value": "4441380627973120" }, { "key": "poolName", "value": "xx流量池" }, { "key": "pricePlanName", "value": "中国电信消费级阶梯流量池联接服务" }, { "key": "usageFlow", "value": "100" } ] } 后向流量池周期累计数据用量API推送模板（api_back_pool_rule_flow_usage） 【华为云】尊敬的{Account}客户，您好！您的后向流量池（流量池号：{poolId}, 流量池名称:{poolName}，套餐名称: {pricePlanName}）已用流量{usageFlow}MB，请合理使用，避免产生过量的费用。 { "cid": "null", "ruleType": 3, "templateName": "api_back_pool_rule_flow_usage_remain", "templateParams": [ { "key": "poolId", "value": "4441380627973120" }, { "key": "poolName", "value": "xx流量池" }, { "key": "pricePlanName", "value": "中国电信消费级阶梯流量池联接服务" }, { "key": "usageFlow", "value": "100" } ] }

批量SIM卡管理 全球SIM联接控制台支持批量操作SIM卡，进入SIM卡管理页面，在上方的“批量”选项中可进行如下批量操作。 表4 批量SIM卡管理功能说明 卡类型 批量操作 说明 实体卡 批量激活 为多个容器批量激活，激活成功后，卡状态变为“在用”。 批量复机 为多个容器批量复机，复机成功后，卡状态变为“在用”。 批量停机 为多个容器批量停机，停机成功后，卡状态变为“已停用”。 批量转移实体卡 为多个容器批量转移实体卡，实体卡转移成功后，目标账号可登录华为云全球SIM联接控制台管理相关物联网卡。 批量机卡重绑 为多个容器批量重新绑定SIM卡和物联网设备关联关系。 批量达量断网 为多个容器执行批量达量断网。 批量取消达量断网 为多个容器执行批量取消达量断网。 批量拆机 为多个容器执行批量拆机。 批量绑定限制区域 为多个容器批量换绑限制区域。 全部SIM卡 批量设置标签 为多个容器批量设置标签，每次可添加或者删除多个标签。 批量设置自定义属性 为多个容器批量设置自定义属性，每次可添加、修改或删除多个自定义属性（这里要求自定义属性处于已启用状态）。 批量购买叠加包 为多个容器批量购买叠加包。

查询SIM卡详情 登录全球SIM联接控制台，在SIM卡管理页面，单击SIM卡的容器ID可查看指定SIM卡的详细信息。 详细信息类型 说明 基本信息 展示SIM卡基本信息和关联的设备信息，还可对该SIM卡设置标签、添加自定义属性。 套餐管理 展示SIM卡当前在用套餐的详细信息。 用量统计 月用量：展示SIM卡套餐六个月内的月用量统计结果。 用量趋势：展示SIM卡套餐两个月内每日的用量趋势统计结果和用量明细信息。 生命周期 展示SIM卡的生命周期（从下单到销户）变化信息和SIM卡状态变更历史记录（激活、停机、复机 ）。 在用状态的SIM卡可在生命周期中单击“停机”进行停机申请，受理完成后（1-2个工作日），SIM卡将会变为停用状态。

关联SIM卡机卡 SIM卡管理和 设备接入服务 分别在2个独立的管理门户，为了方便您快捷的管理SIM卡和物联网设备，您可将设备标识码与SIM卡管理的容器ID对应信息导入到平台中。机卡关联后，待设备上电并接入到 物联网平台 ，您可以通过单击SIM卡列表的“设备标识码”列，跳转到设备接入服务管理平台对设备进行查看和管理。 在SIM卡管理页面，单击SIM卡管理页面上方的“机卡关联”，下载模板到本地填入所需的机卡关联信息，上传后单击“确定”完成机卡关联。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号账号、用户和密码等信息。 区域（Region） 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 Organizations的终端节点如表1所示。Organizations是全局级服务，数据全局一份，在全局项目中存储，Organizations所有的API都可以使用全局服务的Endpoint调用。 表1 Organizations的终端节点 区域名称 区域 终端节点（Endpoint） All All organizations.myhuaweicloud.com

前提条件 拥有已实名认证的华为账号。若没有，请先参考帮助手册注册账号并完成实名认证。 已购买开源治理服务。 已准备好需要扫描的软件包/固件。 支持检测 .zip、.rar、.tar、.tar.gz、.jar、.apk、.hap、.so、.gz、.gzip等10+种格式的文件。 文件名只能包含：中文、字母、数字、空格、下划线（_）、中划线 （-） 或点 （.）。 文件名最大长度为100字符。 文件大小不能超过5GB（免费试用任务限制100MB）。

查看扫描结果 扫描任务执行后，可在二进制成分分析页面的任务列表查看当前任务状态。 单击对应任务的任务名称，也可以单击任务列表操作列的“查看报告”，查看扫描报告。扫描报告主要包括：任务概况、开源软件漏洞、开源许可证、密钥和信息泄露、安全编译选项、安全配置、恶意软件扫描。 图2 扫描报告 在扫描报告页面，单击右上角的“生成PDF报告”或“生成Excel报告”，可以生成更详细的扫描报告。 扫描报告生成完成后，单击右上角的“导出PDF”或“导出Excel”，可以下载扫描报告。 扫描报告主要内容如下：任务概览、结果概览、组件列表、漏洞列表、密钥和信息泄露问题列表、安全编译选项问题列表、安全配置列表、恶意软件扫描问题列表。

新建变更流水线 访问CodeArts Pipeline首页，进入项目下流水线。 单击“微服务”，进入微服务列表页面。 单击微服务名称，进入微服务“概览”页面。 单击“流水线”，进入微服务流水线列表页面。 单击“新建流水线”，进入“基本信息 ”页面，配置相关参数。 表3 新建流水线 参数项 说明 所属项目 微服务所在的项目。 名称 流水线的名称，默认根据当前时间生成。支持中文、大小写英文字母、数字、“-”、“_”，长度不超过128个字符。 代码源 代码仓库来源，微服务下流水线仅支持Repo。 代码仓 微服务关联的代码仓库。 说明： 修改微服务的代码仓库，微服务下所有流水线配置的代码仓库会自动更改。 默认分支 微服务关联的默认分支。 说明： 修改微服务的默认分支，微服务下所有流水线配置的默认分支会自动更改。 Repo HTTPS授权 配置授权扩展点以提升代码库操作权限，主要用于微服务变更流水线和部分仓库操作插件。单击“新建授权”，可添加CodeArts Repo HTTPS服务扩展点，配置方法请参考新建CodeArts服务扩展点。 说明： 新建CodeArts Repo HTTPS服务扩展点时，如果用户名密码填写错误，会授权失败并导致流水线执行失败。具体问题请参考常见问题。 别名 仓库别名。支持大小写英文字母、数字、“_”，长度不超过128个字符。 设置别名后可生成仓库对应的系统参数，如：“别名_REPOSITORY_NAME”，表示仓库名称。生成的参数可在参数设置页面查看，并在流水线中通过“${参数名}”进行引用。 基于变更触发 开启“基于变更触发”开关的流水线即为变更流水线，在微服务流水线列表中，变更流水线会被标识为。 说明： 单个微服务下仅允许存在一条基于变更触发的流水线。 描述 长度不超过1024个字符。 单击“下一步”，进入“选择模板”页面，根据需要选择对应模板，在模板基础上快速新建任务；也可以选择“空白模板”，即不使用模板，直接新建。 单击“确定”，根据需要编排流水线，然后单击“保存”。

执行变更流水线 访问CodeArts Pipeline首页，进入项目下流水线。 单击“微服务”，进入微服务列表页面。 单击微服务名称，进入微服务“概览”页面。 单击“流水线”，进入微服务流水线列表页面。 单击流水线名称，进入流水线“执行历史”页面。 单击右上角“执行”，弹出“执行配置”侧滑框，进行如下配置。 图2 配置变更流水线执行信息 变更列表：变更列表展示阶段状态为“待发布”和“发布中”的变更，运行变更流水线时需要选择一个或多个变更。 运行参数配置：如果流水线配置了运行时参数，请根据需要设置参数值并保存，可参考流水线参数应用示例。 执行阶段配置：流水线支持选择任务执行，可以选择一个或多个，默认执行全部任务。 执行描述：填写本次运行的调试信息。 配置完成后，单击“执行”，进入变更流水线执行详情页面。 图3 执行变更流水线 变更流水线运行时会默认添加“合并集成分支”和“合并主干”阶段。 合并集成分支：变更流水线会自动从主干分支拉出一条新分支，并将本次运行变更的所有特性分支集成到该新分支，然后通过这条集成分支来运行流水线。 合并主干：将集成分支合并回主干分支。 执行完成后，可查看流水线执行结果。 变更流水线执行成功时，会将本次运行选择的所有变更状态改为“已发布”状态。 单击流水线名称，进入“流水线详情”页面 单击流水线源卡片的“查看更多”，弹出运行变更侧滑框，展示本次流水线运行时选择的变更信息。 单击列表内“变更标题”可以跳转到变更详情页面。 单击“发布列表”页签，切换到“发布列表”页面 发布列表页面展示所有阶段状态为“待发布”和“发布中”的变更。 列表支持在搜索栏中输入变更名称关键字进行搜索。 单击“操作”列，弹出“退出发布”对话框，单击“确认”会将变更退出变更流水线的发布列表，变更状态重置为“开发中”。 阶段状态为“发布中”的变更，如果变更流水线正在运行，则需要等待变更流水线运行完成或停止变更流水线后才可以退出发布。

新建流水线微服务 访问CodeArts Pipeline首页，进入项目下流水线。 单击“微服务”，进入微服务列表页面。 单击“新建微服务”，进入“新建微服务”页面，配置相关参数。 表1 新建微服务 参数项 说明 所属项目 微服务所在项目，不可更改。 微服务名称 微服务的名称。支持大小写英文字母、数字、“_”，不超过128个字符。 代码源 代码仓库来源，当前仅支持Repo。 说明： 可暂不选择代码源，微服务创建成功后，可根据需要通过单击微服务名称，进入微服务概览页再进行关联。 代码仓 微服务关联的代码仓库，选择已创建的代码仓库。 说明： 一个代码仓只能关联一个微服务。 默认分支 微服务关联的默认分支，执行微服务流水线时默认使用的分支。 说明： 变更流水线执行完成后，所有变更特性分支都将会合入默认分支。 语言 微服务的开发语言，支持Java、Python、Node.js、Go、.Net、C++、PHP。 描述 长度不超过1024个字符。 单击“确定”，完成微服务创建并进入微服务“概览”页。 概览页展示微服务的创建人、创建时间、代码源等信息，可修改微服务开发语言、关联的代码仓库和描述信息。 更换代码仓库时，如果微服务下存在没有关闭的变更或运行中的流水线，页面会弹出“数据处理”侧滑框，需先关闭所有变更并停止所有运行中的流水线。 返回微服务列表，可以查看已创建的微服务，列表项说明如下。 表2 微服务列表 列表项 说明 微服务 微服务的名称。 创建人 创建微服务的用户名。 创建时间 创建微服务的时间，将鼠标悬浮至“创建时间”列，单击，可以根据创建时间排序微服务。 状态 展示微服务当前状态信息，创建后会自动处于激活状态。 操作 单击可收藏该微服务，收藏成功后图标变为，再次单击可取消收藏；单击，可删除该微服务。 说明： 删除微服务，微服务内所有变更记录和流水线都将会被删除，请谨慎操作。 微服务列表展示项目下的所有微服务。 支持在搜索栏中输入微服务名称关键字进行搜索。

流水线参数应用示例 本文以通过流水线统一配置releaseversion参数并传递到构建任务为例，介绍流水线参数使用方法。 新建构建任务。 在“参数设置”页面添加releaseversion参数并设置好默认值，打开“运行时设置”。 图3 新建构建任务参数 在“构建步骤”页面，选择“上传软件包到软件发布库”，将“发布版本号”配置成引用参数形式。在参数输入框输入“$”符号后会自动出现参数列表，选择上一步已经新建好的releaseversion参数。 图4 引用构建任务参数 使用“$”符号引用通用参数组的参数时不会自动生成提示。 配置完成后，保存构建任务。 新建空白模板流水线，在流水线阶段添加一个新的任务，然后在该任务中添加“Build构建”插件并调用刚创建的构建任务，即可看到刚新建好的构建任务参数releaseversion。 图5 配置构建任务参数 将鼠标移动到releaseversion参数上，可以一键将该参数设置为流水线参数并能直接引用该参数；或直接单击“确定”，然后切换到流水线“参数设置”页面，新建流水线参数releaseversion，类型可以根据需求选择自增长或字符串等，设置默认值并打开运行时设置。 图6 新建流水线参数 再切回到流水线“任务编排”页面，编辑刚添加的构建任务，将流水线的releaseversion参数通过“$”符号引用到构建任务的releaseversion参数内。 图7 引用流水线参数 该处只显示构建任务中开启“运行时设置”的文本类型参数。 鼠标移至参数名称，可以快速将该参数设置为流水线参数并能直接引用该参数。 完成参数引用后，保存信息，然后单击“保存并执行”，弹出“执行配置”侧滑框，可查看“运行参数配置”。 运行时参数值默认为添加参数时为参数设置的默认值，可根据需要进行修改。流水线运行时在构建任务内使用的就是此时输入的参数值。 设置完参数，单击“执行”，开始使用配置的参数执行流水线。

流水线系统预定义参数 表1 流水线系统预定义参数 参数信息 说明 TIMESTAMP 流水线执行时间戳。例如：20211222124301。 PIPELINE_TRIGGER_TYPE 流水线触发类型。包括：Manual、Scheduler、RollBack以及WebHook类型（CreateTag、Note、Issue、MR、Push）。 PIPELINE_NAME 流水线名称。 REPO_URL 代码仓地址（HTTPS）。 EXECUTE_USER 执行人。 PASS_CONDITIONS_LINK 流水线执行详情链接。 PIPELINE_RUN_ID 流水线执行ID。 MERGE_ID 合并请求ID。 WEBHOOK_PAYLOAD Webhook请求负载信息。 Repo01_REPOSITORY_NAME 仓库名称。 Repo01_SOURCE_BRANCH 仓库运行源分支名称。 Repo01_TARGET_BRANCH 仓库运行目标分支名称。 Repo01_TAG 仓库标签名称。 Repo01_COMMIT_ID 执行时代码最后一次提交的ID。 Repo01_COMMIT_ID_SHORT 执行时代码最后一次提交的短ID Repo01_REPO_URL 代码仓地址（HTTPS）。

配置流水线自定义参数 介绍流水线自定义参数新建和配置。 访问CodeArts Pipeline首页。 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。 进入流水线“任务编排”页面，切换至“参数设置”页面。 单击参数列表下的“立即新建”（已存在自定义参数，则单击“新建参数”），填写参数信息。 表2 流水线自定义参数说明 参数信息 说明 名称 自定义参数名称。支持大小写英文字母、数字、“_”，长度不超过128个字符。 说明： 自定义参数名称不可与系统预定义参数名称相同。 类型 参数可选类型：字符串（默认类型）、自增长、枚举。 默认值 自定义参数的默认取值。 字符串：长度不超过8192个字符。 自增长：长度不超过8192个字符。 说明： 自增长类型参数如果被引用，全新执行一次后，下次执行时参数值末位如果是数字则会自动+1。 枚举：仅支持中文、大小写英文字母、数字、“-”、“_”、“,”、“.”、“/”，长度不超过8192个字符。 选择枚举类型后，在弹出的对话框中添加可选取值，添加完成后在“默认值”下拉框中选择一个默认值，再次单击“枚举”类型，可修改可选取值。 私密参数 参数为私密参数时，系统会将输入参数做加密存储，使用时解密，同时在运行日志里不可见。 运行时设置 打开“运行时设置”开关，在执行流水线时支持修改该参数的值。 参数描述 不超过512个字符。 最多可以新建100个自定义参数。 单击“操作”列，可以新增参数；单击“操作”列，可以删除参数。 配置完成后，保存流水线。