文档首页/ 安全云脑 SecMaster/ 用户指南/ 安全编排/ 系统内置流程插件说明/ OBS
更新时间：2026-06-29 GMT+08:00
查看PDF
分享

OBS

功能说明

安全云脑系统内置插件，可调用 OBS（对象存储服务）云服务接口执行操作。

系统内置插件均已存在对应内置的操作连接。

查看OBS插件详情和操作连接

  1. 登录安全云脑 SecMaster控制台。
  2. 单击管理控制台左上角的，选择区域和项目。
  3. 在左侧导航栏选择“工作空间 > 空间管理”，并在工作空间列表中，单击目标工作空间名称，进入目标工作空间管理页面。

    图1 进入目标工作空间管理页面

  4. 在左侧导航栏选择“安全编排 > 插件管理”，进入插件管理页面。

    图2 插件管理页面

  5. 在插件管理页面，选择华为云目录下的OBS，默认进入插件“详情”页签。详情页签展示插件已关联操作连接的登录凭证信息。
  6. 单击OBS插件的“操作连接”页签，进入操作连接页面，可查看插件已关联的操作连接信息。
  7. 若用户需编辑或删除操作连接，可参见编辑操作连接、删除操作连接。新增插件操作连接可参见新增操作连接，一个插件可存在多个操作连接。

插件执行函数appendObject说明

函数appendObject参数说明

函数功能：向OBS桶中的对象追加内容。如果对象不存在则创建新对象；如果对象存在且大小超过50MB则拒绝操作；如果超过20MB则会记录警告。

表1 函数appendObject入参说明

参数名称

参数类型

参数描述

是否必填

bucketName

String

OBS桶名称

是

obsKey

String

对象键名（文件路径），如果对象不存在则创建新对象

是

content

String

要追加的内容，如果对象大小超过50MB则拒绝操作，超过20MB会记录警告

是
表2 函数appendObject出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数appendObject输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "status": "success",
    "resMsg": "Append successful",
    "nextPosition": 1024
  }
}

插件执行函数getBucketAcl说明

函数getBucketAcl参数说明

函数功能：获取指定OBS桶的ACL（访问控制列表）配置。

表3 函数getBucketAcl入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

String

OBS桶名称

是
表4 函数getBucketAcl出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketAcl输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "status": "success",
    "resp": {
      "owner": {
        "id": "owner-id"
      },
      "accessControlList": [
        {
          "grantee": {
            "type": "CanonicalUser",
            "id": "user-id"
          },
          "permission": "FULL_CONTROL"
        }
      ]
    }
  }
}

插件执行函数getBucketCustomdomain说明

函数getBucketCustomdomain参数说明

函数功能：获取指定OBS桶绑定的自定义域名配置。

表5 函数getBucketCustomdomain入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

String

OBS桶名称

是

customdomain

String

查询参数标识

是
表6 函数getBucketCustomdomain出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketCustomdomain输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "domains": [
      {
        "domainName": "www.example.com",
        "createTime": "2026-05-25T09:10:00Z"
      }
    ]
  }
}

插件执行函数getBucketEncryption说明

函数getBucketEncryption参数说明

函数功能：获取指定OBS桶的服务端加密配置。

表7 函数getBucketEncryption入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

string

OBS 桶名称

是

encryption

string

加密配置标识

是
表8 函数getBucketEncryption出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketEncryption输出示例

{
  "code": 200,
  "body": {
    "encryption_configuration": {
      "rule": {
        "sse_algorithm": "AES256"
      }
    }
  }
}

插件执行函数getBucketLifecycle说明

函数getBucketLifecycle参数说明

函数功能：获取指定OBS桶的生命周期规则配置。

表9 函数getBucketLifecycle入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

String

OBS桶名称

是
表10 函数getBucketLifecycle出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketLifecycle输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "lifecycleConfiguration": {
      "rule": [
        {
          "id": "rule-1",
          "prefix": "logs/",
          "status": "Enabled",
          "expiration": {
            "days": 30
          }
        }
      ]
    }
  }
}

插件执行函数getBucketLogging说明

函数getBucketLogging参数说明

函数功能：获取指定OBS桶的日志配置。

表11 函数getBucketLogging入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

string

OBS 桶名称

是
表12 函数getBucketLogging出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketLogging输出示例

{
  "result": {
    "status": "success",
    "resp": {
      "target_bucket": "log-bucket"
    }
  }
}

插件执行函数getBucketObjectLockConfiguration说明

函数getBucketObjectLockConfiguration参数说明

函数功能：获取指定OBS桶的对象锁定配置。

表13 函数getBucketObjectLockConfiguration入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

string

OBS 桶名称

是

object_lock

string

对象锁定标识

是
表14 函数getBucketObjectLockConfiguration出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketObjectLockConfiguration输出示例

{
  "code": 200,
  "body": {
    "object_lock_configuration": {
      "status": "Enabled"
    }
  }
}

插件执行函数getBucketPolicy说明

函数getBucketPolicy参数说明

函数功能：获取指定OBS桶的桶策略配置。

表15 函数getBucketPolicy入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

string

OBS 桶名称

是

resultVariable

Object

出参过滤参数，{"新的字段名称1"："$(代表原全量返回参数).xxx(全量返回参数的下一级)或{xxx1，xxx2}",{"新的字段名称2"：...}...},例：{"alert_id"："$.body.data.id"} 或者{"alert"："$.body.data{id,name}"}

否
表16 函数getBucketPolicy出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketPolicy输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "policy": "{\"Version\":\"2012-10-17\",\"Statement\":[...]}"
  }
}

插件执行函数getBucketReplication说明

函数getBucketReplication参数说明

函数功能：获取指定OBS桶的跨区域复制配置。

表17 函数getBucketReplication入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

string

OBS 桶名称

是

replication

string

复制配置标识

是
表18 函数getBucketReplication出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketReplication输出示例

{
  "code": 200,
  "body": {
    "replication_configuration": {
      "rules": []
    }
  }
}

插件执行函数getBucketVersioning说明

函数getBucketVersioning参数说明

函数功能：获取指定OBS桶的版本控制状态。

表19 函数getBucketVersioning入参说明

参数名称

参数类型

参数描述

是否必填

bucket_name

string

OBS桶名称

是
表20 函数getBucketVersioning出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getBucketVersioning输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "status": "success",
    "versioning": "Enabled"
  }
}

插件执行函数getObject说明

函数getObject参数说明

函数功能：从OBS桶中下载并读取对象内容。

表21 函数getObject入参说明

参数名称

参数类型

参数描述

是否必填

bucketName

String

OBS桶名称

是

obsKey

String

对象键名，即要读取的对象名称

是

contentType

String

返回的文件内容类型，可选值：str（字符串）/list（列表）

是
表22 函数getObject出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数getObject输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "fileContent": "This is the file content",
    "contentType": "str",
    "size": 1024
  }
}

插件执行函数listBuckets说明

函数listBuckets参数说明

函数功能：列出当前账户下的所有OBS桶。

表23 函数listBuckets入参说明

参数名称

参数类型

参数描述

是否必填

isQueryLocation

Boolean

是否同时查询桶的区域位置，true表示查询，false表示不查询

否
表24 函数listBuckets出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listBuckets输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "buckets": [
      {
        "name": "test-bucket",
        "location": "cn-north-4",
        "creation_date": "2026-05-25T09:10:00Z"
      }
    ]
  }
}

插件执行函数listObjects说明

函数listObjects参数说明

函数功能：列出指定OBS桶中的对象。

表25 函数listObjects入参说明

参数名称

参数类型

参数描述

是否必填

bucketName

String

OBS桶名称

是

prefix

String

对象前缀，用于筛选指定前缀的对象列表

否

mark

String

获取标记，默认为空，从该标识符以后按字典顺序返回对象列表

否

maxNum

Integer

单次获取的最大数量，默认1000，最大获取数1000

否
表26 函数listObjects出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listObjects输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "mark": "null",
    "object_list": [
      {
        "object_name": "test.txt",
        "size": 1024,
        "last_modified": "2026-05-25T09:10:00Z"
      }
    ]
  }
}

插件执行函数uploadObject说明

函数uploadObject参数说明

函数功能：将内容上传到指定的OBS桶中。

表27 函数uploadObject入参说明

参数名称

参数类型

参数描述

是否必填

bucketName

String

OBS桶名称，用于存储对象的容器

是

obsKey

String

对象键名，即对象在桶中的唯一标识，可以是文件路径

是

content

String

上传文件的内容，可以是字符串形式的数据

是
表28 函数uploadObject出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数uploadObject输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "obs-server",
    "x-obs-request-id": "0000016A0000016A0000016A0000016A",
    "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABAAAQAAEAABA",
    "Connection": "keep-alive",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "status": "success",
    "resMsg": "Upload successful",
    "etag": "d41d8cd98f00b204e9800998ecf8427e"
  }
}

相关文档