将 Compute Engine 与 Google SecOps 集成
集成版本:13.0
本文档提供了有关如何将 Compute Engine 与 Google Security Operations (Google SecOps) 集成的指南。
使用场景
Compute Engine 集成可帮助您解决以下使用情形:
自动事件响应:使用 Google SecOps 功能,在检测到 Compute Engine 实例遭到入侵时,通过 playbook 自动将该实例与网络隔离。隔离实例可限制攻击的蔓延,并减少潜在的损害。自动突发事件响应有助于缩短突发事件响应时间,并减轻安全团队的工作负担。
威胁搜寻和调查:使用 Google SecOps 功能自动从多个项目的 Compute Engine 实例中收集日志和安全遥测数据。您可以分析收集的数据,找出可疑活动和潜在威胁,主动搜寻威胁,并通过自动收集数据来加快调查速度。
漏洞管理:将漏洞扫描工具与 Google SecOps 集成,以自动扫描 Compute Engine 实例是否存在已知漏洞。您可以利用 Google SecOps 功能自动生成补救工单,甚至直接修补漏洞,从而降低被利用的风险并提升组织的安全状况。
合规性自动化:使用 Google SecOps 功能自动从 Compute Engine 实例收集审核日志和配置数据,并遵守监管要求。您可以利用收集的数据为审核人员生成报告和信息中心,从而简化合规性报告流程,并减少分析数据所需的人工工作量。
安全编排:跨多个Google Cloud 服务(包括 Compute Engine)编排安全工作流。例如,Google SecOps 可以响应在 Compute Engine 实例上检测到的安全事件,触发新防火墙规则的创建。通过集成不同的安全工具和服务,安全编排可为您提供更加协调一致的自动化安全态势。
准备工作
如需使用此集成,您需要自定义 Identity and Access Management (IAM) 角色和 Google Cloud 服务账号。您可以使用现有服务账号,也可以创建新服务账号。
创建和配置 IAM 角色
如需为集成创建和配置自定义 IAM 角色,请完成以下步骤:
在 Google Cloud 控制台中,前往 IAM 角色页面。
点击创建角色,以创建具有集成所需权限的自定义角色。
对于新的自定义角色,请提供标题、说明和唯一的 ID。
将角色发布阶段设置为正式版。
向创建的角色添加以下权限:
compute.instances.list
compute.instances.start
compute.instances.stop
compute.instances.delete
compute.instances.setLabels
compute.instances.getIamPolicy
compute.instances.setIamPolicy
compute.instances.get
compute.zones.list
创建服务账号
如需有关创建服务账号的指南,请参阅创建服务账号。请务必在向此服务账号授予对项目的访问权限下,向该服务账号授予您的自定义 IAM 角色。
如果您使用服务账号向 Google Cloud进行身份验证,则可以创建 JSON 格式的服务账号密钥,并在配置集成参数时提供下载的 JSON 文件的内容。
出于安全考虑,我们建议您使用工作负载身份电子邮件地址,而不是服务账号密钥。如需详细了解工作负载身份,请参阅工作负载的身份。
集成参数
Compute Engine 集成需要以下参数:
参数 | 说明 |
---|---|
Account Type |
可选 Google Cloud 账号的类型。 提供服务账号密钥 JSON 文件中 默认值为 |
Project ID |
可选 相应 Google Cloud 账号的项目 ID。 提供服务账号密钥 JSON 文件中 |
Private Key ID |
可选 相应账号的私钥 ID。 Google Cloud 提供服务账号密钥 JSON 文件的 |
Private Key |
可选 Google Cloud账号的私钥。 提供服务账号密钥 JSON 文件中 |
Client Email |
可选 Google Cloud账号的客户电子邮件地址。 提供服务账号密钥 JSON 文件中 |
Client ID |
可选 Google Cloud 账号的客户端 ID。 提供服务账号密钥 JSON 文件中 |
Auth URI |
可选 Google Cloud账号的身份验证 URI。 提供服务账号密钥 JSON 文件中 默认值为 |
Token URI |
可选 Google Cloud账号的令牌 URI。 提供服务账号密钥 JSON 文件中 默认值为 |
Auth Provider X509 URL |
可选 Google Cloud 账号的身份验证提供方 X.509 网址。 提供服务账号密钥 JSON 文件的 默认值为 |
Client X509 URL |
可选 Google Cloud 账号的客户端 X.509 网址。 提供服务账号密钥 JSON 文件的 |
User Service Account JSON |
可选 服务账号密钥 JSON 文件的内容。 您可以配置此参数或 如需配置此参数,请提供您在创建服务账号时下载的服务账号密钥 JSON 文件的完整内容。 |
Workload Identity Email |
可选 您的工作负载身份联合的客户端电子邮件地址。 您可以配置此参数或 如需使用工作负载身份联合模拟服务账号,请向您的服务账号授予 |
如需了解如何在 Google SecOps 中配置集成,请参阅配置集成。
如果需要,您可以在稍后阶段进行更改。配置集成实例后,您可以在剧本中使用该实例。如需详细了解如何配置和支持多个实例,请参阅支持多个实例。
操作
如需详细了解操作,请参阅处理工作台中的待处理操作和执行手动操作。
向防火墙规则添加 IP
使用向防火墙规则添加 IP 操作来
此操作不适用于 Google SecOps 实体。
操作输入
向防火墙规则添加 IP 操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的完整资源名称,例如 此参数的优先级高于 |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未设置值,该操作会从集成配置中检索项目名称。 |
Firewall Rule |
可选 要更新的防火墙规则的名称。 |
Type |
必需 要添加的 IP 地址范围的类型。 可能的值包括 默认值为 |
IP Ranges |
必需 要添加到防火墙规则中的 IP 地址范围列表。 |
操作输出
将 IP 添加到防火墙规则操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 不可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
输出消息
将 IP 添加到防火墙规则操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "AAdd IP To Firewall Rule". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用向防火墙规则添加 IP 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
向实例添加标签
使用向实例添加标签操作向 Compute Engine 实例添加标签。
此操作不适用于 Google SecOps 实体。
操作输入
向实例添加标签操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance ID |
可选 要启动的实例的 ID。 您可以使用列出实例操作检索实例 ID。 |
Instance Labels |
必需 要添加到实例的实例标签。 如需配置此参数,请按以下格式设置值:
此参数接受多个值,这些值以英文逗号分隔的字符串形式表示。 |
操作输出
为实例添加标签操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例介绍了使用向实例添加标签操作时收到的 JSON 结果输出:
{
"id": "ID",
"name": "operation-OPERATION_ID",
"zone": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a",
"operationType": "setLabels",
"targetLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/instances/INSTANCE_ID",
"targetId": "INSTANCE_ID",
"status": "RUNNING",
"user": "user@example.com",
"progress": 0,
"insertTime": "2021-04-28T23:01:29.395-07:00",
"startTime": "2021-04-28T23:01:29.397-07:00",
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/operations/operation-OPERATION_ID",
"kind": "compute#operation"
}
输出消息
向实例添加标签操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Add Labels to Instance". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用为实例添加标签操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
添加网络标记
使用添加网络标记操作向 Compute Engine 实例添加网络标记。
此操作是异步的。根据需要,在 Google SecOps 集成开发环境 (IDE) 中调整操作的脚本超时值。
此操作不适用于 Google SecOps 实体。
操作输入
添加网络标记操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的完整资源名称,例如 此参数的优先级高于 |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未设置值,该操作会从集成配置中检索项目名称。 |
Instance Zone |
可选 Compute Engine 实例的可用区名称。 如果您使用 |
Instance ID |
可选 Compute Engine 实例 ID。 如果您使用 |
Network Tags |
必需 要添加到 Compute Engine 实例的网络标记的逗号分隔列表。 此参数仅接受包含小写字母、数字和连字符的标记。 |
操作输出
添加网络标记操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 不可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
输出消息
添加网络标记操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Add Network Tags". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用添加网络标记操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
删除实例
使用删除实例操作删除 Compute Engine 实例。
此操作不适用于 Google SecOps 实体。
操作输入
删除实例操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance ID |
可选 要启动的实例的 ID。 您可以使用列出实例操作检索实例 ID。 |
操作输出
删除实例操作会提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例描述了使用删除实例操作时收到的 JSON 结果输出:
{
"id": "ID",
"name": "operation-OPERATION_ID",
"zone": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a",
"operationType": "delete",
"targetLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/instances/INSTANCE_ID",
"targetId": "INSTANCE_ID",
"status": "RUNNING",
"user": "user@example.com",
"progress": 0,
"insertTime": "2021-04-28T23:01:29.395-07:00",
"startTime": "2021-04-28T23:01:29.397-07:00",
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/operations/operation-OPERATION_ID",
"kind": "compute#operation"
}
输出消息
删除实例操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
|
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用 Delete Instance 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
丰富实体
使用 Enrich Entities 操作,通过 Compute Engine 中的实例信息来丰富 Google SecOps IP Address
实体。
此操作不适用于 Google SecOps 实体。
操作输入
丰富实体操作需要以下参数:
参数 | 说明 |
---|---|
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
操作输出
丰富实体操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 可用 |
丰富化表 | 可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
“支持请求墙”表格
执行完毕后,“丰富实体”操作会提供以下表格:
表名称:ENTITY 扩充表
列:
- 实体字段
- 值
丰富化表
丰富实体操作支持以下实体丰富功能:
扩充项字段 | 来源(JSON 键) | 逻辑 |
---|---|---|
Google_Compute_instance_id |
id |
不可用 |
Google_Compute_creation_timestamp |
creationTimestamp |
不可用 |
Google_Compute_instance_name |
name |
不可用 |
Google_Compute_description |
description |
不可用 |
Google_Compute_tags |
tags |
以 CSV 列表形式提供标记 |
Google_Compute_machine_type |
machineType |
不可用 |
Google_Compute_instance_status |
status |
不可用 |
Google_Compute_instance_zone |
zone |
不可用 |
Google_Compute_can_ip_forward |
canIpForward |
不可用 |
Google_Compute_instance_network_interfaces_name_INDEX
|
networkInterfaces.name |
如果有更多可用的网络接口,则展开 |
Google_Compute_instance_network_interfaces_name_access_configs_type_INDEX |
networkInterfaces.accessConfigs.type |
如果有更多可用的网络接口,则展开 |
Google_Compute_instance_network_interfaces_name_access_configs_name_INDEX |
networkInterfaces.accessConfigs.name |
如果有更多可用的网络接口,则展开 |
Google_Compute_instance_network_interfaces_name_access_configs_natIP_INDEX |
networkInterfaces.accessConfigs.natIP |
如果有更多可用的网络接口,则展开 |
Google_Compute_instance_metadata |
metadata |
实例元数据中的值(以 CSV 格式列出) |
Google_Compute_service_account_INDEX
|
serviceAccounts.email |
如果还有更多服务账号可用,则展开 |
Google_Compute_service_account_scopes_INDEX
|
serviceAccounts.scopes |
如果还有更多服务账号可用,则展开 |
Google_Compute_link_to_Google_Compute |
selfLink |
不可用 |
Google_Compute_labels |
labels |
提供以 CSV 格式列出的值 |
Google_Compute_instance_last_start_timestamp |
lastStartTimestamp |
不可用 |
Google_Compute_instance_last_stop_timestamp |
lastStopTimestamp |
不可用 |
JSON 结果
以下示例介绍了使用丰富实体操作时收到的 JSON 结果输出:
{
"id": "ID",
"creationTimestamp": "2021-04-28T21:34:57.369-07:00",
"name": "instance-1",
"description": "",
"tags": {
"fingerprint": "VALUE"
},
"machineType": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/machineTypes/f1-micro",
"status": "RUNNING",
"zone": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a",
"canIpForward": false,
"networkInterfaces": [
{
"network": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/networks/default",
"subnetwork": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/regions/us-central1/subnetworks/default",
"networkIP": "203.0.113.2",
"name": "example",
"accessConfigs": [
{
"type": "ONE_TO_ONE_NAT",
"name": "External NAT",
"natIP": "198.51.100.59",
"networkTier": "PREMIUM",
"kind": "compute#accessConfig"
}
],
"fingerprint": "VALUE",
"kind": "compute#networkInterface"
}
],
"disks": [
{
"type": "PERSISTENT",
"mode": "READ_WRITE",
"source": "https://www.googleapis.com/compute/v1/PROJECT_ID/zones/us-central1-a/disks/instance-1",
"deviceName": "instance-1",
"index": 0,
"boot": true,
"autoDelete": true,
"licenses": [
"https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE"
],
"interface": "SCSI",
"guestOsFeatures": [
{
"type": "UEFI_COMPATIBLE"
},
{
"type": "VIRTIO_SCSI_MULTIQUEUE"
}
],
"diskSizeGb": "10",
"kind": "compute#attachedDisk"
}
],
"metadata": {
"fingerprint": "VALUE",
"kind": "compute#metadata"
},
"serviceAccounts": [
{
"email": "user@example.com",
"scopes": [
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/logging.write",
"https://www.googleapis.com/auth/monitoring.write",
"https://www.googleapis.com/auth/servicecontrol",
"https://www.googleapis.com/auth/service.management.readonly",
"https://www.googleapis.com/auth/trace.append"
]
}
],
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/instances/instance-1",
"scheduling": {
"onHostMaintenance": "MIGRATE",
"automaticRestart": true,
"preemptible": false
},
"cpuPlatform": "Intel Haswell",
"labels": {
"vm_test_tag": "tag1"
},
"labelFingerprint": "VALUE",
"startRestricted": false,
"deletionProtection": false,
"reservationAffinity": {
"consumeReservationType": "ANY_RESERVATION"
},
"displayDevice": {
"enableDisplay": false
},
"shieldedInstanceConfig": {
"enableSecureBoot": false,
"enableVtpm": true,
"enableIntegrityMonitoring": true
},
"shieldedInstanceIntegrityPolicy": {
"updateAutoLearnPolicy": true
},
"confidentialInstanceConfig": {
"enableConfidentialCompute": false
},
"fingerprint": "VALUE",
"lastStartTimestamp": "2021-04-28T21:35:07.865-07:00",
"kind": "compute#instance"
}
输出消息
丰富实体操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Enrich Entities". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用 Enrich Entities 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
执行虚拟机补丁作业
使用 Execute VM Patch Job 操作在 Compute Engine 实例上执行虚拟机补丁作业。
此操作是异步的。根据需要,在 Google SecOps 集成开发环境 (IDE) 中调整操作的脚本超时值。
此操作不适用于 Google SecOps 实体。
执行虚拟机补丁作业操作需要您启用 OS Config API。
操作输入
执行虚拟机补丁作业操作需要以下参数:
参数 | 说明 |
---|---|
Instance Filter Object |
必需 用于设置实例过滤条件的 JSON 对象。 默认值为: { "all": "true" } |
Name |
必需 修补作业的名称。 |
Description |
可选 修补作业的说明。 |
Patching Config Object |
可选 一个 JSON 对象,用于指定修补作业要执行的步骤。 如果您未设置值,该操作会使用默认值修补 Compute Engine 实例。如需配置此参数,请使用以下格式: 默认值为: { "rebootConfig": "DEFAULT", "apt": { "type": "DIST" }, "yum": { "security": true }, "zypper": { "withUpdate": true }, "windowsUpdate": { "classifications": ["CRITICAL", "SECURITY"] } } |
Patch Duration Timeout |
必需 修补作业的超时值(以分钟为单位)。 默认值为 |
Rollout Strategy |
可选 修补作业的发布策略。 可能的值包括 |
Disruption Budget |
必需 修补作业的中断预算。 如需配置此形参,您可以使用特定数字或百分比,例如 默认值为 |
Wait For Completion |
必需 如果选择此项,操作会等待修补作业完成。 |
Fail If Completed With Errors |
必需 如果选择此选项,并且修补作业状态为 |
操作输出
执行虚拟机补丁作业操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 不可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例展示了使用执行虚拟机补丁作业操作时收到的 JSON 结果输出:
{
"name": "projects/PROJECT_ID/patchJobs/JOB_ID",
"createTime": "2024-09-24T16:00:43.354907Z",
"updateTime": "2024-09-24T16:00:44.626050Z",
"state": "PATCHING",
"patchConfig": {
"rebootConfig": "DEFAULT",
"apt": {
"type": "UPGRADE"
},
"yum": {},
"zypper": {},
"windowsUpdate": {}
},
"duration": "3600s",
"instanceDetailsSummary": {
"startedInstanceCount": "1"
},
"percentComplete": 20,
"instanceFilter": {
"instances": [
"zones/us-central1-a/instances/INSTANCE_ID"
]
},
"displayName": "test",
"rollout": {
"mode": "ZONE_BY_ZONE",
"disruptionBudget": {
"percent": 25
}
}
}
输出消息
执行虚拟机补丁作业操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Execute VM Patch Job". Reason: ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用 Execute VM Patch Job 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
获取实例 IAM 政策
使用 Get Instance IAM Policy 操作可获取资源的访问权限控制政策。如果您最初未向资源分配任何政策,则返回的政策可能为空。
此操作不适用于 Google SecOps 实体。
操作输入
获取实例 IAM 政策 操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance ID |
可选 要启动的实例的 ID。 您可以使用列出实例操作检索实例 ID。 |
操作输出
获取实例 IAM 政策操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例介绍了使用获取实例 IAM 政策 操作时收到的 JSON 结果输出:
{
"version": 1,
"etag": "BwXBfsc47MI=",
"bindings": [
{
"role": "roles/compute.networkViewer_withcond_2f0c00",
"members": [
"user:user@example.com"
]
}
]
}
输出消息
获取实例 IAM 政策操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Get Instance IAM Policy". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用 Get Instance IAM Policy 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
列出实例
使用 List Instances 操作可根据指定的搜索条件列出 Compute Engine 实例。
此操作不适用于 Google SecOps 实体。
操作输入
列出实例操作需要以下参数:
参数 | 说明 |
---|---|
Project ID |
可选 要列出实例的项目的名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance Name |
可选 要搜索的实例名称。 此参数接受多个值,这些值以英文逗号分隔的字符串形式表示。 |
Instance Status |
可选 要搜索的实例状态。 此参数接受多个值,这些值以英文逗号分隔的字符串形式表示。 |
Instance Labels |
可选 要搜索的实例标签。 如需配置此参数,请按以下格式设置值: 此参数接受多个值,这些值以英文逗号分隔的字符串形式表示。 |
Max Rows to Return |
可选 单个操作运行要返回的实例数。 默认值为 50。 |
操作输出
列出实例操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
“支持请求墙”表格
列出实例操作提供以下表格:
表格名称:Google Cloud 计算实例
表列:
- 实例名称
- 实例 ID
- 实例创建时间
- 实例说明
- 实例类型
- 实例状态
- 实例标签
JSON 结果
以下示例介绍了使用列出实例操作时收到的 JSON 结果输出:
{ "id": "projects/PROJECT_ID/zones/us-central1-a/instances",
"items": [
{
"id": "ID",
"creationTimestamp": "2021-04-28T21:34:57.369-07:00",
"name": "instance-1",
"description": "",
"tags": {
"fingerprint": "VALUE"
},
"machineType": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/machineTypes/f1-micro",
"status": "RUNNING",
"zone": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a",
"canIpForward": false,
"networkInterfaces": [
{
"network": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/networks/default",
"subnetwork": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/regions/us-central1/subnetworks/default",
"networkIP": "192.0.2.2",
"name": "example",
"accessConfigs": [
{
"type": "ONE_TO_ONE_NAT",
"name": "External NAT",
"natIP": "203.0.113.59",
"networkTier": "PREMIUM",
"kind": "compute#accessConfig"
}
],
"fingerprint": "VALUE",
"kind": "compute#networkInterface"
}
],
"disks": [
{
"type": "PERSISTENT",
"mode": "READ_WRITE",
"source": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/disks/instance-1",
"deviceName": "instance-1",
"index": 0,
"boot": true,
"autoDelete": true,
"licenses": [
"https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE"
],
"interface": "SCSI",
"guestOsFeatures": [
{
"type": "UEFI_COMPATIBLE"
},
{
"type": "VIRTIO_SCSI_MULTIQUEUE"
}
],
"diskSizeGb": "10",
"kind": "compute#attachedDisk"
}
],
"metadata": {
"fingerprint": "VALUE",
"kind": "compute#metadata"
},
"serviceAccounts": [
{
"email": "user@example.com",
"scopes": [
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/logging.write",
"https://www.googleapis.com/auth/monitoring.write",
"https://www.googleapis.com/auth/servicecontrol",
"https://www.googleapis.com/auth/service.management.readonly",
"https://www.googleapis.com/auth/trace.append"
]
}
],
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_IDzones/us-central1-a/instances/instance-1",
"scheduling": {
"onHostMaintenance": "MIGRATE",
"automaticRestart": true,
"preemptible": false
},
"cpuPlatform": "Intel Haswell",
"labels": {
"vm_test_tag": "tag1"
},
"labelFingerprint": "VALUE",
"startRestricted": false,
"deletionProtection": false,
"reservationAffinity": {
"consumeReservationType": "ANY_RESERVATION"
},
"displayDevice": {
"enableDisplay": false
},
"shieldedInstanceConfig": {
"enableSecureBoot": false,
"enableVtpm": true,
"enableIntegrityMonitoring": true
},
"shieldedInstanceIntegrityPolicy": {
"updateAutoLearnPolicy": true
},
"confidentialInstanceConfig": {
"enableConfidentialCompute": false
},
"fingerprint": "VALUE",
"lastStartTimestamp": "2021-04-28T21:35:07.865-07:00",
"kind": "compute#instance"
}
]
}
输出消息
在案例墙上,列出实例操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "List Instances". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用列出实例操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
Ping
使用 Ping 操作测试与 Compute Engine 的连接。
此操作不适用于 Google SecOps 实体。
操作输入
无。
操作输出
Ping 操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 不可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
输出消息
在案例墙上,Ping 操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
Successfully connected to the Google Cloud Compute service with
the provided connection parameters! |
操作成功。 |
Failed to connect to the Google Cloud Compute service! Error is
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用 Ping 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
移除外部 IP 地址
使用移除外部 IP 地址操作可移除 Compute Engine 实例上的外部 IP 地址。
此操作是异步的。如有必要,请在 Google SecOps 集成开发环境 (IDE) 中调整脚本超时值。
此操作不适用于 Google SecOps 实体。
操作输入
移除外部 IP 地址操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance ID |
可选 要启动的实例的 ID。 您可以使用列出实例操作检索实例 ID。 |
Network Interface |
可选 要修改的网络接口的逗号分隔列表。如果您将此参数留空或提供 |
操作输出
移除外部 IP 地址操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例介绍了使用移除外部 IP 地址 操作时收到的 JSON 结果输出:
[
{
"endTime": "2024-05-21T04:28:05.371-07:00",
"id": "ID",
"insertTime": "2024-05-21T04:28:04.176-07:00",
"kind": "compute#operation",
"name": "operation-OPERATION_ID",
"operationType": "updateNetworkInterface",
"progress": 100,
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-west1-a/operations/operation-OPERATION_ID",
"startTime": "2024-05-21T04:28:04.190-07:00",
"status": "DONE",
"targetId": "TARGET_ID",
"targetLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-west1-a/instances/INSTANCE_ID",
"user": "user@example.com",
"zone": "us-west1-a",
"networkInterface": "example"
},
{
"endTime": "2024-05-21T04:28:06.549-07:00",
"id": "2531200345768541098",
"insertTime": "2024-05-21T04:28:05.419-07:00",
"kind": "compute#operation",
"name": "operation-OPERATION_ID",
"operationType": "deleteAccessConfig",
"progress": 100,
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-west1-a/operations/operation-OPERATION_ID",
"startTime": "2024-05-21T04:28:05.430-07:00",
"status": "DONE",
"targetId": "3905740668247239013",
"targetLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-west1-a/instances/INSTANCE_ID",
"user": "user@example.com",
"zone": "us-west1-a",
"networkInterface": "example"
}
]
输出消息
移除外部 IP 地址操作可能会返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
|
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用移除外部 IP 地址 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
从防火墙规则中移除 IP
使用 Remove IP From Firewall Rule 操作从 Compute Engine 实例中的防火墙规则中移除 IP 地址。
此操作是异步的。根据需要,在 Google SecOps 集成开发环境 (IDE) 中调整操作的脚本超时值。
此操作不适用于 Google SecOps 实体。
操作输入
从防火墙规则中移除 IP 操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的完整资源名称,例如 此参数的优先级高于 |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未设置值,该操作会从集成配置中检索项目名称。 |
Firewall Rule |
可选 要更新的防火墙规则的名称。 |
Type |
可选 要添加的 IP 地址范围的类型。 可能的值包括 默认值为 |
IP Ranges |
必需 要添加到防火墙规则中的 IP 地址范围列表。 |
操作输出
从防火墙规则中移除 IP 操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 不可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
输出消息
从防火墙规则中移除 IP 操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Remove IP From Firewall Rule". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用 Remove IP From Firewall Rule 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
移除影音平台标记
使用移除网络标记操作从 Compute Engine 实例中移除网络标记。
此操作是异步的。根据需要,在 Google SecOps 集成开发环境 (IDE) 中调整操作的脚本超时值。
此操作不适用于 Google SecOps 实体。
操作输入
移除网络标记操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的完整资源名称,例如 此参数的优先级高于 |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未设置值,该操作会从集成配置中检索项目名称。 |
Instance Zone |
可选 Compute Engine 实例的可用区名称。 如果您使用 |
Instance ID |
可选 Compute Engine 实例 ID。 如果您使用 |
Network Tags |
必需 要添加到 Compute Engine 实例的网络标记的逗号分隔列表。 此参数仅接受包含小写字母、数字和连字符的标记。 |
操作输出
移除网络标记操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 不可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
输出消息
移除网络标记操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Remove Network Tags". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用移除网络标记操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
设置实例 IAM 政策
使用 Set Instance IAM Policy 操作可为指定资源设置访问权限控制政策。您在操作中提供的政策会替换任何现有政策。
此操作不适用于 Google SecOps 实体。
操作输入
设置实例 IAM 政策 操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance ID |
可选 要启动的实例的 ID。 您可以使用列出实例操作检索实例 ID。 |
Policy |
必需 要为实例设置的 JSON 政策文档。 |
操作输出
设置实例 IAM 政策操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例介绍了使用设置实例 IAM 政策 操作时收到的 JSON 结果输出:
{
"version": 1,
"etag": "BwXBftu99FE=",
"bindings": [
{
"role": "roles/compute.networkViewer",
"members": [
"user:user@example.com"
]
}
]
}
输出消息
设置实例 IAM 政策操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Set Instance IAM Policy". Reason:
ERROR_REASON
|
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用设置实例 IAM 政策 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
启动实例
使用启动实例操作来启动之前已停止的 Compute Engine 实例。
实例不会立即开始运行。
此操作不适用于 Google SecOps 实体。
操作输入
启动实例操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance ID |
可选 要启动的实例的 ID。 您可以使用列出实例操作检索实例 ID。 |
操作输出
启动实例操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例介绍了使用启动实例操作时收到的 JSON 结果输出:
{
"id": "ID",
"name": "operation-OPERATION_ID",
"zone": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a",
"operationType": "start",
"targetLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/instances/INSTANCE_ID",
"targetId": "INSTANCE_ID",
"status": "DONE",
"user": "user@example.com",
"progress": 100,
"insertTime": "2021-04-28T23:01:29.395-07:00",
"startTime": "2021-04-28T23:01:29.397-07:00",
"endTime": "2021-04-28T23:01:29.397-07:00",
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/operations/operation-OPERATION_ID",
"kind": "compute#operation"
}
输出消息
启动实例操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
|
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用 Start Instance 操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
停止实例
使用停止实例操作停止正在运行的 Compute Engine 实例。您可以稍后重启实例。
虚拟机使用费不适用于已停止的实例。不过,除非您删除虚拟机正在使用的资源(例如永久性磁盘和静态 IP 地址),否则这些资源会产生费用。
此操作不适用于 Google SecOps 实体。
操作输入
停止实例操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Instance Zone |
可选 要搜索实例的实例可用区名称。 |
Instance ID |
可选 要启动的实例的 ID。 您可以使用列出实例操作检索实例 ID。 |
操作输出
停止实例操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例介绍了使用停止实例操作时收到的 JSON 结果输出:
{
"id": "ID",
"name": "operation-OPERATION_ID",
"zone": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a",
"operationType": "stop",
"targetLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/instances/INSTANCE_ID",
"targetId": "INSTANCE_ID",
"status": "RUNNING",
"user": "user@example.com",
"progress": 100,
"insertTime": "2021-04-28T23:01:29.395-07:00",
"startTime": "2021-04-28T23:01:29.397-07:00",
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/us-central1-a/operations/operation-OPERATION_ID",
"kind": "compute#operation"
}
输出消息
停止实例操作可能会返回以下输出消息:
输出消息 | 消息说明 |
---|---|
|
操作成功。 |
Error executing action "Stop Instance". Reason:
ERROR_REASON |
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用停止实例操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
更新防火墙规则
使用 Update Firewall Rule 操作,以在 Compute Engine 中使用提供的参数更新防火墙规则。
此操作是异步的。如有必要,请在 Google SecOps 集成开发环境 (IDE) 中调整脚本超时值。
此操作不适用于 Google SecOps 实体。
操作输入
更新防火墙规则操作需要以下参数:
参数 | 说明 |
---|---|
Resource Name |
可选 Compute Engine 实例的资源名称。 此参数的优先级高于 请按以下格式提供参数值: |
Project ID |
可选 Compute Engine 实例的项目名称。 如果您未为此参数设置值,集成会从您的 Google Cloud 服务账号中检索项目 ID。 |
Firewall Rule |
可选 要更新的防火墙规则名称。 |
Source IP Ranges |
可选 以英文逗号分隔的来源 IP 地址范围列表。此参数支持 如果您提供 |
Source Tags |
可选 以英文逗号分隔的来源标记列表。此参数支持 如果您提供 |
Source Service Accounts |
可选 以英文逗号分隔的来源服务账号列表。
此参数支持 如果您提供 |
TCP Ports |
可选 以英文逗号分隔的 TCP 端口列表。如果您配置此参数,操作会使用该参数值来更新和确定许可名单和拒绝名单。 此参数支持 |
UDP Ports |
可选 以英文逗号分隔的 UDP 端口列表。如果您配置此参数,操作会使用该参数值来更新和确定许可名单和拒绝名单。 此参数支持 |
Other Protocols |
可选 以英文逗号分隔的其他协议列表。 此参数支持 |
Destination IP Ranges |
可选 以英文逗号分隔的目标 IP 地址范围列表。 此参数支持 如果您设置了 |
操作输出
更新防火墙规则操作提供以下输出:
操作输出类型 | 可用性 |
---|---|
案例墙附件 | 不可用 |
案例墙链接 | 不可用 |
“支持请求墙”表格 | 不可用 |
丰富化表 | 不可用 |
JSON 结果 | 可用 |
输出消息 | 可用 |
脚本结果 | 可用 |
JSON 结果
以下示例描述了使用更新防火墙规则操作时收到的 JSON 结果输出:
{
"endTime": "2024-05-20T09:42:09.381-07:00",
"id": "ID",
"insertTime": "2024-05-20T09:42:05.150-07:00",
"kind": "compute#operation",
"name": "operation-OPERATION_ID",
"operationType": "patch",
"progress": 100,
"selfLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/operations/operation-OPERATION_ID",
"startTime": "2024-05-20T09:42:05.164-07:00",
"status": "DONE",
"targetId": "7886634413370691799",
"targetLink": "https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/firewalls/default-allow-rdp",
"user": "user@example.com"
}
输出消息
更新防火墙规则操作可以返回以下输出消息:
输出消息 | 消息说明 |
---|---|
Successfully updated firewall rule in Cloud Compute.
|
操作成功。 |
Error executing action "Update Firewall Rule". Reason:
ERROR_REASON
|
操作失败。 检查与服务器的连接、输入参数或凭据。 |
脚本结果
下表列出了使用更新防火墙规则操作时脚本结果输出的值:
脚本结果名称 | 值 |
---|---|
is_success |
True 或 False |
需要更多帮助?从社区成员和 Google SecOps 专业人士那里获得解答。