华为云用户手册

示例 创建一个角色role1： 1 CREATE ROLE role1 IDENTIFIED BY '{Password}'; 为用户role1创建一个同名schema，子命令创建的表films和winners的拥有者为role1： 1 2 3 4 CREATE SCHEMA AUTHORIZATION role1 CREATE TABLE films (title text, release date, awards text[]) CREATE VIEW winners AS SELECT title, release FROM films WHERE awards IS NOT NULL;

语法格式 1 2 3 4 ALTER DEFAULT PRIVILEGES [ FOR { ROLE | USER } target_role [, ...] ] [ IN SCHEMA schema_name [, ...] ] abbreviated_grant_or_revoke; 其中abbreviated_grant_or_revoke子句用于指定对哪些对象进行授权或回收权限。 1 2 3 4 5 6 7 8 grant_on_tables_clause | grant_on_functions_clause | grant_on_types_clause | grant_on_sequences_clause | revoke_on_tables_clause | revoke_on_functions_clause | revoke_on_types_clause | revoke_on_sequences_clause 其中grant_on_tables_clause子句用于对表授权。 1 2 3 4 5 GRANT { { SELECT | INSERT | UPDATE | DELETE | TRUNCATE | REFEREN CES | TRIGGER | ANALYZE | ANALYSE | VACUUM | ALTER | DROP } [, ...] | ALL [ PRIVILEGES ] } ON TABLES TO { [ GROUP ] role_name | PUBLIC } [, ...] [ WITH GRANT OPTION ] 其中grant_on_functions_clause子句用于对函数授权。 1 2 3 4 GRANT { EXECUTE | ALL [ PRIVILEGES ] } ON FUNCTIONS TO { [ GROUP ] role_name | PUBLIC } [, ...] [ WITH GRANT OPTION ] 其中grant_on_types_clause子句用于对类型授权。 1 2 3 4 GRANT { USAGE | ALL [ PRIVILEGES ] } ON TYPES TO { [ GROUP ] role_name | PUBLIC } [, ...] [ WITH GRANT OPTION ] 其中grant_on_sequences_clause子句用于对序列授权。 1 2 3 4 5 GRANT { { USAGE | SELECT | UPDATE } [, ...] | ALL [ PRIVILEGES ] } ON SEQUENCES TO { [ GROUP ] role_name | PUBLIC } [, ...] [ WITH GRANT OPTION ] 其中revoke_on_tables_clause子句用于回收表对象的权限。 1 2 3 4 5 6 REVOKE [ GRANT OPTION FOR ] { { SELECT | INSERT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER | ANALYZE | ANALYSE | VACUUM | ALTER | DROP } [, ...] | ALL [ PRIVILEGES ] } ON TABLES FROM { [ GROUP ] role_name | PUBLIC } [, ...] [ CASCADE | RESTRICT | CASCADE CONSTRAINTS ] 其中revoke_on_functions_clause子句用于回收函数的权限。 1 2 3 4 5 REVOKE [ GRANT OPTION FOR ] { EXECUTE | ALL [ PRIVILEGES ] } ON FUNCTIONS FROM { [ GROUP ] role_name | PUBLIC } [, ...] [ CASCADE | RESTRICT | CASCADE CONSTRAINTS ] 其中revoke_on_types_clause子句用于回收类型的权限。 1 2 3 4 5 REVOKE [ GRANT OPTION FOR ] { USAGE | ALL [ PRIVILEGES ] } ON TYPES FROM { [ GROUP ] role_name | PUBLIC } [, ...] [ CASCADE | RESTRICT | CASCADE CONSTRAINTS ] 其中revoke_on_sequences_clause子句用于回收序列的权限。 1 2 3 4 5 6 REVOKE [ GRANT OPTION FOR ] { { USAGE | SELECT | UPDATE } [, ...] | ALL [ PRIVILEGES ] } ON SEQUENCES FROM { [ GROUP ] role_name | PUBLIC } [, ...] [ CASCADE | RESTRICT | CASCADE CONSTRAINTS ]

参数说明 target_role 已有角色的名称。如果省略FOR ROLE/USER，则缺省值为当前角色/用户。 target_role必须有schema_name的CREATE权限。查看角色/用户是否具有schema的CREATE权限可使用has_schema_privilege函数。 1 SELECT a.rolname, n.nspname FROM pg_authid as a, pg_namespace as n WHERE has_schema_privilege(a.oid, n.oid, 'CREATE'); 取值范围：已有角色的名称。 schema_name 现有模式的名称。如果指定了模式名，那么之后在这个模式下面创建的所有对象默认的权限都会被修改。如果IN SCHEMA被省略，那么全局权限会被修改。 取值范围：现有模式的名称。 role_name 被授予或者取消权限角色的名称。 取值范围：已存在的角色名称。 如果想删除一个被赋予了默认权限的角色，有必要恢复改变的缺省权限或者使用DROP OWNED BY来为角色脱离缺省的权限记录。

示例 将创建在模式tpcds里的所有表（和视图）的SELECT权限授予每一个用户： 1 ALTER DEFAULT PRIVILEGES IN SCHEMA tpcds GRANT SELECT ON TABLES TO PUBLIC; 将tpcds下的所有表的插入权限授予用户jack： 1 ALTER DEFAULT PRIVILEGES IN SCHEMA tpcds GRANT INSERT ON TABLES TO jack; 撤销上述权限： 1 2 ALTER DEFAULT PRIVILEGES IN SCHEMA tpcds REVOKE SELECT ON TABLES FROM PUBLIC; ALTER DEFAULT PRIVILEGES IN SCHEMA tpcds REVOKE INSERT ON TABLES FROM jack; 假设有两个用户test1、test2，如果想要test2用户对test1用户未来创建的表都有查询权限可以用如下操作： 首先，把test1的schema的权限赋权给test2用户： 1 GRANT usage, create ON SCHEMA test1 TO test2; 其次，把test1用户下的表的查询权限赋值给test2用户： 1 ALTER DEFAULT PRIVILEGES FOR USER test1 IN SCHEMA test1 GRANT SELECT ON tables TO test2; 然后，test1用户创建表： 1 2 SET ROLE test1 password '{Password}'; CREATE TABLE test3( a int, b int); 最后，用test2用户去查询： 1 2 3 4 5 SET ROLE test2 password '{Password}'; SELECT * FROM test1.test3; a | b ---+--- (0 rows)

注意事项 当前会话的用户必须是指定的rolename角色的成员，但系统管理员可以选择任何角色。 使用SET ROLE命令，可能会增加一个用户的权限，也可能会限制一个用户的权限。如果会话用户的角色有INHERITS属性，则自动拥有可以SET ROLE变成的角色的所有权限；在这种情况下，SET ROLE实际上是删除了所有直接赋予会话用户的权限，以及它的所属角色的权限，只剩下指定角色的权限。另一方面，如果会话用户的角色有NOINHERITS属性，SET ROLE删除直接赋予会话用户的权限，而获取指定角色的权限。

注意事项 进行MERGE INTO操作的用户需要同时拥有目标表的UPDATE和INSERT权限，以及源表的SELECT权限。 不支持PREPARE。 不支持重分布过程中MERGE INTO。 不支持对包含触发器的目标表执行MERGE INTO。 对roundrobin表执行MERGE INTO时，推荐关闭GUC参数allow_concurrent_tuple_update，否则会不支持部分MERGE INTO语句。

示例 创建目标表products和源表newproducts，并插入数据： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 CREATE TABLE products ( product_id INTEGER, product_name VARCHAR2(60), category VARCHAR2(60) ); INSERT INTO products VALUES (1501, 'vivitar 35mm', 'electrncs'); INSERT INTO products VALUES (1502, 'olympus is50', 'electrncs'); INSERT INTO products VALUES (1600, 'play gym', 'toys'); INSERT INTO products VALUES (1601, 'lamaze', 'toys'); INSERT INTO products VALUES (1666, 'harry potter', 'dvd'); CREATE TABLE newproducts ( product_id INTEGER, product_name VARCHAR2(60), category VARCHAR2(60) ); INSERT INTO newproducts VALUES (1502, 'olympus camera', 'electrncs'); INSERT INTO newproducts VALUES (1601, 'lamaze', 'toys'); INSERT INTO newproducts VALUES (1666, 'harry potter', 'toys'); INSERT INTO newproducts VALUES (1700, 'wait interface', 'books'); 进行MERGE INTO操作： 1 2 3 4 5 6 7 MERGE INTO products p USING newproducts np ON (p.product_id = np.product_id) WHEN MATCHED THEN UPDATE SET p.product_name = np.product_name, p.category = np.category WHERE p.product_name != 'play gym' WHEN NOT MATCHED THEN INSERT VALUES (np.product_id, np.product_name, np.category) WHERE np.category = 'books'; 查询更新后的结果： 1 2 3 4 5 6 7 8 9 10 SELECT * FROM products ORDER BY product_id; product_id | product_name | category ------------+----------------+----------- 1501 | vivitar 35mm | electrncs 1502 | olympus camera | electrncs 1600 | play gym | toys 1601 | lamaze | toys 1666 | harry potter | toys 1700 | wait interface | books (6 rows) 删除表： 1 2 DROP TABLE products; DROP TABLE newproducts;

语法格式 1 2 3 4 5 6 7 8 9 10 11 12 13 14 MERGE INTO table_name [ [ AS ] alias ] USING { { table_name | view_name } | subquery } [ [ AS ] alias ] ON ( condition ) [ WHEN MATCHED THEN UPDATE SET { column_name = { expression | DEFAULT } | ( column_name [, ...] ) = ( { expression | DEFAULT } [, ...] ) } [, ...] [ WHERE condition ] ] [ WHEN NOT MATCHED THEN INSERT { DEFAULT VALUES | [ ( column_name [, ...] ) ] VALUES ( { expression | DEFAULT } [, ...] ) [, ...] [ WHERE condition ] } ];

参数说明 INTO子句 指定正在更新或插入的目标表。 table_name 目标表的表名。 alias 目标表的别名。 取值范围：字符串，符合标识符命名规范。 USING子句 指定源表，源表可以为表、视图或子查询。 ON子句 关联条件，用于指定目标表和源表的关联条件。不支持更新关联条件中的字段。 WHEN MATCHED子句 当源表和目标表中数据针对关联条件可以匹配上时，选择WHEN MATCHED子句进行UPDATE操作。 不支持更新分布列。不支持更新系统表、系统列。 WHEN NOT MATCHED子句 当源表和目标表中数据针对关联条件无法匹配时，选择WHEN NOT MATCHED子句进行INSERT操作。 不支持INSERT子句中包含多个VALUES。 WHEN MATCHED和WHEN NOT MATCHED子句顺序可以交换，可以缺省其中一个，但不能同时缺省，不支持同时指定两个WHEN MATCHED或WHEN NOT MATCHED子句。 DEFAULT 用对应字段的缺省值填充该字段。 如果没有缺省值，则为NULL。 WHERE condition UPDATE子句和INSERT子句的条件，只有在条件满足时才进行更新操作，可缺省。不支持WHERE条件中引用系统列。

检查账户是否欠费 登录华为云费用中心。 在“总览”页面查看可用额度。 若账户处于欠款状态，则请先单击“充值”完成充值，或者购买点播CDN流量套餐包。 在“资源包”页面，查看转码套餐包是否有余额。 若账户处于欠款状态，但转码套餐仍有余额，可能是使用的转码模板是与购买的转码套餐包不一致，需要直接从账户余额扣费，从而导致欠费。建议先在欠费核销，然后使用与购买套餐包规格一致的转码模板进行转码。 重新登录 视频点播 控制台，在左侧导航树中选择“音视频管理”，勾选音视频文件，重新进行转码。

查看关键操作列表 通过 云审计 服务，您可以记录与API网关相关的操作事件，便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup 修改API分组 ApiGroup updateApiGroup 删除API分组 ApiGroup deleteApiGroup 校验API分组名称是否存在 Swagger CheckApiGroups 创建环境 Environment createEnvironment 修改环境 Environment updateEnvironment 删除环境 Environment deleteEnvironment 新建变量 EnvVariable CreateEnvironmentVariable 删除变量 EnvVariable DeleteEnvironmentVariable 修改变量 EnvVariable UpdateEnvironmentVariable 创建流控策略 Throttle CreateRequestThrottlingPolicy 修改流控策略 Throttle UpdateRequestThrottlingPolicy 删除流控策略 Throttle DeleteRequestThrottlingPolicy 创建API Api CreateApi 修改API Api UpdateApi 删除API Api DeleteApi 发布或下线API Api CreateOrDeletePublishRecordForApi 校验API定义 Api CheckApis 调试API Api DebugApi 批量发布/下线API Api BatchPublishOrOfflineApi 切换API版本 Api ChangeApiVersion 根据版本号下线API Api DeleteApiByVersionId 创建签名密钥 Signature CreateSignatureKey 修改签名密钥 Signature UpdateSignatureKey 删除签名密钥 Signature DeleteSignatureKey 绑定签名密钥 SignatureBinding AssociateSignatureKey 解除API与签名密钥的绑定关系 SignatureBinding DisassociateSignatureKey 绑定流控策略 ThrottleBinding AssociateRequestThrottlingPolicy 解除API与流控策略的绑定关系 ThrottleBinding DisassociateRequestThrottlingPolicy 批量解绑流控策略 ThrottleBinding BatchDisassociateThrottlingPolicy 创建特殊设置 ThrottleSpecial CreateSpecialThrottlingConfiguration 修改特殊流控 ThrottleSpecial UpdateSpecialThrottlingConfiguration 删除特殊流控 ThrottleSpecial DeleteSpecialThrottlingConfiguration APP授权 AppAuth CreateAuthorizingApps 解除授权 AppAuth CancelingAuthorization 绑定域名 ApiGroup AssociateDomain 绑定域名证书 ApiGroup AssociateCertificate 修改域名 ApiGroup UpdateDomain 解绑域名 ApiGroup DisassociateDomain 删除域名证书 ApiGroup DisassociateCertificate 创建ACL策略 Acl CreateAclStrategy 修改ACL策略 Acl UpdateAclStrategy 删除ACL策略 Acl DeleteAcl 批量删除ACL策略 Acl BatchDeleteAclV2 将API与ACL策略进行绑定 AclBinding CreateApiAclBinding 解除API与ACL策略的绑定 AclBinding DeleteApiAclBinding 批量解除API与ACL策略的绑定 AclBinding BatchDeleteApiAclBinding 创建自定义认证 Authorizer CreateCustomAuthorizer 修改自定义认证 Authorizer UpdateCustomAuthorizer 删除自定义认证 Authorizer DeleteCustomAuthorizer 导出API Swagger ExportApiDefinitions 导入API Swagger ImportApiDefinitions 创建VPC通道 Vpc CreateVpcChannel 更新VPC通道 Vpc UpdateVpcChannel 删除VPC通道 Vpc DeleteVpcChannel 添加或更新后端实例 Vpc AddingBackendInstances 更新后端实例 Vpc UpdateBackendInstances 删除后端实例 Vpc DeleteBackendInstance 批量修改后端服务器状态可用 Vpc BatchEnableMembers 批量修改后端服务器状态不可用 Vpc BatchDisableMembers 修改VPC通道健康检查 Vpc UpdateHealthCheck 添加或更新VPC通道后端服务器组 Vpc CreateMemberGroup 删除VPC通道后端服务器组 Vpc DeleteMemberGroup 更新VPC通道后端服务器组 Vpc UpdateMemberGroup 创建分组自定义响应 ApiGroup CreateGatewayResponse 修改分组自定义响应 ApiGroup UpdateGatewayResponse 删除分组自定义响应 ApiGroup DeleteGatewayResponse 修改分组下指定错误类型的自定义响应 ApiGroup UpdateGatewayResponseType 删除分组指定错误类型的自定义响应配置 ApiGroup DeleteGatewayResponseType 实例配置特性 Feature CreateFeatureV2 创建专享版实例（按需） Instance CreateInstance 更新专享版实例 Instance UpdateInstance 实例更新或绑定EIP Instance AddEip 实例解绑EIP Instance RemoveEip 开启实例公网出口 Instance AddEngressEip 更新实例出公网带宽 Instance UpdateEngressEip 关闭实例公网出口 Instance RemoveEngressEip 开启实例公网入口 Instance AddIngressEip 更新实例入公网带宽 Instance UpdateIngressEip 关闭实例公网入口 Instance RemoveIngressEip 删除专享版实例 Instance DeleteInstances 创建专享版实例（包周期） Instance CreateOrder 创建包周期规格变更订单 Instance CreatePrepayResize 按需规格变更 Instance CreatePostPayResizeOrder 接受或拒绝终端节点连接 vpc-endpoint AcceptOrRejectEndpointConnections 批量添加实例终端节点连接白名单 vpc-endpoint AddEndpointPermissions 批量删除实例终端节点连接白名单 vpc-endpoint DeleteEndpointPermissions 批量添加或删除单个实例的标签 Instance BatchCreateOrDeleteInstanceTags 导入微服务 Microservice ImportMicroservice 创建SSL证书 SslCertificate CreateCertificate 域名绑定SSL证书 ApiGroup BatchAssociateCerts 域名解绑SSL证书 ApiGroup BatchDisassociateCerts 删除SSL证书 SslCertificate DeleteCertificate 修改SSL证书 SslCertificate UpdateCertificate SSL证书绑定域名 Certificate BatchAssociateDomains SSL证书解绑域名 Certificate BatchDisassociateDomains 创建插件 Plugin CreatePlugin 修改插件 Plugin UpdatePlugin 删除插件 Plugin DeletePlugin 插件绑定API Plugin AttachApiToPlugin API绑定插件 Plugin AttachPluginToApi 解除绑定插件的API Plugin DetachApiFromPlugin 解除绑定API的插件 Plugin DetachPluginFromApi 创建APP App CreateAnApp 修改APP App UpdateApp 删除APP App DeleteAppV2 重置密钥 App ResettingAppSecret 校验APP App CheckApp 创建APP Code AppCode CreateAppCode 自动生成APP Code AppCode CreateAppCodeAuto 删除APP Code AppCode DeleteAppCode 设置APP的访问控制 AppAcl UpdateAppAcl 删除APP的访问控制 AppAcl DeleteAppAcl 创建凭据配额 AppQuota CreateAppQuota 修改凭据配额 AppQuota UpdateAppQuota 删除凭据配额 AppQuota DeleteAppQuota 凭据配额绑定凭据列表 AppQuotaBinding AssociateAppsForAppQuota 解除凭据配额和凭据的绑定 AppQuotaBinding DisassociateAppQuotaWithApp

脚本配置示例 { "allow_origin": "*", "allow_methods": "GET,POST,PUT", "allow_headers": "Content-Type,Accept,Accept-Ranges,Cache-Control", "expose_headers": "X-Request-Id,X-Apig-Latency", "max_age": 172800, "allow_credentials": true }

配置参数说明 表1 配置参数说明 参数 配置说明 allowed origins Access-Control-Allow-Origin响应头，指定允许访问API的外域URI，多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求，可以把参数值设置为“*”，表示允许来自所有域的访问请求。 allowed methods Access-Control-Allow-Methods响应头，指定允许使用的HTTP请求方法，多个请求方法之间使用英文逗号隔开。 allowed headers Access-Control-Allow-Headers响应头，指定XMLHttpRequest请求中允许携带的请求头字段，多个请求头之间使用英文逗号隔开。 其中，简单请求头Accept、Accept-Language、Content-Language、Content-Type（取值仅限为application/x-www-form-urlencoded、multipart/form-data、text/plain时）默认允许在请求中携带，无需在该参数中设置。 说明： 创建跨域资源共享插件时，默认不配置allowed headers，不允许跨域请求携带任何自定义请求头。 配置allowed headers为“*”，表示允许跨域请求携带所有请求头。 exposed headers Access-Control-Expose-Headers响应头，指定XMLHttpRequest请求响应中允许携带的响应头字段，多个响应头之间使用英文逗号隔开。 其中，基本响应头Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma默认允许在响应中携带，无需在该参数中设置。 说明： 创建跨域资源共享插件时，默认不配置exposed headers，不允许浏览器的JavaScript代码解析跨域访问获得的响应头内容（除XMLHttpRequest对象的getResponseHeader()方法获得的基本响应头，Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma）。 配置exposed headers为“*”，表示允许浏览器的JavaScript代码解析跨域访问获得的所有响应头内容。 maximum age Access-Control-Max-Age响应头，指定本次预检请求的有效期，单位为秒。在有效期内，无需再次发出预检请求。 allowed credentials Access-Control-Allow-Credentials响应头，定XMLHttpRequest请求中是否允许携带Cookie。 开关开启表示允许。 开关关闭表示不允许。

配置参数说明 表1 配置参数说明 参数 配置说明 策略生效范围 单个API生效 对单个API进行流量统计和控制。 API共享生效 对绑定了该插件的所有API进行总流量统计和控制。 时长 流量限制的时长。 与“API流量限制”配合使用，表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用，表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用，表示单位时间内的单个APP请求次数上限。 与“源IP流量限制”配合使用，表示单位时间内的单个IP地址请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用，表示单位时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限，如果API认证方式为 IAM 认证，用户流量根据项目ID来限制；如果API认证方式为APP认证，用户流量根据账号ID来限制。账号ID和项目ID请参考下文“特殊租户”配置说明。 不超过“API流量限制”。 与“时长”配合使用，表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API，按主账号累计的调用次数进行限制。 应用流量限制 单个应用调用API次数上限，仅适用于API的安全认证方式为APP认证时。 不超过“用户流量限制”。 与“时长”配合使用，表示单位时间内的单个应用请求次数上限。 源IP流量限制 单个IP地址调用API次数上限。 不超过“API流量限制”。 与“时长”配合使用，表示单位时间内的单个IP地址请求次数上限。 参数流控配置 参数流控配置开关。开启后，以参数维度进行流控限制。 定义参数 定义用于规则匹配的参数。 参数位置：用于规则匹配的参数位置。 path：API请求的URI，系统默认配置。 method：API请求方法，系统默认配置。 Header：HTTP头域的第一个值。 Query：QueryString的第一个值。 System：系统参数。 参数：用于判断与规则匹配中的参数值是否匹配。 定义规则 定义规则的匹配条件，以及API流量限制和时长。 单击“添加规则”，可添加多个规则。 规则匹配 单击，可添加多个条件表达式，选择“定义参数”中的参数名和判断条件，以及输入参数值。 =为等于 !=为不等于 pattern为正则表达式 enum为枚举值，多个参数值之间用英文逗号分隔 API流量限制 API调用次数的最大值。 时长 定义规则的流量控制时长，如果此处不配置时长，规则的流量控制时长以“策略基本信息”的时长为准。 例如，在“定义参数”中添加参数“Host”，参数位置选择“Header”；在“定义规则”中添加一条规则，匹配条件设置成“Host = www.abc.com”，API流量限制为10，时长为60s。表示在60s内，对于请求头域中Host参数等于“www.abc.com”的API，且API调用次数达到10，参数流控生效。 特殊流控配置 特殊流控配置开关。开启后，“基础流控”的用户流量限制/应用流量限制与“特殊流控”的特殊租户/特殊应用共同作用时，以特殊流控值为准。 特殊租户 租户ID为账号ID或项目ID。 绑定APP认证的API时，租户ID为项目ID，获取项目ID。 绑定华为IAM认证的API时，租户ID为账号ID，不支持细分到IAM用户维度，获取账号名和账号ID。 阈值为单位时间内，此租户访问API的最大值，不超过“基础流控”的API流量限制值。 特殊应用 选择已有应用，阈值为单位时间内，此应用访问API的最大值，不超过“基础流控”的API流量限制值。

脚本配置示例 { "scope": "basic", "default_interval": 60, "default_time_unit": "second", "api_limit": 100, "app_limit": 50, "user_limit": 50, "ip_limit": 20, "specials": [ { "type": "app", "policies": [ { "key": "2e421d76dc6c4c75941511ccf654e368", "limit": 10 } ] }, { "type": "user", "policies": [ { "key": "878f1b87f71c40a7a15db0998f358bb9", "limit": 10 } ] } ], "parameters": [ { "type": "path", "name": "reqPath", "value": "reqPath" }, { "type": "method", "name": "method", "value": "method" }, { "type": "header", "name": "Host", "value": "Host" } ], "rules": [ { "match_regex": "[\"Host\",\"==\",\"www.abc.com\"]", "rule_name": "rule-jlce", "time_unit": "second", "interval": 0, "limit": 5 } ] }

错误码 当调用API时，可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 通过APIG接口管理API，发生错误时，产生的错误码请参考错误码。 使用APIG错误码时，请以错误码（如APIG.0101）为准，错误信息并非固定不变，有时会对错误信息进行优化修改。 表1 错误码 错误码 错误信息 HTTP状态码 语义 解决方案 APIG.0101 The API does not exist or has not been published in the environment. 404 API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致；检查API是否发布，如果发布到非生产环境，检查请求X-Stage头是否为发布的环境名；检查调用API使用的域名是否已经绑定到API所在的分组 APIG.0101 The API does not exist. 404 API请求方法不存在 检查API请求方法是否与API定义的方法相同 APIG.0103 The backend does not exist. 500 无法找到后端 联系技术支持 APIG.0104 The plug-ins do not exist. 500 无法找到插件配置 联系技术支持 APIG.0105 The backend configurations do not exist. 500 无法找到后端配置 联系技术支持 APIG.0106 Orchestration error. 400 编排错误 检查API配置的前后端参数是否合理 APIG.0107 The custom lua script encountered an unexpected error 500 Lua脚本发生未知错误 联系技术支持 APIG.0201 API request error. 400 请求格式不合法 使用合法的请求 APIG.0201 Request entity too large. 413 请求body过大（大于12M） 减小请求body大小 APIG.0201 Request URI too large. 414 请求URI过大（大于32K） 减小请求URI大小 APIG.0201 Request headers too large. 494 请求头过大（单个请求头大于32K或所有请求头总长度大于128K） 减小请求头大小 APIG.0201 Backend unavailable. 502 后端不可用 检查API配置的后端地址是否可用 APIG.0201 Backend timeout. 504 后端超时 增大超时时间或缩小后端的处理时间 APIG.0201 An unexpected error occurred 500 内部错误 联系技术支持 APIG.0202 Backend unavailable 502 后端不可用 检查API配置的后端请求协议是否与后端服务请求协议一致 APIG.0203 Backend timeout 504 后端超时 增大超时时间或缩小后端的处理时间 APIG.0204 SSL protocol is not supported: TLSv1.1 400 SSL协议版本不支持 使用支持的SSL协议版本 APIG.0205 Verify client certificate failed 400 客户端证书校验失败 检查客户端证书是否正确 APIG.0301 Incorrect IAM authentication information. 401 IAM认证信息错误 检查token是否正确 APIG.0302 The IAM user is not authorized to access the API. 403 IAM用户不允许访问API 检查用户是否被黑白名单限制 APIG.0303 Incorrect app authentication information. 401 APP认证信息错误 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致；检查客户端机器时间是否正确。请参考使用APP认证调用API检查签名代码的问题 APIG.0304 The app is not authorized to access the API. 403 APP不允许访问API 检查APP是否授权访问API APIG.0305 Incorrect authentication information. 401 认证信息错误 检查认证信息是否正确 APIG.0306 API access denied. 403 不允许访问API 检查是否授权访问API APIG.0307 The token must be updated. 401 token需要更新 重新从IAM获取token APIG.0308 The throttling threshold has been reached. 429 超出流控值限制 等待流控刷新后访问。如果触发调试域名的单日请求数上限，请绑定独立域名 APIG.0310 The project is unavailable. 403 project不可使用 使用其他project访问 APIG.0311 Incorrect debugging authentication information. 401 调试认证信息错误 联系技术支持 APIG.0312 Incorrect third-party authentication information,auth fail 401 第三方认证信息错误，认证失败 检查身份信息是否正确 APIG.0313 Incorrect third-party authentication information,identities error 401 第三方认证信息错误，身份错误 检查请求中身份信息与第三方认证插件中身份来源设置是否一致 APIG.0314 Incorrect third-party authentication information,access deny 403 第三方认证信息错误，访问拒绝 联系技术支持确认请求来源是否为业务请求，如果是，则提高第三方认证插件的防爆力拦截阈值以解决 APIG.0401 Unknown client IP address. 403 无法识别客户端IP地址 联系技术支持 APIG.0402 The IP address is not authorized to access the API. 403 IP地址不允许访问 检查IP地址是否被黑白名单限制 APIG.0404 Access to the backend IP address has been denied. 403 后端IP不允许访问 后端IP地址或后端域名对应的IP地址不允许访问 APIG.0405 The app is not accessed from a trusted IP address. 403 未从受信任的IP地址访问应用程序 检查源IP是否在访问控制策略中配置了允许或者拒绝 APIG.0501 The app quota has been used up. 405 APP已经超出配额 或云市场调用次数用完 购买APP配额 或重新购买云市场调用次数 APIG.0502 The app has been frozen. 405 APP被冻结 余额不足 APIG.0601 Internal server error. 500 内部错误 联系技术支持 APIG.0602 Bad request. 400 非法请求 检查请求是否合法 APIG.0605 Domain name resolution failed. 500 域名解析失败 检查域名拼写，以及域名是否绑定了正确的后端地址 APIG.0606 Failed to load the API configurations. 500 未加载API配置 联系技术支持 APIG.0607 The following protocol is supported: {xxx} 400 协议不被允许，允许的协议是xxx。 注意：xxx以实际响应中的内容为准。 改用支持的协议（HTTP/HTTPS）访问 APIG.0608 Failed to obtain the admin token. 500 无法获取管理账户 联系技术支持 APIG.0609 The VPC backend does not exist. 500 找不到负载后端 联系技术支持 APIG.0610 No backend available. 502 没有可连接的后端 检查所有后端是否可用，如调用信息与实际配置是否一致 APIG.0611 The backend port does not exist. 500 后端端口未找到 联系技术支持 APIG.0612 An API cannot call itself. 500 API调用自身 修改API后端配置，递归调用层数不能超过10层 APIG.0613 The IAM service is currently unavailable. 503 IAM服务暂时不可用 联系技术支持 APIG.0615 Incorrect third-party authentication VPC information 500 获取第三方鉴权负载通道节点失败 检查第三方认证的负载通道配置是否正确 APIG.0616 Incorrect third-party authentication request information 500 连接第三方鉴权服务失败 检查第三方认证服务是否正常 APIG.0617 Incorrect third-party authentication response information 500 获取第三方鉴权服务响应失败 检查第三方认证服务是否正常 APIG.0705 Backend signature calculation failed. 500 计算后端签名失败 联系技术支持 APIG.0802 The IAM user is forbidden in the currently selected region 403 该IAM用户在当前region中被禁用 联系技术支持 APIG.2102 PublicKey is null 400 签名密钥未找到 联系技术支持 APIG.2201 Appkey or SecretKey is invalid 400 Appkey或SecretKey不合法 检查请求的Appkey或SecretKey是否正确 APIG.2202 Refresh token is invalid 400 Refresh token不合法 检查Refresh token是否正确 APIG.2203 Access token is invalid 400 Access token不合法 检查Access token是否正确 APIG.2204 ContentType invalid 400 ContentType不合法 检查ContentType是否正确 APIG.2205 Auth parameter invalid 400 认证参数不合法 检查认证参数是否正确 APIG.2206 Auth method invalid 400 认证方法不合法 检查认证方法是否正确 APIG.2208 The length of through_data is out of range 400 through_data超长 through_data长度上限为300，根据实际情况调整through_data内容 APIG.2209 The value of grant_type is not in enum List 400 grant_type的值不合法 grant_type只支持client_credentials、refresh_token，根据实际情况修改 APIG.2210 Lack of grant_type 400 缺少授权类型 添加grant_type APIG.2211 Lack of client_id 400 缺少客户端ID 添加客户端ID APIG.2212 Lack of client_secret 400 缺少客户端密钥 添加客户端密钥 APIG.2213 Lack of refresh_token 400 缺少refresh token 联系技术支持 APIG.1001 Refresh token is expired 401 Refresh token过期 重新获取refresh token APIG.1002 Access token is expired 401 Access token过期 重新获取access token APIG.1003 App not match refresh token 401 App与refresh token不匹配 检查client_id是否正确 APIG.1004 App not exist 401 App不存在 检查access token是否正确 APIG.1009 AppKey or AppSecret is invalid 400 AppKey或AppSecret不合法 检查请求的AppKey或AppSecret是否正确 父主题： 调用已发布的API

新旧版本差异 自2021年12月30日起，API网关控制台界面更新，新旧版本差异点如下表所示。您也可以在控制台的“总览”页面，单击“新界面指南”查看。 API网关控制台旧版专享版界面于2024年01月30日下线，详情请参考服务公告。 新版仅提供专享版，共享版已下线，建议用户使用新版（专享版）。存量用户进入共享版，在“总览”页面单击“进入共享版控制台”即可。 表1 新旧版差异 差异点 旧版 新版 体验demo 有 无 API的安全配置支持双重认证 无 有 HTTP&HTTPS后端服务类型支持定义重试次数 无 有 导入API 导入API 创建API分组时，支持导入Swagger文件；API列表页支持导入API API调试可自定义body体 无 有 API详情页布局 API详情页信息集成度一般 API运行页信息集成度高 API详情页：单击流程图切换信息 有 无 可视化查看API已绑定的所有策略 无 有 策略创建和编辑可切换脚本模式 无 有 插件类型 跨域资源共享、HTTP响应头管理、流量控制 跨域资源共享、HTTP响应头管理、流量控制2.0、Kafka日志推送、断路器，与传统策略（流量控制、访问控制、签名密钥）合并于策略管理 SSL证书管理 无 有 负载通道支持创建服务器分组 无（负载通道即VPC通道） 有 负载通道提供健康检查开关 无（负载通道即VPC通道） 有 负载通道展示备用节点和启停状态 无（负载通道即VPC通道） 有 应用管理 应用管理 更名凭据管理 凭据配额策略 无 有 访问控制策略 无 有 监控管理 监控管理 更名API监控 子域名 子域名 更名调试域名 变量管理 变量管理 更名环境变量 左侧导航栏上方支持快速切换实例下拉框 无 有 铂金版扩容规格 无 有 带宽监控 无 有 导入云容器引擎CCE工作负载 无 有 导入 CS E微服务 无 有 实例标签 无 有 微服务类型负载通道 无 有 访问控制支持账号ID类型 无 有 克隆API 无 有 custom_log 无 有 第三方认证策略 无 有 gzip压缩 无 有 GRPC协议 无 有

前提条件 给用户组授权之前，请您了解用户组可以添加的表1，并结合实际需求进行选择。如果您需要对除API网关服务之外的其它服务授权，IAM支持服务的所有策略请参见服务列表“其他”中的“系统权限”。 表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator API网关服务的管理员权限。拥有该权限的用户可以使用专享版和共享版API网关服务的所有功能。 系统角色 无。 APIG FullAccess API网关服务所有权限。拥有该权限的用户可以使用专享版API网关服务的所有功能。 系统策略 无。 APIG ReadOnlyAccess API网关服务的只读访问权限。拥有该权限的用户只能查看专享版API网关服务的各类信息。 系统策略 无。

操作步骤 登录新版ROMA Connect控制台。 在“工作台”页单击“智能助手”，弹出“智能助手”窗口。 在输入框输入想创建的组合应用描述内容，或者单击输入框下面的行为描述语句。 单击带下划线的连接器或处理器，可以在下拉框中替换所需的其它连接器或处理器。 单击键盘的“Enter”键生成组合应用，再单击“应用结果”，生成组合应用。 继续在编辑组合应用画布页面，进行流任务的配置和编排。 可以进行交互式输入，进行组件配置。 完成后单击右上角的“保存”。 单击左上角组合应用名称旁的编辑按钮，在编辑组合应用弹窗中填写组合应用的名称和描述，然后单击“确定”，完成组合应用的创建。

配置参数 表1 机器人发送链接消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息标题 消息通知 标题。 消息内容 消息内容。 图片链接 消息预览图链接。 跳转链接 消息单击后跳转链接。 表2 机器人发送Markdown消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息标题 消息通知标题。 消息内容 消息内容。 表3 机器人发送图片消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 图片链接 消息预览图链接。 表4 机器人发送文件消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 媒体文件ID 通过上传媒体文件接口，获取media_id参数值。 文件名称 发送的文件名称。 文件类型 支持xlsx、pdf、zip、rar、doc、docx文件。 表5 机器人发送ActionCard消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息标题 消息通知标题。 消息内容 消息内容。 跳转按钮文本 跳转按钮显示内容。 跳转链接 消息单击后跳转链接。 表6 机器人发送文本消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息内容 消息内容。

调试步骤 登录新版ROMA Connect控制台。 在左侧导航栏选择“组合应用”，在组合应用页面单击需要调试的组合应用。 单击右上角的“编辑”进入组合应用设计页面。 单击页面上方“调试”按钮，进入调试模式。 图1 设计页面 选择调试环境。选择“区域”、“项目”和“实例”，作为在线调试使用的环境。 图2 配置调试环境 配置触发器节点。根据触发器节点类型，配置对应的触发参数，如Open API节点您可能需要配置API请求参数和请求Body等。 图3 配置Open API节点参数 单击“保存”，开启工作流调试。 执行调试操作，对工作流进行调试。 图4 调试工作流 添加断点：单击工作流中的节点，即可添加断点，工作流在调试过程中可能会停在当前断点。再次单击该节点，可移除断点。 触发器节点、并行处理节点和分支判断节点等不可添加断点。 调试运行：单击“调试运行”，工作流开始执行调试。如果工作流中存在断点，工作流会停留在该断点，并展示进入当前断点的数据，包括“属性”和“载荷”数据；如果工作流中不存在断点，工作流会自动运行至结束，或者在运行出错的节点停止，并展示错误信息。 单步运行：当工作流处于调试状态，停留在某一节点时，单击“单步运行”，工作流可自动运行至下一个节点。 运行到下一断点：当工作流处于调试状态，停留在某一节点时，单击“运行到下一断点”，工作流可自动运行至下一个断点。如果后续不存在断点，工作流会自动运行至结束，或者在运行出错的节点停止，并展示错误信息。 运行到结束：当工作流处于调试状态，停留在某一节点时，单击“运行到结束”，工作流会自动运行至结束，或者在运行出错的节点停止，并展示错误信息。 停止运行：当工作流处于调试状态，单击“停止运行”，工作流会终止本次调试过程。 调试完成后，单击页面右上方“退出调试”，退出调试模式，返回组合应用设计页面。

前置条件和约束 使用工作流在线调试功能，您需要具备ROMA Connect实例作为调试运行环境。您可购买独立的ROMA Connect实例，也可以使用共享体验版实例。 工作流在线调试功能可能会对运行在所选实例上的其它工作流产生影响，推荐您使用独立的实例进行调试。 使用工作流在线调试功能，调试环境如果选择共享体验版实例，您可同时调试的最大工作流数量为1条；如果选择购买独立的ROMA Connect实例，可同时调试的最大工作流数量为5条。 使用工作流在线调试功能，工作流的触发器节点不会真实运行，如Open API节点不会发布为API，您需要手动配置触发器节点进行触发。 使用工作流在线调试功能，在单个节点的最大停留时间为60s，超时后会自动向后运行。

支持的动作 获取部门ID列表 创建部门 更新部门 删除部门 获取成员ID列表 创建成员 更新成员 删除成员 获取群聊会话 创建群聊会话 修改群聊会话 推送文本消息 推送markdown消息 推送文件消息 推送图片消息 推送图文消息 推送文本卡片消息 撤回应用消息 推送文本消息到群聊 推送markdown消息到群聊 推送文件消息到群聊 推送图片消息到群聊 推送图文消息到群聊 推送文本卡片消息到群聊 机器人推送文本消息 机器人推送markdown消息 机器人推送文件消息 机器人推送图片消息 机器人推送图文消息

创建企业微信连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“企业微信”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 连接类型 选择连接类型。 机器人：若需要使用机器人推送消息功能，选择机器人； 应用：其他功能选择应用。 企业ID 仅当“连接类型”选择“应用”时需要配置。 每个企业都拥有唯一的corpid，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节。 应用凭证密钥 仅当“连接类型”选择“应用”时需要配置。 每一个应用都有一个独立的访问密钥，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节。 机器人Key 仅当“连接类型”选择“机器人”时需要配置。 机器人webhook中的请求参数key的值。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 表1 删除资产授权 参数 说明 bucket_id 桶ID。 project_id 项目ID。 region_id 区域ID。 表2 添加资产授权 参数 说明 project_id 项目ID。 region_id 区域ID。 type 资产类型。 buckets OBS桶列表。 asset_name 资产名称。 location 桶位置。 bucket_name 桶名称。 bucket_policy 桶策略。 表3 查看资产列表 参数 说明 project_id 项目ID。 region_id 区域ID。 added 是否已授权。 true false offset 页码。 limit 分页大小。 表4 编辑资产名称 参数 说明 asset_id 资产ID。 project_id 项目ID。 region_id 区域ID。 name 资产名称。 表5 开启/停止脱敏任务 参数 说明 project_id 项目ID。 template_id 模板ID。 region_id 区域ID。 status 脱敏任务状态。 表6 查询脱敏任务执行列表 参数 说明 project_id 项目ID。 template_id 模板ID。 region_id 区域ID。 workspace_id 工作区ID。 offset 页码。 limit 分页大小。 表7 提取图片中的图片暗水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待提取图片暗水印的图片地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 image_watermark 提取出来的水印图片存放地址，格式要求同src_file。 表8 提取图片中的文字暗水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待提取文字暗水印的图片地址，当前只支持OBS，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 mark_len 指定待提取水印的长度，最小0，最大32。设置后可以提升水印提取性能。 表9 图片嵌入暗水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待加暗水印的图片地址，当前只支持OBS文件，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 blind_watermark 待嵌入的文字暗水印内容，长度不超过32个字符。当前仅支持数字及英文大小写。与图片暗水印image_watermark二选一。 image_watermark 待嵌入的图片暗水印地址，格式要求同src_file字段，与文字暗水印 blind_watermark 二选一，都填写时，生效image_watermark。 dst_file 添加水印后的图片存放的地址，格式要求同src_file字段，不设置时，默认取src_file的值，即添加水印后覆盖原文件。 表10 文档提取暗水印（文档地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 doc_type 待提取水印的文档类型 枚举值： WORD EXCEL PDF PPT src_file 待提取文字暗水印的文档的地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.doc，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.doc为对象全路径名。 file_password 解密文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 表11 文档嵌入水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待添加水印的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 doc_type 待嵌入水印的文档类型。 枚举值： WORD EXCEL PDF PPT dst_file 添加水印后的文档存放地址，格式和要求同src_file字段，不设置时，默认取src_file的值，即添加水印后覆盖原文件。 blind_watermark 暗文字水印内容，与“visible_watermark”字段至少有一个不为空。 visible_watermark 明文字水印内容，与暗水印“blind_watermark”字段至少有一个不为空。 image_mark 待嵌入的图形明水印文件的地址, 字段格式要求同src_file字段，图形文件的格式必须为“png”或“jpg”，否则返回参数错误；图像文件大小不超过1MB。 visible_type 该字段控制明水印嵌入文字还是图片。默认为TEXT类型，需填写visible_watermark字段设置明文字水印； 当该字段为IMAGE时，需填写image_watermark字段设置水印图片地址此时 ，“visible_watermark”，“font_size”，“rotation”和“opacity”字段无效。 枚举值： TEXT IMAGE file_password 待加水印文件有密码时，读取文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 marked_file_password 添加水印后给文件设置密码， 最大支持长度256。默认不加文档密码。 readonly_password 添加水印后给文件设置只读密码， 最大支持长度256。默认不加只读密码。 front 明水印字体大小，取值为[1,100]，默认值50。 rotation 明水印旋转角度，逆时针方向，取值为[0,90]，默认值45。 opacity 明水印的透明度，取值[0,1]，默认值为0.3。 表12 对数据进行脱敏 参数 说明 project_id 项目ID region_id 区域ID。 mask_strategies 脱敏策略列表，每一个策略对应一个字段，脱敏策略数最多100个。 name 需要脱敏的字段名称，最大支持长度256。 algorithm 脱敏算法名称。 枚举值： SHA256 SHA512 AES PRESNM MASKNM PRESXY MASKXY SYMBOL KEYWORD NUMERIC parameters 脱敏算法参数。 data 数据列表。 表13 提取数据水印 参数 说明 project_id 项目ID。 region_id 区域ID。 watermark_key 水印密钥。 columns 字段类型列表，最大长度100。使用时，要包含嵌入时所有“primary_key”为true的字段，和至少一个为false的字段用来提取水印。 name 数据的字段名称，最大支持长度256。 type 数据的字段类型。 枚举值： INTEGER STRING DOUBLE primary_key 标记该字段是否为主键。true为主键，表示用来定位水印位置；false为非主键，将在该列嵌入/提取水印内容。字段类型列表中可同时包含多个为true或为false的字段。 data 水印数据，数据条数不超过30,000条。 表14 嵌入数据水印 参数 说明 project_id 项目ID。 region_id 区域ID。 watermark_content 添加水印的内容。 watermark_key 水印密钥。 columns 字段类型列表，最大长度100。使用时，至少包含两个字段，一个“primary_key”为true表示主键，一个为false用来嵌入水印。 name 数据的字段名称，最大支持长度256。 type 数据的字段类型。 枚举值： INTEGER STRING DOUBLE primary_key 标记该字段是否为主键。true为主键，表示用来定位水印位置；false为非主键，将在该列嵌入/提取水印内容。字段类型列表中可同时包含多个为true或为false的字段。 data 数据字段的内容，最大支持长度2000。

创建 数据安全中心 连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“数据安全中心”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 参数 说明 主题 需要监听的topic。 GroupId 用来唯一标识consumer进程所在组的字符串，如果设置同样的group id，表示这些processes都是属于同一个consumer group。 KeyDeserializer 键的反序列化方式，默认为:org.apache.kafka.common.serialization.StringDeserializer。 ValueDeserializer 值的反序列化方式，默认为:org.apache.kafka.common.serialization.StringDeserializer。 AutoOffsetReset 设置当没有初始的偏移量或者偏移量超出范围时，从哪里开始消费。 latest：从最近的偏移量开始消费； earliest：从最早的偏移量开始消费； none：抛出异常。

创建Kafka连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Kafka”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 Brokers地址 填写Kafka的Brokers地址。 认证方式 选择Kafka的认证方式。 SSL认证 无认证 SASL鉴权方式 仅当“认证方式”选择“SSL认证”时需要配置。 选择SASL鉴权方式。 PLAIN SC RAM -SHA-512 SSL用户名 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL用户名/应用Key。 SSL密码 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL密码。 SSL证书格式 仅当“认证方式”选择“SSL认证”时需要配置。 选择SSL证书格式。 PEM JKS SSL证书 仅当“认证方式”选择“SSL认证”时需要配置。 填写经过base64编码的证书内容。 SSL证书密码 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL证书密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 表1 获取软件需求列表 参数 说明 项目ID 填写需求的项目ID。 表2 修改软件需求状态 参数 说明 项目ID 填写需求的项目ID。 需求ID 填写需求ID。 需求状态 选择需求状态。 Draft Reviewed Approved Rejected 原因 选择拒绝原因。 Obsolete Duplicate Invalid Later 表3 获取测试用例列表 参数 说明 项目ID 填写需求的项目ID。 表4 获取软件测试用例列表 参数 说明 项目ID 填写需求的项目ID。 表5 获取测试用例与需求关联关系 参数 说明 项目ID 填写需求的项目ID。 测试用例ID 填写测试用例ID。 表6 添加软件测试报告 参数 说明 项目ID 填写需求的项目ID。 空间ID 填写空间ID。 标题 填写报告标题 名称（ID） 填写名称（ID）。 类型 请选择工作项类型。 Software Test Case est Case 链接角色 请选择连接角色。 has parent duplicates relates to 内容类型 请选择内容类型。 text/html text/plain 内容 填写报告内容。 表7 修改软件测试报告 参数 说明 项目ID 填写需求的项目ID。 空间ID 填写空间ID。 标题 填写报告标题 名称（ID） 填写名称（ID）。 类型 请选择工作项类型。 Software Test Case est Case 内容类型 请选择内容类型。 text/html text/plain 内容 填写报告内容。 表8 获取Issue列表 参数 说明 项目ID 填写需求的项目ID。

创建Polarion连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Polarion”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 连接地址 填写连接地址，连接地址示例: http://endpoint:port/polarion。 API Token 填写API Token。 描述 填写连接器的描述信息，用于识别不同的连接器。