You need to enable JavaScript to run this app.
文档中心
云服务器

云服务器

复制全文
下载 pdf
补丁管理
CreatePatchBaseline - 创建补丁基线
复制全文
下载 pdf
CreatePatchBaseline - 创建补丁基线
调用CreatePatchBaseline接口,创建一个补丁基线。​
使用说明​
  • 在同一补丁基线中,若某一补丁同时被纳入已批准和已拒绝补丁列表,则该补丁按已拒绝规则处理。​
  • 补丁例外规则优先级高于基线默认管控逻辑,无论基线默认规则如何定义,只要配置了对应的补丁例外,均以例外规则为准执行管控。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:CreatePatchBaseline​
要执行的操作,取值:CreatePatchBaseline。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
Name string 必选 示例值:UbuntuBaseline​
补丁基线名称。取值:​
  • 必须以字母、汉字开头。​
  • 只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。​
  • 长度限制为1 ~ 128个字符。​
说明​
建议采用能够清晰反映其用途的名称。​
​
Description string 可选 示例值:The description of baseline.​
补丁基线描述信息。​
  • 必须以字母、汉字开头。​
  • 只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“,”、中文句号“。”和空格。​
  • 长度限制为0~255个字符。​
说明​
不填默认为空。​
​
OperationSystem string 必选 示例值:Ubuntu​
操作系统类型。支持:​
  • Debian​
  • Ubuntu​
​
ApprovalRules object[] 必选 示例值:--​
补丁基线的安装规则,用于自动批准补丁。取值:​
  • 至少需要配置1个安装规则。​
  • 最多支持配置10个安装规则。​
EnableNonSecurity boolean 可选 示例值:true​
是否启用非安全补丁更新。取值:​
  • true:启用。​
  • false(默认):不启用。​
​
ComplianceLevel string 可选 示例值:CRITICAL​
被批准补丁的合规严重级别。取值:​
  • UNSPECIFIED(默认):为待判定的定级的临时等级。​
说明​
不填则默认返回UNSPECIFIED。​
  • CRITICAL:为最高合规风险等级。​
  • HIGH:为高优先级等级。​
  • MEDIUM:为常规整改优先级等级。​
  • LOW:为延后整改优先级等级。​
  • INFORMATIONAL:为非风险类补充标注等级。​
​
ApproveUntilDate string 可选 示例值:2020-04-01​
自动批准的截止日期,早于该日期发布的补丁将会自动批准。​
  • 格式: YYYY-MM-DD。​
  • 评估时间:截止日期基于UTC时间评估。例如,若设置为 2025-11-16,则所有在 2025-11-16T23:59:59Z 前发布且匹配规则的补丁均会被批准。​
说明​
  • ApproveAfterDays与ApproveUntilDate参数必须二选一。​
  • 不填则默认为空,即不执行审批操作。​
​
ApproveAfterDays integer 可选 示例值:10​
指定补丁发布后多少天自动批准。取值:​
  • 取值范围: 0~360天,例如取值为 7 ,则补丁在发布7天后自动批准。​
  • 评估时间: 补丁的发布日期基于UTC时间评估。​
说明​
  • ApproveAfterDays与ApproveUntilDate参数必须二选一。​
  • 不填则默认为空,即不执行审批操作。​
​
PatchFilterGroup object[] 必选 示例值:--​
补丁基线安装规则适用的补丁筛选条件组。​
Key string 必选 示例值:PRODUCT​
筛选维度(补丁属性键)。​
说明​
不同操作系统支持的Key不同。​
​
Values string[] 必选 示例值:Ubuntu24.04​
对应Key的匹配值。​
​
​
​
RejectedPatches string[] 可选 示例值:["example"]​
补丁基线中明确拒绝的补丁列表,为字符串数组类型,取值范围1~50个补丁。​
​
RejectedPatchesAction string 可选 示例值:BLOCK​
已拒绝补丁的操作,用于指定补丁被加入 RejectedPatches 列表时,系统的处理方式。取值:​
  • ALLOW_AS_DEPENDENCY(默认):若被拒绝的补丁包是其他必需包的依赖项,系统将允许安装该被拒绝补丁,以保证主软件包正常运行。此时,该补丁的合规状态为 INSTALLED_OTHER。​
  • BLOCK:严格禁止安装 RejectedPatches 列表中的任意补丁。若待安装补丁依赖于已拒绝补丁,则两个补丁均无法安装。​
  • 若该补丁在被拒绝前已安装,合规状态为 INSTALLED_REJECTED。​
  • 若安装过程中触发此规则,操作状态将为 FAILED。​
说明​
  • 本参数仅在配置RejectedPatches参数时生效,未配置则无效。​
  • 若已配置RejectedPatches参数,但未填写本参数,则默认返回ALLOW_AS_DEPENDENCY。​
​
ApprovedPatches string[] 可选 示例值:["example"]​
基线明确批准补丁列表(字符串数组),用于指定始终需要批准的补丁,即使不符合ApprovalRules 规则,也会被安装。​
取值范围:1~50个补丁。​
​
ApprovedPatchesEnableNonSecurity boolean 可选 示例值:true​
指定已批准补丁列表是否包含托管节点的非安全补丁更新。取值:​
  • true:除安全补丁外,ApprovedPatches 列表中的非安全更新也会被评估并安装。​
  • false(默认):仅评估并安装 ApprovedPatches 列表中与安全相关的更新。​
​
ClientToken string 可选 示例值:example​
保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。​
取值:仅支持ASCII字符,且不能超过64个字符。​
​
Sources object[] 可选 示例值:--​
补丁源,用于指定备用补丁源存储库,可指定内部YUM或APT仓库,更多请参见Source结构说明。​
Products string[] 必选 示例值:Ubuntu24.04​
补丁仓库所适用的操作系统版本,取值:​
  • Ubuntu:​
  • Ubuntu 24​
  • Ubuntu 22​
  • Ubuntu 20​
  • Ubuntu 18​
  • Ubuntu 16​
  • Debian​
  • Debian 12​
  • Debian 11​
  • Debian 10​
  • Debian 9​
  • Debian 8​
​
Name string 必选 示例值:UbunutuSource​
补丁源的指定名称。​
​
Configuration string 必选 示例值:deb http://security.ubuntu.com/ubuntu jammy main​
补丁源存储库配置的值。取值:​
  • 符合对应操作系统的软件源配置格式。​
  • 配置内容需包含合法的源地址、版本标识、组件类型等核心字段,无语法错误。​
  • 长度范围:1~1024个字符。​
​
​
ApprovedPatchesComplianceLevel string 可选 示例值:UNSPECIFIED​
定义已批准补丁的合规性级别,当已批准补丁被检测为缺失时,该值表示对应的合规性违规严重程度。取值:​
  • UNSPECIFIED(默认):为待定级别的临时等级。​
说明​
不填则默认返回UNSPECIFIED。​
  • CRITICAL:为最高合规风险等级。​
  • HIGH:为高优先级等级。​
  • MEDIUM:为常规整改优先级等级。​
  • LOW:为延后整改优先级等级。​
  • INFORMATIONAL:为非风险类补充标注等级。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
BaselineId string 示例值:bl-xffsafgewgdf****​
补丁基线ID。​
​
​
​
请求示例​
​
POST /?Version=2020-04-01&Action=CreatePatchBaseline HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
AccessKey: AK*****************​
SecretKey: TXpS***************​
ServiceName: ecs​
Region: cn-beijing​
X-Top-Account-Id: 21000*****​
Content-Type: application/json​
​
{​
"Name": "Ubuntu-Prod-Baseline",​
"Description": "Production Environment Ubuntu Base Line",​
"OperationSystem": "Ubuntu",​
"ApprovalRules": [​
{​
"PatchFilterGroup": [​
{ "Key": "PRODUCT", "Values": ["Ubuntu24.04"] },​
{ "Key": "CLASSIFICATION", "Values": ["Security"] }​
],​
"ComplianceLevel": "CRITICAL"​
}​
],​
"RejectedPatches": ["nginx"],​
"RejectedPatchesAction": "BLOCK",​
"ClientToken": "333456899ff****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230601100000000000000000****",​
"Action": "CreatePatchBaseline",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"BaselineId": "bl-533456899ff****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidArgument​
The specified argument is invalid.​
指定的参数不合法。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.03.03 16:14:47
这个页面对您有帮助吗?
有用
有用
无用
无用