华为云用户手册

调用API获取项目ID 您还能通过调用查询指定条件下的项目信息API获取项目ID。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "region01", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总数量 application_infos Array of ApplicationInfo objects 应用信息 表5 ApplicationInfo 参数 参数类型 描述 application_id String 应用ID application_name String 应用名称 description String 应用描述 version String 应用版本 type String 应用类型 3D_APP：3D应用程序 VR_APP：VR应用程序 BASIC_RUNTIME_LIB：基础运行库 install_mode String 安装模式 PRE_INSTALL：预安装在镜像中 STANDARD：标准安装包模式 icon String 应用图标 start_path String 应用启动路径 start_command String 应用启动命令 capture_type String 抓取模式 hook capture plugin 默认值：hook tag String 应用标签 app_package_url String 应用安装包OBS桶存储路径 app_package_size Integer 应用安装包大小，单位：MB create_time Long 创建时间，单位：毫秒 update_time Long 更新时间，单位：毫秒 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID

URI GET /v1/{domain_id}/applications 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置的偏移量。从第一条数据偏移offset条数据后开始查询。 必须为数字，不能为负数。 默认值：0，含义为偏移0条数据，即从第一条数据开始查询。 limit 否 Integer 分页大小

SDK使用 创建HRTIEngine引擎。 HRTIEngine *rtiEngine = [HRTIEngine sharedRTIEngine]; self.rtiEngine = rtiEngine; 初始化引擎配置。 HRTISessionConfig *sessionConfig = [[HRTISessionConfig alloc] init]; sessionConfig.token = @"token"; //会话token，从创建会话接口获取。 sessionConfig.serverSessionId = @"serverSessionId"; sessionConfig.renderView = self.view; [self.rtiEngine init:self.sessionConfig]; 开始会话 [self.rtiEngine start]; 获取并使用键盘、鼠标等接口对象。 Mouse mouse = [self.rtiEngine getMouse]; // 获取鼠标接口 [mouse inputMouseDown:mouseKey pos:pos]; // 鼠标按下 [mouse inputMouseMove:pos]; // 鼠标移动 [mouse inputMouseUp:mouseKey pos:pos]; // 鼠标抬起 KeyBoard keyBoard = [self.rtiEngine getKeyBoard]; // 获取键盘接口 [keyBoard inputKeyDown:inputKey]; // 键位按下 [keyBoard inputKeyUp:inputKey]; // 键位抬起 销毁引擎。 [self.rtiEngine destroy]; 父主题： RTI iOS SDK

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID

URI GET /v1/{domain_id}/groups/{group_id}/resource 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID group_id 是 String 节点组ID 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 支持ConfigMap、Secret、Volume、PersistentVolumeClaim、PersistentVolume、StorageClass、Deployment等K8s资源

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 nodes Array of NodeIdAndName objects 节点信息列表 表5 NodeIdAndName 参数 参数类型 描述 node_id String 节点ID node_name String 节点名称 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token 表3 请求Body参数 参数 是否必选 参数类型 描述 count 是 Integer 节点个数 resource_id 否 String 订单ID instance_type 否 String 节点类型 S：小型节点 M：中型节点 L：大型节点 XL：超大型节点 P：云手机节点

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总数量 application_infos Array of GroupPublishedApplicationInfo objects 应用信息 表5 GroupPublishedApplicationInfo 参数 参数类型 描述 application_id String 应用ID application_name String 应用名称 description String 应用描述 version String 应用版本 type String 应用类型 3D_APP：3D应用程序 VR_APP：VR应用程序 BASIC_RUNTIME_LIB：基础运行库 install_mode String 安装模式 PRE_INSTALL：预安装在镜像中 STANDARD：标准安装包模式 icon String 应用图标 start_path String 应用启动路径 start_command String 应用启动命令 capture_type String 抓取模式 hook capture plugin 默认值：hook tag String 应用标签 app_package_url String 应用安装包OBS桶存储路径 app_package_size Integer 应用安装包大小，单位：MB create_time Long 创建时间，单位：毫秒 update_time Long 更新时间，单位：毫秒 group_id String 节点组ID group_name String 节点组名称 error_info String 异常信息 status String 应用状态 PENDING_PUBLISH：等待发布 PUBLISHING：应用发布中 PUBLISHED：应用发布成功 PUBLISH_EXCEPTION：应用发布异常 PENDING_UNLOAD：等待卸载应用 UNLOADING：卸载应用中 UNLOADED：应用卸载完成 UNLOAD_EXCEPTION：应用卸载异常 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID

URI GET /v1/{domain_id}/published-applications 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置的偏移量。从第一条数据偏移offset条数据后开始查询。 必须为数字，不能为负数。 默认值：0，含义为偏移0条数据，即从第一条数据开始查询。 limit 否 Integer 分页大小 group_id 否 String 根据节点组ID过滤 application_id 否 String 根据应用ID过滤

URI GET /v1/{domain_id}/sessions 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置的偏移量。从第一条数据偏移offset条数据后开始查询。 必须为数字，不能为负数。 默认值：0，含义为偏移0条数据，即从第一条数据开始查询。 limit 否 Integer 分页大小 status 否 String 会话状态

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总数量 session_infos Array of SessionInfo objects 会话信息 表5 SessionInfo 参数 参数类型 描述 session_id String 会话ID application_id String 应用ID status String 服务器会话当前的状态 ACTIVATING：激活中 ACTIVE：活跃 TERMINATING：终止中 TERMINATED：终止 ERROR：异常 token String 端侧接入鉴权使用的Token create_time String 标识session创建的时间。为UTC时间，且遵循RFC3339规范 close_time String 标识session终止的时间。为UTC时间，且遵循RFC3339规范 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 node_info NodeInfo object 节点信息 表4 NodeInfo 参数 参数类型 描述 node_id String 节点ID node_name String 节点名称 group_id String 节点组ID resource_id String 订单ID status String 节点状态 IDLE：空置 FREE：空闲 ALLOCATING：纳管中 RECYCLING：回收中 WORKING：工作中 ECSREADY：机器就绪 APPREADY：应用就绪 BUSY：繁忙 INUSE：已发布一个应用 ERROR：异常 PUBLISHING_APP：发布应用中 UNLOADING_APP：卸载应用中 LOST_HEARTBEAT：心跳超时 CREATE_EXCEPTION：节点创建异常 CREATE_TIMEOUT：节点创建超时 DELETE_EXCEPTION：删除节点异常 UPGRADING：升级中 error_info String 错误信息 agent_id String Agent包ID engine_id String Engine包ID create_time Long 节点创建时间，单位：毫秒 update_time Long 节点最后更新时间 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息 request_id String 请求ID

SDK概述 华为云实时互动服务软件开发工具包是对RTI服务提供的REST API进行的封装，以简化用户的开发工作。用户直接调用RTI SDK提供的接口函数即可实现使用RTI服务业务能力的目的。 同时，针对不同平台的SDK提供了集成和接口参考。详细介绍了SDK的集成操作、接口参数定义和代码示例。RTI提供了以下主流平台SDK供开发者使用。 注：目前所有平台仅支持1对1场景。 客户端 集成SDK 接口参考 Android Android SDK集成 Android SDK接口参考 iOS iOS SDK集成 iOS SDK接口参考 父主题： 客户端SDK参考

服务端如何计算Signature？ //认证用的app_key和app_id硬编码至代码中或以明文形式存储会有极大风险。建议密文形式配置存储在文件或者环境变量中，使用时解密，以确保安全。本例以app_key和app_id存放至环境变量为例，运行前请先在本地环境中设置完成环境变量APP_KEY和APP_ID。 app_key = System.getenv("APP_KEY"); app_id = System.getenv("APP_ID"); signature = HMAC256(app_key,(app_id + room_id + user_id +ctime)) 父主题： Signature相关

注意事项 同一时间最多只能创建4个连接对象，每个连接对象对应的房间ID必须互不相同。 如果使用connection对象加入房间，则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。 同一时间只能以一个JOINER角色加入某一个房间。如果本端在其他房间里的角色是HWRtcRoleJoiner，则需要调用该房间的ChangeUserRole方法将本端在该房间的角色切换为HWRtcRolePlayer后才能以HWRtcRoleJoiner跨入其他房间。如果本端用户是以HWRtcRolePlayer角色加入此跨房房间，则需要调用跨房连接的ChangeUserRole方法将本端的角色切换为HWRtcRoleJoiner后才能发送音频流和视频流。

实现过程 加入房间 参考接口调用流程中加入房间的时序图步骤加入主房间。 创建跨房连接 当收到远端用户加入房间后会触发connection:onRemoteUserOnline跨房回调，在该回调内用对应远端用户的跨房连接调用startRemoteStreamView方法设置远端窗口并开启收流。 示例代码如下： //创建跨房引擎，room id具有唯一性，不可重复，设置引擎代理 HWRtcConnection *connection = [rtcEngine createConnection:@”room id”]; connection.delegate = self; 调用跨房连接的joinRoom加入跨房房间 调用跨房连接的joinRoom接口加入房间，其中HWRtcUserInfo的signature鉴权签名字符串需要填入正确的计算值，计算方法请参考接入鉴权。 如果本端需要发送音频或者视频流给跨房房间里的远端用户，则用户的role参数需要设为HWRtcRoleJoiner，否则可以设为HWRtcRolePlayer，只收流不发流。 注意：不能同时以JOINER角色加入多个房间。 加入跨房房间成功后会收到跨房回调指针的onJoinRoomSuccess通知，加入房间失败会收到跨房回调指针的onJoinRoomFailure通知。 示例代码如下： //创建HWRtcJoinParam对象 HWRtcJoinParam *joinRoomParam = [[HWRtcJoinParam alloc] init]; joinRoomParam.autoSubscribeAudio = YES; joinRoomParam.autoSubscribeVideo = YES; joinRoomParam.userId = "userId"; joinRoomParam.userName = "userName"; joinRoomParam.authorization = authorization; //authorization：鉴权信息，具体生成方法请参见接入鉴权。与加入房间的authorization相同 joinRoomParam.ctime = time;//与加入房间的time相同 joinRoomParam.roomId = "roomId"; joinRoomParam.userRole = HWRtcRolePlayer; joinRoomParam.sfuType = 0; joinRoomParam.scenario = 0; //通过跨房引擎进入房间 [connection joinRoom:joinRoomParam]; 收远端用户的视频流 收到远端用户加入房间后会收到跨房回调connection:onRemoteUserOnline，可以调用该远端用户对应的跨房连接的startRemoteStreamView设置远端窗口并开启收流。 示例代码如下： //远端用户加入房间后会收到跨房回调 - (void)connection:(HWRtcConnection *)connection onRemoteUserOnline:(NSString * _Nonnull)userId userName:(NSString * _Nonnull)userName { //创建视频画布对象 HWRtcVideoCanvas *canvas = [[HWRtcVideoCanvas alloc] init]; canvas.uid = @”remote userId”; canvas.view = [[HWRtcView alloc] initWitFrame:(0,0,100,100)]; //设置远端窗口并开启收流 [connection startRemoteStreamView:canvas streamType:HWRtcStreamTypeHD disableAdjustRes:YES]; } 退出跨房房间 跨房结束后，调用跨房连接的leaveRoom接口跨房房间。 示例代码如下： //退出跨房房间 [connection leaveRoom]；

注意事项 同一时间最多只能创建4个连接对象，每个连接对象对应的房间ID必须互不相同。 如果使用connection对象加入房间，则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。 同一时间只能以一个JOINER角色加入某一个房间。如果本端在其他房间里的角色是HWRtcRoleJoiner，则需要调用该房间的setUserRole方法将本端在该房间的角色切换为HWRtcRolePlayer后才能以HWRtcRoleJoiner跨入其他房间。如果本端用户是以HWRtcRolePlayer角色加入此跨房房间，则需要调用跨房连接的setUserRole方法将本端的角色切换为HWRtcRoleJoiner后才能发送音频流和视频流。

实现过程 加入房间 参考接口调用流程中加入房间的时序图步骤加入主房间。 创建跨房连接 当收到远端用户加入房间后会触发connection:onRemoteUserOnline跨房回调，在该回调内用对应远端用户的跨房连接调用startRemoteStreamView方法设置远端窗口并开启收流。 示例代码如下： //创建跨房引擎，room id具有唯一性，不可重复，设置引擎代理 HWRtcConnection *connection = [rtcEngine createConnection:@”room id”]; connection.delegate = self; 调用跨房连接的joinRoom加入跨房房间 调用跨房连接的joinRoom接口加入房间，其中HWRtcUserInfo的signature鉴权签名字符串需要填入正确的计算值，计算方法请参考接入鉴权。 如果本端需要发送音频或者视频流给跨房房间里的远端用户，则用户的role参数需要设为HWRtcRoleJoiner，否则可以设为HWRtcRolePlayer，只收流不发流。 注意：不能同时以JOINER角色加入多个房间。 加入跨房房间成功后会收到跨房回调指针的onJoinRoomSuccess通知，加入房间失败会收到跨房回调指针的onJoinRoomFailure通知。 示例代码如下： //创建HWRtcUserInfo对象 HWRtcJoinParam *joinRoomParam = [[HWRtcJoinParam alloc] init]; joinRoomParam.autoSubscribeAudio = YES; joinRoomParam.autoSubscribeVideo = YES; joinRoomParam.userId = "userId"; joinRoomParam.userName = "userName"; joinRoomParam.authorization = authorization;//authorization：鉴权信息，具体生成方法请参见接入鉴权。与加入房间的authorization相同 joinRoomParam.ctime = time;//与加入房间的time相同 joinRoomParam.roomId = "roomId"; joinRoomParam.userRole = HWRtcRolePlayer; joinRoomParam.sfuType = 0; joinRoomParam.scenario = 0; //通过跨房引擎进入房间 [connection joinRoom:joinRoomParam]; 收远端用户的视频流 收到远端用户加入房间后会收到跨房回调connection:onRemoteUserOnline，可以调用该远端用户对应的跨房连接的startRemoteStreamView设置远端窗口并开启收流。 示例代码如下： //远端用户加入房间后会收到跨房回调 - (void)connection:(HWRtcConnection *)connection onRemoteUserOnline:(NSString * _Nonnull)userId userName:(NSString * _Nonnull)userName { //创建视频画布对象 HWRtcVideoCanvas *canvas = [[HWRtcVideoCanvas alloc] init]; canvas.uid = @”remote userId”; canvas.view = [[HWRtcView alloc] initWitFrame:(0,0,100,100)]; //设置远端窗口并开启收流 [connection startRemoteStreamView:canvas streamType:HWRtcStreamTypeHD disableAdjustRes:YES]; } 退出跨房房间 跨房结束后，调用跨房连接的leaveRoom接口跨房房间。 示例代码如下： //退出跨房房间 [connection leaveRoom]；

注意事项 同一时间最多只能创建4个连接对象，每个连接对象对应的房间ID必须互不相同。 如果使用connection对象加入房间，则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。 同一时间只能以一个JOINER角色加入某一个房间。如果本端在其他房间里的角色是HWRtcRoleJoiner，则需要调用该房间的setUserRole方法将本端在该房间的角色切换为HWRtcRolePlayer后才能以HWRtcRoleJoiner跨入其他房间。如果本端用户是以HWRtcRolePlayer角色加入此跨房房间，则需要调用跨房连接的setUserRole方法将本端的角色切换为HWRtcRoleJoiner后才能发送音频流和视频流。

初识AstroZero环境配置 在AstroZero中，由于开发环境和运行环境是两套独立的环境，所以环境配置也区分开发环境和运行环境。开发或部署应用时，需要分别在开发环境、运行环境中进行应用的相关管理及配置。 AstroZero中，各环境的环境配置界面及功能基本上一致，其主要区别在于某些配置项只存在开发环境或运行环境的环境配置中，如运行环境的环境配置提供了企业配置功能，而开发环境的环境配置无此功能。 本文档中，运行环境的环境配置和开发环境的环境配置统称为AstroZero环境配置（经典版统称为AstroZero管理中心）。在使用AstroZero时，请结合实际情况，选择登录对应环境的环境配置，本手册的界面操作及截图均以运行环境的环境配置为例。 免费版和标准版不提供低代码应用的运行环境，免费版和标准版只需要关注开发环境环境配置相关操作即可。 沙箱环境中的应用管理及配置与运行环境一致，请参考运行环境的相关描述进行操作。 AstroZero环境配置区分新版和经典版（管理中心），两个版本提供的功能基本相同，请根据实际需求选择新版还是经典版。

支持HTTP2.0 API网关支持HTTP/2（超文本传输协议第2版）访问协议，通常称之HTTP2.0。拥有二进制格式编码、多路复用共享连接和请求头压缩的能力，改进传输性能，实现低延迟和高吞吐量。 由于HTTP2.0是强依赖网络稳定性的，建议用户在使用HTTP2.0时使用比较稳定的网络场景，而且客户端须支持HTTP2.0。 如果当前实例不支持HTTP2.0，请联系技术支持升级实例。 如需关闭HTTP2.0协议，在API网关控制台的“配置参数”页面中的“request_custom_config”参数下关闭HTTP/2协议即可。 Binary Format二进制格式 HTTP1.x以文本的形式传输，而HTTP2.0将所有传输信息分割为更小的消息和帧，并对它们采用二进制格式编码。相对于字符串（文本）解析，二进制格式解析更方便且不易出错，提升传输性能。 MultiPlexing多路复用 在二进制格式的基础上，HTTP2.0不再依赖多个连接去实现并行处理、发送请求及响应。 同域名下所有通信都在单个连接上完成；每个连接可以承载任意数量的消息；消息由一个或多个帧组成，多个帧之间可以乱序发送，最后可以根据帧首部的流标识重新组合。从而实现低延迟，提升效率。 Header压缩 HTTP2.0使用encoder来减少需要传输的Header大小，客户端与服务端各自保存一份Header fields表，避免重复header传输，减少传输大小，实现高吞吐量。 父主题： API管理

操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上，单击“查看控制台”或实例名称。 单击“配置参数”页签，找到您需要调整的配置项并进行修改。不同的实例规格展示的配置参数会存在不同，具体以界面为准。 表1 实例配置参数说明 信息项 描述 ratelimit_api_limits API全局默认流控值，默认值为200次/秒。API未绑定流控策略时，执行此默认流控；API绑定流控策略时，则执行绑定的流控策略。流控策略的API流量限制值不能超过API全局默认流控值。 request_body_size API请求中允许携带的Body大小上限，默认值为12MB。 backend_timeout 后端响应超时时间上限，默认值为60000ms，可修改范围为1ms~600000ms。 app_token app_token认证方式开关，默认关闭。启用后，可在API请求中使用获取的access_token进行API的调用认证。 app_token_expire_time：access_token的有效时间，在access_token到期前，请及时获取新的access_token并更新，避免影响正常使用。 refresh_token_expire_time：refresh_token的有效时间。refresh_token用于获取新的access_token。 app_token_uri：获取access_token的uri。 app_token_key：access_token的加密key。 app_api_key app_api_key认证方式开关，默认关闭。启用后，可在API请求中添加“apikey”参数，携带凭据的Key进行API的调用认证。 app_basic app_basic认证方式开关，默认关闭。启用后，在API请求中添加Header参数“Authorization”，参数值为"Basic"+base64(appkey:appsecret)，其中appkey和appsecret分别为凭据的Key和Secret。 app_secret app_secret认证方式开关，默认关闭。启用后，可在API请求中添加“X-HW-ID”和“X-HW-AppKey”参数，携带凭据的Key和Secret进行API的调用认证。 app_route 支持IP访问开关，默认关闭。启用后，非DEFAULT分组下的APP认证的API可以使用IP地址调用。 backend_client_certificate 后端双向认证开关，默认关闭。启用后，创建API配置后端服务时，可配置后端双向认证。 ssl_ciphers 支持配置https加密套件，默认所有的加密套件全部支持。当您绑定独立域名后，可根据需要选择支持的加密套件。 real_ip_from_xff 是否使用X-Forwarded-For头中的IP作为ACL、流控的判断依据，默认不使用。 xff_index：X-Forwarded-For头中IP的排序序号，值允许为正数、负数、0。 xff_index值为0或正数时，获取X-Forwarded-For头中对应索引的IP。 xff_index值为负数时，按倒序方式从X-Forwarded-For头中获取IP。 例如到达API网关的X-Forwarded-For头中依次有IP1，IP2，IP3三个IP地址，xff_index取0时获取IP1，xff_index取1时获取IP2，xff_index取-1时获取IP3，xff_index取-2时获取IP2。 vpc_name_modifiable 负载通道名称是否可修改，默认可修改。 须知： 负载通道名称可修改时，当前实例的负载通道无法通过项目级负载通道管理接口操作。 app_jwt_enable app_jwt认证方式开关，默认关闭。启用后，可在API请求中添加“Authorization”和“Timestamp”参数，携带凭据的Key和Secret以及时间戳进行API的调用认证。 app_jwt_auth_header：app_jwt认证头，即API请求中携带app_jwt认证信息的Header参数，默认为Authorization。 public_key_enable public_key类型签名密钥开关，默认关闭。启用后，可在签名密钥认证中使用public_key类型签名。 public_key_uri_prefix：获取public_key对应secret的uri前缀。具体uri格式为：https://{虚拟私有云访问地址}{public_key_uri_prefix}{public_key签名密钥名称}。 custom_auth_header 认证头域自定义配置开关，默认关闭。启用后，参数“app_auth_header”和“backend_sign_header”的初始值为空，与不启用效果一致。 如果配置“app_auth_header”的“参数运行值”，那么对于APP认证的API，请求header中携带APP认证信息的参数为此处“app_auth_header”的值；如果配置“backend_sign_header”的“参数运行值”，那么对于绑定HMAC或者Basic Auth类型签名密钥策略的API，API网关到后端服务的请求header中携带签名信息的参数为此处“backend_sign_header”的值。 须知： 配置后会影响当前实例下所有APP认证或签名密钥策略（HMAC/Basic Auth类型），请谨慎配置。 gzip 对响应请求使用gzip压缩，用于减少公网流量。默认未配置gzip压缩，配置后1分钟生效，请谨慎修改。 启用后，可配置comp_level参数，comp_level表示压缩级别，值越大表示性能消耗越大，一般默认为6。 须知： 响应请求体大于1KB时，您可以使用gzip压缩文件（即1KB以下的文件不做压缩）。 gzip压缩支持的文件类型有text/xml、text/plain、text/css、application/javascript、application/x-javascript、application/rss+xml、text/javascript、image/tiff、image/svg+xml、application/json、application/xml 启用gzip压缩后，须在请求中添加请求头“Accept-Encoding: gzip”。 gzip配置完成后，如需修改，至少需要1分钟后。 custom_log 自定义日志功能开关，默认关闭。开启自定义日志功能后，实例下所有API的调用日志中会在指定位置打印指定参数的值。 启用后，需单击“编辑”，添加需在调用日志中打印的参数。 须知： 自定义日志只支持打印由客户端发起的请求信息，不支持打印在APIG中定义的常量参数和系统参数。 自定义日志最多可配置10个字段，且字段大小总和不得超过2KB。 参数值中的部分特殊字符会进行编码，例如：加号（+）会被编码为空格“ ”，双引号（"）会被编码为“\x22”，反斜杠（\）会被编码为“\x5C”。 sse_strategy SSE传输策略开关，默认关闭。启用后，支持通过使用Server-Sent Events (SSE)按照流式输出API的响应内容，可以实现逐字符渲染。 须知： sse_strategy配置完成后，如需修改，至少需要1分钟后。 request_custom_config 支持自定义配置客户端请求相关参数。 HTTP/2：HTTP/2协议的开关，默认为开启状态。更多详情请参考支持HTTP2.0。 request_body_timeout：客户端请求体超时时间的修改，默认为8s。网络状况差或请求体过大的情况下可适当调整该参数。 须知： 客户端请求自定义配置修改完成后，如需修改，至少需要1分钟后。

请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 transId 否 String 最大长度：64 交易序列号，用于防止重复提交。 如果接口调用方不传，则企业管理微服务后台生成。 如果接口调用方传入，则请采用UUID保证全局唯一。 此参数不携带或携带值为null或携带值为空串时，由系统自动生成。 balanceType 否 String 最大长度：64 账户类型： BALANCE_TYPE_DEBIT：余额账户（默认）； BALANCE_TYPE_CREDIT：信用账户。 此参数不携带或携带值为null时，默认为余额账户；不支持携带值为空串。 subCustomerId 是 String 最大长度：64 企业子账号的客户ID。 deductMode 是 String 最大长度：10 资金扣减模式。 1：服务端按金额扣减。 totalRetrieveAmout 是 String 最大长度：32 总回收金额。 单位：元。取值大于0且精确到小数点后2位。 expireTime 否 String 最大长度：20 账户到期时间，UTC时间，格式为：2016-03-28T14:45:38Z。 暂只对信用账户有效，用于限制针对有效期到期时间等于该时间的信用账户余额进行回收。如果查询信用账户可回收余额的查询结果没有失效时间，表示永久有效，对于这种账本的回收的时候不用填写。 当信用账户存在过期时间，该字段必须携带，不支持携带值为空串或携带值为null，否则回收失败； 当信用账户不存在过期时间，该字段无需携带，不支持携带值为空串，否则回收失败。 请求示例 POST https://bss.myhuaweicloud.com/v1.0/{domain_id}/customer/account-mgr/retrieve HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "transId": "33", "balanceType": "BALANCE_TYPE_DEBIT", "subCustomerId": "e8a*****b9c", "deductMode": "1", "totalRetrieveAmout": "1.00", "expireTime": "2018-12-31T15:59:59Z" }

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 错误描述 400 CBC.0100 参数错误。 403 CBC.0151 访问拒绝。 400 CBC.99000047 账户不存在。 400 CBC.99005003 余额不足。 400 CBC.99007004 发起的业务操作存在不满足的业务检查项。 400 CBC.99007461 您当前存在尚未完成的拨款或回收任务，请稍后再试。 500 CBC.7181 划拨或回收的信用额度的有效期已过期。 500 CBC.0999 其他错误。

新建集群 在集群的下拉列表中，单击“新建集群”。 根据表6，配置集群参数。 表6 集群参数说明 区域 参数 说明 基础配置 集群名称 用户自定义。 虚拟私有云 在下拉列表中选择虚拟私有云。 子网 子网的可用IP数需要大于等于迁移节点数+列举节点数+1。 迁移节点 ECS规格 推荐规格大于2U4G。 数量 设置的节点数量需要同时满足如下要求： 迁移节点数+列举节点数+1 ≤100 迁移节点数+列举节点数+1 ≤子网可用IP数 列举节点 ECS规格 推荐规格大于2U4G。 数量 设置的节点数量需要同时满足如下要求： 迁移节点数+列举节点数+1 ≤100 迁移节点数+列举节点数+1 ≤子网可用IP数 网络模式 公网 使用公网迁移，并选择公网网关。如果没有可用网关，选择“新建网关”，选择网关规格和EIP（EIP最多支持同时勾选20个）。 专线 使用专线迁移，输入允许转发或直接请求到专线的IP地址，如：Nginx、网关等。

过滤策略说明 过滤策略参数填写通配符规则说明和约束说明参见下表。 表7 过滤策略参数说明 参数 说明 填写规则 约束说明 黑名单 命中黑名单规则，则文件不进行迁移/一致性对比。支持精确匹配和模糊匹配。 精确匹配，填写文件绝对路径 全路径精确匹配，特殊字符用反斜杠（\）转义 模糊匹配 *匹配任何字符0个或者多个，但不匹配斜杠(/) 使用**匹配任何字符0个或者多个，包括斜杠(/) ?匹配除斜杠(/)之外的任何字符，只能匹配一个 {和}定义元素之间的选择：包含一个以逗号分隔的模式列表, 其中任何一种模式都可能匹配，可以包含通配符。 特殊字符可以在它们之前使用 \进行转义，\后面为通配符时，表示转义，否则表示\本身 除{ 和 } 以外，不能出现连续的规则符号，例如：***、*?、**?、?*、?**、*{*、*}*、*}?、?{*、{*}、{,}、{*,、 ,*}、,*,。 { 和 } 之间的模式，只能使用*做通配符。 { 和 } 之间的模式，不能有{}嵌套。 文件绝对路径在黑名单和白名单同时命中，则黑名单生效，即不做迁移。 需要配置多个匹配规则时，用英文分号隔开。 白名单 白名单为空时，迁移所有文件。 白名单不为空时，仅对绝对路径命中白名单规则的文件进行迁移/一致性对比。 时间段 配置时间段，根据配置，迁移最后修改时间在配置时间段内的文件或者文件夹。 开始时间和结束时间可以配置为空，为空时表示不限制，时间可以精确到分钟。

配置SSO单点客户端 以Navicat客户端为例，示例配置客户端路径。 打开本地SsoDBSettings单点登录工具。 图2 单点登录工具界面 在“Navicat路径”栏后，单击路径配置。 根据本地Navicat客户端安装的绝对路径，选中Navicat工具的exe文件后，单击“打开”。 图3 查找本地工具绝对路径 返回SsoDBSettings单点登录工具配置界面，可查看已选择的Navicat客户端路径。 图4 确认配置路径 单击“保存”，返回云堡垒机“主机运维”列表页面，即可登录数据库资源。

准备工作 建议在源端内网环境中准备一台用于安装Edge的Windows主机，并确保该Windows主机满足以下要求： 可以连接外网。 PowerShell 版本在5.0及以上。 源端主机需要对安装Edge的Windows主机开放指定端口： Windows开放5985端口。 Linux开放22端口。 关闭用于安装Edge的Windows主机上的杀毒、防护类软件，该类软件会拦截Edge的执行，导致迁移工作流执行失败。 如果源端是Windows主机，需要开放WinRM远程访问。可通过cmd 命令行执行如下命令，输入y确认开放： winrm quickconfig 已注册华为帐号并开通华为云，并获取帐号的AK/SK。 已在MgC控制台创建迁移项目。