华为云用户手册

  • max_process_memory_auto_adjust 参数说明:设置是否开启max_process_memory参数的自动调整功能(该参数仅8.2.0及以上集群版本支持)。对于单机器单DN部署形态的集群,开启情况下,CM会在主备切换情况下,动态调整对应DN节点上的max_process_memory参数值,调整max_process_memory的计算公式为:(物理内存大小 – vm.min_free_kbytes)* 0.8 / 主DN个数。 参数类型:SIGHUP 取值范围:布尔型 默认值:on 设置建议:建议设置为on,对于单机器单DN部署形态的集群,为提高内存资源利用率,max_process_memory参数的初始值在8.2.0集群版本开始进行了提升,但在主备切换场景下,两个主DN节点会同时在一个机器上,如果仍然使用max_process_memory初始值,机器可能出现OOM报错的情况,因此,需要CM介入来动态调整max_process_memory。 若max_process_memory_auto_adjust参数为off,max_dynamic_memory的值不会随着max_process_memory的值调整而修改。需要重启集群生效。 若max_process_memory_auto_adjust参数为on,max_dynamic_memory的值会随着max_process_memory的值调整而在线修改。
  • shared_buffers 参数说明:设置GaussDB(DWS)使用的共享内存大小。增加此参数的值会使GaussDB(DWS)比系统默认设置需要更多的System V共享内存。 参数类型:POSTMASTER 取值范围:整型,128~INT_MAX,单位为8KB。 改变BLCKSZ的值会改变最小值。 默认值:CN节点为DN节点值的1/2,DN节点取公式计算:POWER(2,ROUND(LOG(2,max_process_memory/18),0))。如果操作系统支持的共享内存小于32MB,则在初始化数据存储区时会自动调整为操作系统支持的最大值。 设置建议: 由于GaussDB(DWS)大部分查询下推,建议DN中此参数设置比CN大。 建议设置shared_buffers值为内存的40%以内。行存列存分开对待。行存设大,列存设小。列存:(单服务器内存/单服务器DN个数)*0.4*0.25。 如果设置较大的shared_buffers需要同时增加checkpoint_segments的值,因为写入大量新增、修改数据需要消耗更多的时间周期。
  • 示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 BEGIN FOR ROW_TRANS IN SELECT first_name FROM staffs LOOP DBMS_OUTPUT.PUT_LINE (ROW_TRANS.first_name ); END LOOP; END; / --创建表 CREATE TABLE integerTable1( A INTEGER) DISTRIBUTE BY hash(A); CREATE TABLE integerTable2( B INTEGER) DISTRIBUTE BY hash(B); INSERT INTO integerTable2 VALUES(2); --多游标共享游标属性的标量 DECLARE CURSOR C1 IS SELECT A FROM integerTable1;--声明游标 CURSOR C2 IS SELECT B FROM integerTable2; PI_A INTEGER; PI_B INTEGER; BEGIN OPEN C1;--打开游标 OPEN C2; FETCH C1 INTO PI_A; ---- C1%FOUND 和 C2%FOUND 值为 FALSE FETCH C2 INTO PI_B; ---- C1%FOUND 和 C2%FOUND 的值都为 TRUE --判断游标状态 IF C1%FOUND THEN IF C2%FOUND THEN DBMS_OUTPUT.PUT_LINE('Dual cursor share paremeter.'); END IF; END IF; CLOSE C1;--关闭游标 CLOSE C2; END; / --删除临时表 DROP TABLE integerTable1; DROP TABLE integerTable2;
  • 功能介绍 表1 功能介绍 功能 描述 相关操作 设备列表 DSC支持将应用数据审计设备、应用数据安全网关设备、数据库防火墙设备、数据库加密设备添加至设备列表,方便查看和管理。 设备列表 设备监控 DSC会对设备状态进行监控,详细的展示设备当前的CPU、内存使用率以及剩余磁盘情况,供您及时查看设备状态。 设备监控 设备告警 DSC会将检测到的设备告警展示在设备告警列表,可以通过单击“忽略”或者“标记为已处理”对设备告警进行处理。 设备告警
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。 权限:允许或拒绝某项操作。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 权限 授权项 查询OBS资产列表 dsc:obsAsset:list 更新DSC扫描任务规则 scanRule:update 添加大数据资产 dsc:bigdataAsset:create 查询DSC扫描任务规则列表 dsc:scanRule:list 添加OBS资产 dsc:obsAsset:create 查询rds列表 dsc:rds:list 删除数据库资产 dsc:databaseAsset:delete 创建DSC扫描任务规则 dsc:scanRule:create 删除DSC扫描任务 dsc:scanTask:delete 查询DSC服务授权信息 dsc:authorization:get 查询RDS数据库列表 dsc:rdsDatabase:list 更新DSC扫描任务 dsc:scanTask:update 查询CSS列表 dsc:css:list 创建DSC扫描任务 dsc:scanTask:create 授予DSC服务用户操作权限 dsc:authorization:grant 查询大数据资产列表 dsc:bigdataAsset:list 查询DSC扫描任务列表 dsc:scanTask:list 添加数据库资产 dsc:databaseAsset:create 删除DSC扫描任务规则 dsc:scanRule:delete 查询数据库资产列表 dsc:databaseAsset:list 删除OBS资产 dsc:obsAsset:delete 删除大数据资产 dsc:bigdataAsset:delete DSC通用资源操作权限 dsc:common:operate DSC通用资源查询权限 dsc:common:list
  • 包年/包月资源 对于包年/包月计费模式的资源,例如包年/包月的CloudTable集群,用户在购买时会一次性付费,服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。 如果您已开启“自动续费”功能,为避免继续产生费用,请在自动续费扣款日(默认为到期前7日)之前关闭自动续费。
  • 在续费管理页面开通自动续费 登录管理控制台。 单击“控制台”页面上方“费用与成本”,在下拉菜单中选择“续费管理”。 进入“续费管理”页面。 自定义查询条件。 可在“自动续费项”页签查询已经开通自动续费的资源。 可对“手动续费项”、“到期转按需项”、“到期不续费项”页签的资源开通自动续费。 为包年/包月资源开通自动续费。 单个资源开通自动续费:选择需要开通自动续费的云服务器,单击操作列“开通自动续费”。 图2 单个资源开通自动续费 批量资源开通自动续费:选择需要开通自动续费的云服务器,单击列表左上角的“开通自动续费”。 图3 多个资源开通自动续费 选择续费时长,并根据需要设置自动续费次数,单击“开通”。 在“续费管理”页面开通的自动续费,自动续费周期以实际选择的续费时长以及自动续费次数为准。例如:您选择了续费时长3个月,不限次数,即在每次到期前自动续费3个月。 图4 开通自动续费
  • 续费相关的功能 包年/包月智能数据洞察(DataArts Insight)续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 包年/包月云服务器从购买到被自动删除之前,您可以随时在智能数据洞察(DataArts Insight)控制台为云服务器续费,以延长云服务器的使用时间。 自动续费 开通自动续费后,云服务器会在每次到期前自动续费,避免因忘记手动续费而导致资源被自动删除。 在一台包年/包月云服务器生命周期的不同阶段,您可以根据需要选择一种方式进行续费,具体如图1所示。 图1 云服务器生命周期 智能数据洞察(DataArts Insight)实例从购买到到期前,处于正常运行阶段,资源状态为“运行中”。 到期后,资源状态变为“已过期”。 到期未续费时,智能数据洞察(DataArts Insight)首先会进入宽限期,宽限期到期后仍未续费,资源状态变为“已冻结”。 超过宽限期仍未续费将进入保留期,如果保留期内仍未续费,资源将被自动删除。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 在DataArts Insight到期前均可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败,每天凌晨3:00尝试一次,直至云服务器到期或者续费成功。到期前7日自动续费扣款是系统默认配置,您也可以根据需要修改此扣款日。
  • 续费简介 包年/包月云服务器到期后会影响云服务器正常运行。如果您想继续使用,需要在指定的时间内为云服务器续费,否则账号下的资源会被冻结,当冻结期到期后账号下的资源会自动释放丢失且不可恢复。 续费操作仅适用于包年/包月云服务器,按需计费云服务器不需要续费,只需要保证账户余额充足即可。 智能数据洞察(DataArts Insight)在到期前续费成功,所有资源得以保留,且云服务器的运行不受影响。云服务器到期后的状态说明,请参见到期后影响。
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/ott/channels/encorder-settings { "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test", "encoder_settings" : [ { "template_id" : "ld" } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项 sources Array of SourceRsp objects 推流URL列表。创建频道时,只有入流协议为RTMP_PUSH时,会返回推流URL列表 表6 SourceRsp 参数 参数类型 描述 url String RTMP推流地址 bitrate Integer 码率。 单位:bps。取值范围:0 - 104,857,600(100Mbps) width Integer 分辨率对应宽的值。取值范围:0 - 4096(4K) height Integer 分辨率对应高的值。取值范围:0 - 2160(4K) enable_snapshot Boolean 描述是否使用该流做截图 状态码: 400 表7 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项
  • 响应示例 状态码: 200 Demo Information { "result_code" : "LIVE.100000000", "result_msg" : "SUCCESS", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test" } 状态码: 400 Error response { "result_code" : "LIVE.103011019", "result_msg" : "The resource to access is not exists", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test2" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Access-Control-Allow-Internal 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-Internal访问服务。 Access-Control-Allow-External 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-External访问服务。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 频道推流域名 app_name 是 String 组名或应用名 id 是 String 频道ID。频道唯一标识,为必填项 encoder_settings 否 Array of encoder_settings objects 转码模板配置 表4 encoder_settings 参数 是否必选 参数类型 描述 template_id 否 String 转码模板ID
  • 响应示例 状态码: 200 Demo Information { "result_code" : "LIVE.100000000", "result_msg" : "SUCCESS", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test" } 状态码: 400 Error response { "result_code" : "LIVE.100011001", "result_msg" : "param check failed", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "" }
  • 响应参数 状态码: 200 表14 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项 sources Array of SourceRsp objects 推流URL列表。创建频道时,只有入流协议为RTMP_PUSH时,会返回推流URL列表 表15 SourceRsp 参数 参数类型 描述 url String RTMP推流地址 bitrate Integer 码率。 单位:bps。取值范围:0 - 104,857,600(100Mbps) width Integer 分辨率对应宽的值。取值范围:0 - 4096(4K) height Integer 分辨率对应高的值。取值范围:0 - 2160(4K) enable_snapshot Boolean 描述是否使用该流做截图 状态码: 400 表16 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/ott/channels/endpoints { "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test", "endpoints" : [ { "hls_package" : [ { "url" : "pull.testott.hls.com/ott/test/index.m3u8", "stream_selection" : [ { "key" : "sss", "max_bandwidth" : 1000, "min_bandwidth" : 100 } ], "hls_version" : "1", "segment_duration_seconds" : 4, "playlist_window_seconds" : 3600 } ], "dash_package" : [ { "url" : "pull.testott.hls.com/ott/test/index.mpd", "stream_selection" : [ { "key" : "bitrate=900000-1800000", "max_bandwidth" : 1800000, "min_bandwidth" : 900000 } ], "segment_duration_seconds" : 4, "playlist_window_seconds" : 3600 } ], "mss_package" : [ { "url" : "pull.testott.hls.com/ott/channel/manifest", "stream_selection" : [ { "key" : "bitrate=900000-1800000", "max_bandwidth" : 1800000, "min_bandwidth" : 900000 } ], "segment_duration_seconds" : 4, "playlist_window_seconds" : 3600 } ] } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Access-Control-Allow-Internal 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-Internal访问服务。 Access-Control-Allow-External 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-External访问服务。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 频道推流域名 app_name 是 String 组名或应用名 id 是 String 频道ID。频道唯一标识,为必填项 endpoints 否 Array of EndpointItem objects 频道出流信息 表4 EndpointItem 参数 是否必选 参数类型 描述 hls_package 否 Array of HlsPackageItem objects HLS打包信息 dash_package 否 Array of DashPackageItem objects DASH打包信息 mss_package 否 Array of MssPackageItem objects MSS打包信息 表5 HlsPackageItem 参数 是否必选 参数类型 描述 url 是 String 客户自定义的拉流地址,包括方法、域名、路径和参数 stream_selection 否 Array of StreamSelectionItem objects 从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。 hls_version 否 String HLS版本号 segment_duration_seconds 否 Integer 频道输出分片的时长,为必选项 单位:秒。取值范围:1-10 playlist_window_seconds 否 Integer 频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。 单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值) encryption 否 Encryption object 加密信息 ads 否 Object 广告配置 ext_args 否 Object 其他额外参数 request_args 否 PackageRequestArgs object 播放相关配置 表6 DashPackageItem 参数 是否必选 参数类型 描述 url 是 String 客户自定义的拉流地址,包括方法、域名、路径和参数 stream_selection 否 Array of StreamSelectionItem objects 从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。 segment_duration_seconds 否 Integer 频道输出分片的时长,为必选项 单位:秒。取值范围:1-10 playlist_window_seconds 否 Integer 频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。 单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值) encryption 否 Encryption object 加密信息 ads 否 Object 广告配置 ext_args 否 Object 其他额外参数 request_args 否 PackageRequestArgs object 播放相关配置 表7 MssPackageItem 参数 是否必选 参数类型 描述 url 是 String 客户自定义的拉流地址,包括方法、域名、路径和参数 stream_selection 否 Array of StreamSelectionItem objects 从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。 segment_duration_seconds 否 Integer 频道输出分片的时长,为必选项 单位:秒。取值范围:1-10 playlist_window_seconds 否 Integer 频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。 单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值) encryption 否 Encryption object 加密信息 ext_args 否 Object 其他额外参数 delay_segment 否 Integer 延播时长,单位秒 request_args 否 PackageRequestArgs object 播放相关配置 表8 StreamSelectionItem 参数 是否必选 参数类型 描述 key 否 String 拉流URL中用于码率过滤的参数 max_bandwidth 否 Integer 最大码率,单位:bps 取值范围:0 - 104,857,600(100Mbps) min_bandwidth 否 Integer 最小码率,单位:bps 取值范围:0 - 104,857,600(100Mbps) 表9 Encryption 参数 是否必选 参数类型 描述 key_rotation_interval_seconds 否 Integer 密钥缓存时间。如果密钥不变,默认缓存七天 encryption_method 否 String 加密方式 level 否 String 取值如下: content:一个频道对应一个密钥 profile:一个码率对应一个密钥 默认值:content drm_content_id 是 String 客户生成的DRM内容ID system_ids 是 Array of strings system_id枚举值 auth_info 是 String 增加到请求消息体header中的鉴权信息 km_url 是 String 获取密钥的DRM地址 表10 PackageRequestArgs 参数 是否必选 参数类型 描述 record 否 Array of RecordRequestArgs objects 录制播放相关配置 timeshift 否 Array of TimeshiftRequestArgs objects 时移播放相关配置 live 否 Array of LiveRequestArgs objects 直播播放相关配置 表11 RecordRequestArgs 参数 是否必选 参数类型 描述 start_time 否 String 开始时间 end_time 否 String 结束时间 format 否 String 格式 unit 否 String 单位 表12 TimeshiftRequestArgs 参数 是否必选 参数类型 描述 back_time 否 String 时移时长字段名 unit 否 String 单位 表13 LiveRequestArgs 参数 是否必选 参数类型 描述 delay 否 String 时延字段 unit 否 String 单位
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/ott/channels/record-settings { "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test", "record_settings" : { "rollingbuffer_duration" : 3600 } }
  • 响应示例 状态码: 200 Demo Information { "result_code" : "LIVE.100000000", "result_msg" : "SUCCESS", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test" } 状态码: 400 Error response { "result_code" : "LIVE.103011019", "result_msg" : "The resource to access is not exists", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test2" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项 sources Array of SourceRsp objects 推流URL列表。创建频道时,只有入流协议为RTMP_PUSH时,会返回推流URL列表 表6 SourceRsp 参数 参数类型 描述 url String RTMP推流地址 bitrate Integer 码率。 单位:bps。取值范围:0 - 104,857,600(100Mbps) width Integer 分辨率对应宽的值。取值范围:0 - 4096(4K) height Integer 分辨率对应高的值。取值范围:0 - 2160(4K) enable_snapshot Boolean 描述是否使用该流做截图 状态码: 400 表7 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Access-Control-Allow-Internal 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-Internal访问服务。 Access-Control-Allow-External 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-External访问服务。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 频道推流域名 app_name 是 String 组名或应用名 id 是 String 频道ID。频道唯一标识,为必填项 record_settings 否 record_settings object 最大回看录制时长。在此时间段内会连续不断的录制,为必选项 单位:秒。取值为“0”时,表示不支持录制;最大支持录制14天 表4 record_settings 参数 是否必选 参数类型 描述 rollingbuffer_duration 否 Integer 最大回看录制时长。在此时间段内会连续不断的录制,为必选项 单位:秒。取值为“0”时,表示不支持录制;最大支持录制14天。
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项 sources Array of SourceRsp objects 推流URL列表。创建频道时,只有入流协议为RTMP_PUSH时,会返回推流URL列表 表9 SourceRsp 参数 参数类型 描述 url String RTMP推流地址 bitrate Integer 码率。 单位:bps。取值范围:0 - 104,857,600(100Mbps) width Integer 分辨率对应宽的值。取值范围:0 - 4096(4K) height Integer 分辨率对应高的值。取值范围:0 - 2160(4K) enable_snapshot Boolean 描述是否使用该流做截图 状态码: 400 表10 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/ott/channels/input { "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test", "input" : { "input_protocol" : "RTMP_PUSH", "sources" : [ { "width" : 100, "bitrate_for3u8" : false, "enable_snapshot" : false, "bitrate" : 1024, "passphrase" : "", "url" : "http://192.168.8.158/ott/adtestdrm.flv?vhost=pull.testott.hls.com", "height" : 100 } ] } }
  • 响应示例 状态码: 200 Demo Information { "result_code" : "LIVE.100000000", "result_msg" : "SUCCESS", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test" } 状态码: 400 Error response { "result_code" : "LIVE.103011019", "result_msg" : "The resource to access is not exists", "domain" : "push.testott.hls.com", "app_name" : "test", "id" : "test-abc" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Access-Control-Allow-Internal 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-Internal访问服务。 Access-Control-Allow-External 否 String 服务鉴权Token,服务开启鉴权,必须携带Access-Control-Allow-External访问服务。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 频道推流域名 app_name 是 String 组名或应用名 id 是 String 频道ID。频道唯一标识,为必填项 input 否 InputStreamInfo object 频道出流信息 表4 InputStreamInfo 参数 是否必选 参数类型 描述 input_protocol 是 String 频道入流协议 FLV_PULL RTMP_PUSH RTMP_PULL HLS_PULL SRT_PULL SRT_PUSH sources 否 Array of SourcesInfo objects 频道主源流信息。入流协议为RTMP_PUSH和SRT_PUSH时,非必填项。其他情况下,均为必填项。 secondary_sources 否 Array of SecondarySourcesInfo objects 备入流数组,非必填项。如果有备入流,则主备入流必须保证路数、codec和分辨率均一致。入流协议为RTMP_PUSH时,无需填写。 failover_conditions 否 FailoverConditions object 有主备入流时,当前参数为必选。入流协议为RTMP_PUSH时,无需填写。 max_bandwidth_limit 否 Integer 当入流协议为HLS_PULL时,最大带宽限制。 未配置会默认选择BANDWIDTH最高的流 ip_port_mode 否 Boolean 当推流协议为SRT_PUSH时,如果配置了直推源站,编码器不支持输入streamid,需要打开设置为true 表5 SourcesInfo 参数 是否必选 参数类型 描述 url 否 String 频道源流URL,用于外部拉流 bitrate 否 Integer 码率。无需直播转码时,此参数为必填项 单位:bps。取值范围:0 - 104,857,600(100Mbps) width 否 Integer 分辨率对应宽的值,非必填项 取值范围:0 - 4096(4K) height 否 Integer 分辨率对应高的值,非必填项 取值范围:0 - 2160(4K) enable_snapshot 否 Boolean 描述是否使用该流做截图 bitrate_for3u8 否 Boolean 是否使用bitrate来固定码率。默认值:false passphrase 否 String 协议为SRT_PUSH时的加密信息 backup_urls 否 Array of strings 备入流地址列表 stream_id 否 String 协议为SRT_PULL时,拉流地址的streamid latency 否 Integer 协议为SRT_PULL时,拉流时延 表6 SecondarySourcesInfo 参数 是否必选 参数类型 描述 url 否 String 频道源流URL,用于外部拉流 bitrate 否 Integer 码率。无需直播转码时,此参数为必填项 单位:bps。取值范围:0 - 104,857,600(100Mbps) width 否 Integer 分辨率对应宽的值,非必填项 取值范围:0 - 4096(4K) height 否 Integer 分辨率对应高的值,非必填项 取值范围:0 - 2160(4K) bitrate_for3u8 否 Boolean 是否使用bitrate来固定码率。默认值:false passphrase 否 String 协议为SRT_PUSH时的加密信息 backup_urls 否 Array of strings 备入流地址列表 stream_id 否 String 协议为SRT_PULL时,拉流地址的streamid latency 否 Integer 协议为SRT_PULL时,拉流时延 表7 FailoverConditions 参数 是否必选 参数类型 描述 input_loss_threshold_msec 否 Integer 入流停止的时长阈值。到达此阈值后,自动触发主备切换 单位:毫秒,取值范围:0 - 3600000 input_preference 否 String 以主入流URL为第一优先级(PRIMARY)或主备URL平等切换(EQUAL) 如果为平等切换时使用的是备URL,无需手工切换到主URL
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,$ADMIN_PASS表示用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "$ADMIN_PASS", //建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项 sources Array of SourceRsp objects 推流URL列表。创建频道时,只有入流协议为RTMP_PUSH时,会返回推流URL列表 表5 SourceRsp 参数 参数类型 描述 url String RTMP推流地址 bitrate Integer 码率。 单位:bps。取值范围:0 - 104,857,600(100Mbps) width Integer 分辨率对应宽的值。取值范围:0 - 4096(4K) height Integer 分辨率对应高的值。取值范围:0 - 2160(4K) enable_snapshot Boolean 描述是否使用该流做截图 状态码: 400 表6 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名,为必填项 id String 频道ID。频道唯一标识,为必填项
共100000条