华为云用户手册

响应参数 状态码： 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。频道唯一标识，为必填项

请求参数 表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。频道唯一标识，为必填项。频道ID不建议输入下划线“_”，否则会影响转码和截图任务 state 是 String 频道状态 ON：频道下发成功后，自动启动拉流、转码、录制等功能 OFF：仅保存频道信息，不启动频道

响应示例 状态码： 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" : "test" }

请求参数 表3 请求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访问服务。

响应参数 状态码： 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。频道唯一标识，为必填项

响应示例 状态码： 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" : "test22" }

响应参数 状态码： 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。频道唯一标识，为必填项

请求参数 表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。频道唯一标识，为必填项 name 是 String 频道名称

响应示例 状态码： 201 Demo Information { "result_code" : "LIVE.100000000", "result_msg" : "SUCCESS", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test", "sources" : [ { "url" : "rtmp://push.testott.hls.com/ott/test_1024?request_source=ott&channel_id=test", "bitrate" : 1024, "width" : 100, "height" : 100 } ] } 状态码： 400 Error response { "result_code" : "LIVE.100011001", "result_msg" : "output url pull.testott.hls.com/ott/test/index.m3u8 is exist", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test" }

响应参数 状态码： 201 表20 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名，为必填项 id String 频道ID。频道唯一标识，为必填项 sources Array of SourceRsp objects 推流URL列表。创建频道时，只有入流协议为RTMP_PUSH时，会返回推流URL列表 表21 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 表22 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名，为必填项 id String 频道ID。频道唯一标识，为必填项

请求示例 POST https://{endpoint}/v1/{project_id}/ott/channels { "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test", "name" : "testname", "input" : { "input_protocol" : "RTMP_PUSH", "sources" : [ { "url" : "http://192.168.0.1/ott/test.flv?vhost=pull.testott.hls.com", "bitrate" : 1024, "width" : 100, "height" : 100 } ], "failover_conditions" : { "input_loss_threshold_msec" : 100, "input_preference" : "EQUAL" } }, "record_settings" : { "rollingbuffer_duration" : 86400 }, "endpoints" : [ { "hls_package" : [ { "url" : "pull.testott.hls.com/ott/test/index.m3u8", "stream_selection" : [ { "key" : "sss", "max_bandwidth" : 100, "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 } ] } ], "state" : "OFF" }

请求参数 表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。频道唯一标识，为必填项。频道ID不建议输入下划线“_”，否则会影响转码和截图任务 name 否 String 频道名。可选配置 state 是 String 频道状态 ON：频道下发成功后，自动启动拉流、转码、录制等功能 OFF：仅保存频道信息，不启动频道 input 是 InputStreamInfo object 频道入流信息 encoder_settings 否 Array of encoder_settings objects 转码模板配置 record_settings 是 record_settings object 最大回看录制时长。在此时间段内会连续不断的录制，为必选项 单位：秒。取值为“0”时，表示不支持录制；最大支持录制14天 endpoints 是 Array of EndpointItem objects 频道出流信息 表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 表8 encoder_settings 参数 是否必选 参数类型 描述 template_id 否 String 转码模板ID 表9 record_settings 参数 是否必选 参数类型 描述 rollingbuffer_duration 是 Integer 最大回看录制时长。在此时间段内会连续不断的录制，为必选项 单位：秒。取值为“0”时，表示不支持录制；最大支持录制14天 表10 EndpointItem 参数 是否必选 参数类型 描述 hls_package 否 Array of HlsPackageItem objects HLS打包信息 dash_package 否 Array of DashPackageItem objects DASH打包信息 mss_package 否 Array of MssPackageItem objects MSS打包信息 表11 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 播放相关配置 表12 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 播放相关配置 表13 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 播放相关配置 表14 StreamSelectionItem 参数 是否必选 参数类型 描述 key 否 String 拉流URL中用于码率过滤的参数 max_bandwidth 否 Integer 最大码率，单位：bps 取值范围：0 - 104,857,600（100Mbps） min_bandwidth 否 Integer 最小码率，单位：bps 取值范围：0 - 104,857,600（100Mbps） 表15 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地址 表16 PackageRequestArgs 参数 是否必选 参数类型 描述 record 否 Array of RecordRequestArgs objects 录制播放相关配置 timeshift 否 Array of TimeshiftRequestArgs objects 时移播放相关配置 live 否 Array of LiveRequestArgs objects 直播播放相关配置 表17 RecordRequestArgs 参数 是否必选 参数类型 描述 start_time 否 String 开始时间 end_time 否 String 结束时间 format 否 String 格式 unit 否 String 单位 表18 TimeshiftRequestArgs 参数 是否必选 参数类型 描述 back_time 否 String 时移时长字段名 unit 否 String 单位 表19 LiveRequestArgs 参数 是否必选 参数类型 描述 delay 否 String 时延字段 unit 否 String 单位

响应示例 状态码： 200 Demo Information { "total" : 1, "channels" : [ { "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test", "name" : "testname", "input" : { "input_protocol" : "RTMP_PUSH", "sources" : [ { "url" : "rtmp://push.testott.hls.com/ott/test_1024?request_source=ott&channel_id=test", "bitrate" : 1024, "width" : 100, "height" : 100 } ], "failover_conditions" : { "input_loss_threshold_msec" : 100, "input_preference" : "EQUAL" } }, "record_settings" : { "rollingbuffer_duration" : 86400 }, "endpoints" : [ { "hls_package" : [ { "url" : "pull.testott.hls.com/ott/test/index.m3u8", "stream_selection" : [ { "key" : "sss", "max_bandwidth" : 0, "min_bandwidth" : 0 } ], "segment_duration_seconds" : 4, "playlist_window_seconds" : 3600, "request_args" : { "record" : [ { "start_time" : "begin", "end_time" : "end", "format" : "timestamp", "unit" : "second" } ], "timeshift" : [ { "back_time" : "begin", "unit" : "second" } ], "live" : null }, "hls_version" : "1" } ], "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, "request_args" : { "record" : [ { "start_time" : "begin", "end_time" : "end", "format" : "timestamp", "unit" : "second" } ], "timeshift" : [ { "back_time" : "begin", "unit" : "second" } ], "live" : null } } ], "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, "request_args" : { "record" : [ { "start_time" : "begin", "end_time" : "end", "format" : "timestamp", "unit" : "second" } ], "timeshift" : [ { "back_time" : "begin", "unit" : "second" } ], "live" : null } } ] } ], "state" : "OFF" } ] } 状态码： 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" : "agbc" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总频道数 channels Array of CreateOttChannelInfoReq objects 频道信息 表5 CreateOttChannelInfoReq 参数 参数类型 描述 domain String 频道推流域名 app_name String 组名或应用名 id String 频道ID。频道唯一标识，为必填项。频道ID不建议输入下划线“_”，否则会影响转码和截图任务 name String 频道名。可选配置 state String 频道状态 ON：频道下发成功后，自动启动拉流、转码、录制等功能 OFF：仅保存频道信息，不启动频道 input InputStreamInfo object 频道入流信息 encoder_settings Array of encoder_settings objects 转码模板配置 record_settings record_settings object 最大回看录制时长。在此时间段内会连续不断的录制，为必选项 单位：秒。取值为“0”时，表示不支持录制；最大支持录制14天 endpoints Array of EndpointItem objects 频道出流信息 表6 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 表7 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时，拉流时延 表8 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时，拉流时延 表9 FailoverConditions 参数 参数类型 描述 input_loss_threshold_msec Integer 入流停止的时长阈值。到达此阈值后，自动触发主备切换 单位：毫秒，取值范围：0 - 3600000 input_preference String 以主入流URL为第一优先级（PRIMARY）或主备URL平等切换（EQUAL） 如果为平等切换时使用的是备URL，无需手工切换到主URL 表10 encoder_settings 参数 参数类型 描述 template_id String 转码模板ID 表11 record_settings 参数 参数类型 描述 rollingbuffer_duration Integer 最大回看录制时长。在此时间段内会连续不断的录制，为必选项 单位：秒。取值为“0”时，表示不支持录制；最大支持录制14天 表12 EndpointItem 参数 参数类型 描述 hls_package Array of HlsPackageItem objects HLS打包信息 dash_package Array of DashPackageItem objects DASH打包信息 mss_package Array of MssPackageItem objects MSS打包信息 表13 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 播放相关配置 表14 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 播放相关配置 表15 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 播放相关配置 表16 StreamSelectionItem 参数 参数类型 描述 key String 拉流URL中用于码率过滤的参数 max_bandwidth Integer 最大码率，单位：bps 取值范围：0 - 104,857,600（100Mbps） min_bandwidth Integer 最小码率，单位：bps 取值范围：0 - 104,857,600（100Mbps） 表17 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地址 表18 PackageRequestArgs 参数 参数类型 描述 record Array of RecordRequestArgs objects 录制播放相关配置 timeshift Array of TimeshiftRequestArgs objects 时移播放相关配置 live Array of LiveRequestArgs objects 直播播放相关配置 表19 RecordRequestArgs 参数 参数类型 描述 start_time String 开始时间 end_time String 结束时间 format String 格式 unit String 单位 表20 TimeshiftRequestArgs 参数 参数类型 描述 back_time String 时移时长字段名 unit String 单位 表21 LiveRequestArgs 参数 参数类型 描述 delay String 时延字段 unit String 单位 状态码： 400 表22 响应Body参数 参数 参数类型 描述 result_code String 错误码 result_msg String 错误描述 domain String 推流域名 app_name String 组名或应用名，为必填项 id String 频道ID。频道唯一标识，为必填项

URI GET /v1/{project_id}/ott/channels 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 否 String 推流域名 app_name 否 String 组名或应用名 id 否 String 频道ID limit 否 Integer 每页记录数，取值范围[1,100]，默认值10 offset 否 Integer 偏移量。表示从此偏移量开始查询，offset大于等于0

请求参数 表3 请求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访问服务。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": $ADMIN_PASS, //IAM用户密码，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 resize_flavor 是 Object 请参见表3。 表3 resize_flavor字段数据结构说明 名称 是否必选 参数类型 说明 spec_code 是 String 资源规格编码。例如：rds.mysql.m1.xlarge。其中，rds代表RDS产品，mysql代表数据库引擎，m1.xlarge代表性能规格，为高内存类型。带"rr"的表示只读实例规格，反之表示单实例和HA实例规格。 is_auto_pay 否 Boolean 变更包周期实例的规格时可指定，表示是否自动从客户的账户中支付。 true，为自动支付。 false，为手动支付，默认该方式。

请求示例 变更MySQL数据库实例的规格为rds.mysql.m1.xlarge。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action { "resize_flavor": { "spec_code": "rds.mysql.m1.xlarge", "is_auto_pay": true } } 变更PostgreSQL数据库实例的规格为rds.pg.c2.medium.ha。 { "resize_flavor": { "spec_code": "rds.pg.c2.medium.ha", "is_auto_pay": true } } 变更SQL Server数据库实例的规格为rds.mssql.2014.se.s3.large.2。 { "resize_flavor": { "spec_code": "rds.mssql.2014.se.s3.large.2", "is_auto_pay": true } }

应用场景 广域网质量监控主要用于发送模拟真实用户对远端服务器的访问，从而探测远端服务器的可用性、连通性等问题。 服务可用性监控 通过使用广域网功能配置定时HTTP（S）拨测任务，选择分布在全球的探测点对域名进行HTTP（S）拨测，并根据协议拨测结果状态码识别服务的可用性，通过配置监控告警条件，可在出现异常状态时立马告警，并收到服务故障信息。此外，您还能观察到不同地域运营商线路探测点到服务的网络响应时间时延，了解不同地域运营商的用户访问时延体验，可为系统部署架构优化提供参考依据。 网络可用性分析 通过使用广域网质量监控功能配置定时PING探测任务，根据需要选择发起探测的不同国家地域的运营商探测节点，运行一段时间后可以观察到不同国家地域的运营商线路到目标服务的网络时延情况。

修订记录 发布日期 修改说明 2024-01-24 第七十次正式发布： 事件监控支持的事件说明新增“数据库代理”事件描述。 Agent版本特性更新Agent版本。 新增创建/删除/复制/修改通知模板章节。 2024-01-18 第六十九次正式发布： 新增跨账号查看我的看板章节。 2023-12-25 第六十八次正式发布： 事件监控支持的事件说明新增“云桌面”事件描述。 支持监控的服务列表中新增“企业连接的监控指标”。 2023-11-17 第六十七次正式发布： 支持监控的服务列表中新增“表格存储服务的监控指标”。 事件监控支持的事件说明新增“文档数据库服务”、“云硬盘”、“云数据库 GaussDB(for MySQL)”、“裸金属服务器 ”、“弹性云服务器 ”、“数据空间服务”、“凭据管理服务”事件描述。 2023-10-31 第六十六次正式发布： 新增数据转储章节。 2023-10-24 第六十五次正式发布： 优化全文整体架构。 新增监控概览章节。 新增监控看板（新版）章节。 更新创建资源分组步骤。 更新资源概览章节。 新增资源分组关联告警模板章节。 新增告警策略章节。 更新告警记录章节。 更新删除自定义告警模板章节。 新增复制自定义告警模板章节。 新增自定义告警模板关联资源分组章节。 新增导入导出自定义告警模板章节。 更新修改通知组章节。 更新删除通知对象/通知组章节。 下线查看通知组详情章节。 更新修改告警规则章节。 新增云服务监控章节。 更新创建站点监控章节。 更新创建站点监控的告警通知章节。 更新管理站点监控章节。 更新任务中心章节。 2023-08-28 第六十四次正式发布： 新增BMS硬件监控插件说明章节。 下线安装GPU ECC监控插件（Linux）章节。 2023-08-21 第六十三次正式发布： 更新Agent版本特性章节。 优化Agent安装说明章节。 下线一键配置插件说明章节。 下线安装GPU指标与RAID指标采集插件采集插件（Linux）章节。 支持监控的服务列表中新增“消息通知服务的监控指标”。 2023-06-30 第六十二次正式发布： 更新主机监控章节。 2023-06-21 第六十一次正式发布： 事件监控支持的事件说明新增“云证书管理服务”事件描述。 2023-06-15 第六十次正式发布： 新增告警屏蔽。 2023-06-08 第五十九次正式发布： 下线“安装BMS本地磁盘故障风险监控插件”章节和“安装BMS网卡故障风险监控插件”章节。 2023-05-30 第五十八次正式发布： 安装Agent（Linux）新增“华北-乌兰察布一”安装命令。 2023-03-06 第五十七次正式发布： 事件监控支持的事件说明新增“安全云脑”、“密钥对管理服务”、“镜像服务”、“企业主机安全服务”事件描述。 2023-01-10 第五十六次正式发布： 新增告警通知。 2022-12-06 第五十五次正式发布： 新增“安装BMS网卡故障风险监控插件”章节。 2022-10-31 第五十四次正式发布： 支持监控的服务列表中新增“DDoS防护的监控指标”。 2022-08-31 第五十三次正式发布： 新增“安装BMS本地磁盘故障风险监控插件”章节。 2022-07-15 第五十二次正式发布： 支持监控的服务列表中新增“云防火墙的监控指标”。 2022-07-06 第五十一次正式发布： 支持监控的服务列表中新增“全球加速的监控指标”。 支持监控的服务列表中新增“智能边缘小站的监控指标”。 2022-06-30 第五十次正式发布： 新增任务中心。 新增9.8.4-安装GPU ECC监控插件（Linux）。 2022-06-02 第四十九次正式发布： 支持监控的服务列表中新增“人证核身的监控指标”。 2020-05-30 第四十八次正式发布。 支持企业项目功能，在创建资源分组、创建告警规则和通知等相关页面增加企业项目选项。 2020-04-10 第四十七次正式发布。 新增安装云专线指标采集插件。 2020-01-20 第四十六次正式发布。 更新Cloud Eye自定义策略中的内容，删除“策略语法：细粒度策略”。 2020-01-15 第四十五次正式发布。 更新主机监控中的内容，新增“西南-贵阳一”区域的相关信息。 2019-12-30 第四十四次正式发布。 更新安装Agent（Linux）和安装Agent（Windows），新增“华东-上海一”区域Agent的操作步骤。 2019-12-04 第四十三次正式发布。 更新创建用户并授权使用云监控服务和Cloud Eye自定义策略，新增可视化视图新增自定义策略的相关信息。 2019-11-15 第四十二次正式发布。 新增支持监控的服务列表。 2019-09-30 第四十一次正式发布。 更新主机监控中的内容，新增“华东-上海一”区域的相关信息。 2019-09-19 第四十次正式发布。 优化事件监控支持的事件说明，补充事件说明、处理建议和事件影响。 2019-09-06 第三十九次正式发布。 新增细粒度授权内容：Cloud Eye自定义策略和策略语法：细粒度策略。 2019-07-31 第三十八次正式发布。 新增“为什么在云监控服务看不到监控数据？”。 支持监控的服务列表中新增“图引擎的监控指标”。 2019-06-12 第三十七次正式发布： 新增权限管理内容。 一键告警功能上线。 支持监控的服务列表中新增“分布式缓存服务监控指标”。 支持监控的服务列表中新增“云文件服务的监控指标”。 支持监控的服务列表中新增“弹性文件服务的监控指标”。 支持监控的服务列表中新增“自然语言处理的监控指标”。 2019-04-30 第三十六次正式发布： 安装Agent步骤优化。 产品介绍中新增应用场景。 新对接云文件服务。 新对接数据库安全服务。 2019-03-30 第三十五次正式发布： 虚拟私有云修改为弹性公网IP和带宽。 分布式消息服务监控指标章节内容优化。 2019-03-14 第三十四次正式发布： 添加安全组步骤优化。 分布式缓存服务新增监控指标。 新对接人脸识别服务。 关系型数据库监控指标章节优化。 2019-02-21 第三十三次正式发布： 新增“配额调整”章节。 主机监控上线华北-北京四。 新对接对话机器人服务。 2019-01-17 第三十二次正式发布。 本次变更如下： 弹性云服务器、云硬盘磁盘类指标名称优化。 关系型数据库指标名称优化。 2018-12-30 第三十一次正式发布。 本次变更如下： DMS新增监控指标。 云搜索服务新增监控指标。 2018-11-30 第三十次正式发布。 本次变更如下： 函数工作流新增监控指标。 弹性负载均衡服务新增监控指标。 2018-11-15 第二十九次正式发布。 本次变更如下： 新增自定义进程监控功能。 新增云助手功能。 关系型数据库件新增监控指标。 2018-10-30 第二十八次正式发布。 本次变更如下： 创建告警规则新增生效时间。 创建告警规则支持资源分组。 新对接语音识别、图像识别、内容检测、语音合成。 2018-09-30 第二十七次正式发布。 本次变更如下： 分布式数据库中间件新增监控指标。 弹性负均衡新增监控指标。 云专线新增监控指标。 创建告警规则界面优化。 分布式消息服务新增监控指标。 2018-08-30 第二十六次正式发布。 本次变更如下： 分布式数据库中间件新增监控指标。 操作系统监控新增监控指标。 主机监控安装Agent步骤优化。 2018-07-30 第二十五次正式发布。 本次变更如下： 事件监控新增ECS自动恢复事件。 资源分组支持裸金属服务器类型资源。 Agent支持安装到指定目录。 Agent支持设置指定端口号。 云硬盘新增监控指标。 2018-06-30 第二十四次正式发布。 本次变更如下： 新增批量数据存储功能。 主机监控新增修复插件配置功能。 Elasticsearch服务新增监控指标。 关系型数据库新增监控指标。 虚拟私有云新增监控指标。 2018-05-30 第二十三次正式发布。 本次变更如下： 操作系统监控新增进程类监控指标。 操作系统监控支持Windows系统。 监控面板新增自动刷新按钮。 2018-04-30 第二十二次正式发布。 本次变更如下： 新增对接NAT Gateway。 创建告警规则词条优化。 新增事件监控功能。 主机监控界面改版。 2018-03-30 第二十一次正式发布。 本次变更如下： 分布式缓存服务新增监控指标。 新对接预测服务。 新对接Elasticsearch服务。 操作系统监控新增GPU指标。 新增资源分组功能。 新增日志监控功能。 2018-02-28 第二十次正式发布。 本次变更如下： 人工智能服务新增监控指标。 新对接云数据迁移服务。 新增可用性监控功能。 操作系统监控新增负载指标。 2018-01-30 第十九次正式发布。 本次变更如下： 新增自定义监控功能。 人工智能服务新增监控指标。 新增站点监控功能。 2018-01-26 第十八次正式发布。 本次变更如下： 新增进程监控功能。 操作系统监控新增网卡类监控指标。 新增指标排序功能。 新对接对象存储服务。 2017-12-30 第十七次正式发布。 本次变更如下： 新对接API网关。 新对接文档型数据库服务。 新对接CloudTable服务。 分布式缓存服务新增监控指标。 人工智能服务新增监控指标。 2017-11-30 第十六次正式发布。 本次变更如下： 新对接分布式数据库中间件。 人工智能服务新增监控指标。 弹性伸缩新增监控指标。 新增利用CloudInit自动安装配置Agent。 新增配置OBS转储。 2017-10-30 第十五次正式发布。 本次变更如下： 新增主机监控功能。 优化分布式消息服务指标描述。 创建主题时跳转到消息通知服务界面。 2017-09-30 第十四次正式发布。 本次变更如下： 新增自定义告警模板功能。 新增监控概览。 新增函数工作流服务监控指标说明。 新增弹性文件服务监控指标说明。 2017-08-30 第十三次正式发布。 本次变更如下： 新增告警模板。 添加告警规则流程更新。 2017-07-30 第十二次正式发布。 本次变更如下： 新增人工智能服务监控指标说明。 新增常见问题“告警规则在何种情况下会触发数据不足？”。 2017-06-30 第十一次正式发布。 优化实例监控页面，支持多指标平铺展示。 2017-05-26 第十次正式发布。 新增： 分布式消息服务监控指标。 “指标数”含义说明。 “求和值”聚合方法。 2017-04-28 第九次正式发布。 新增： 机器学习服务监控指标。 网页防篡改监控指标。 数据仓库服务监控指标。 虚拟私有云服务流量指标。 2017-03-30 第八次正式发布。 新增： Workspace监控指标。 关系型数据库监控指标。 ECS新增监控指标支持ECS实例恢复。 2017-02-27 第七次正式发布。 新增： 创建监控面板项。 云监控服务聚合数据原理。 2017-01-19 第六次正式发布。 新增： 云监控服务支持的聚合方法。 2016-12-30 第五次正式发布。 新增： 自定义添加监控项。 2016-11-24 第四次正式发布。 新增： 查看历史告警。 2016-10-19 第三次正式发布。 变更： 删除资源模板服务监控指标。 2016-07-15 第二次正式发布。 新增： 关系型数据库监控指标。 2016-03-14 第一次正式发布。

支持监控的服务列表 全局级服务的监控数据默认保存在华北-北京四，如需要查询数据，请在华北-北京四查看。 分类 服务 命名空间 维度 监控指标参考文档 计算 弹性云服务器 SYS.ECS Key：instance_id Value：云服务器ID 弹性云服务器的基础监控指标 弹性云服务器中操作系统监控 AGT.ECS Key：instance_id Value：云服务器ID Key：disk Value：磁盘 Key：mount_point Value：挂载点 Key：proc Value：进程 Key：gpu Value：GPU Key：npu Value：NPU Key：davp Value：DAVP 弹性云服务器操作系统监控的监控指标（安装Agent） 裸金属服务器 SERVICE.BMS Key：instance_id Value：云服务器ID 裸金属服务器操作系统监控的监控指标（安装Agent） 弹性伸缩 SYS.AS Key：AutoScalingGroup Value：弹性伸缩组的ID 弹性伸缩的监控指标说明 云手机服务器 SYS.CPH Key：instance_id Value：云手机服务器ID Key：cph_id Value：云手机ID Key：disk_name Value：磁盘名称 Key：gpu_index Value：GPU名称 云手机服务器的监控指标说明 函数工作流服务 SYS.FunctionGraph Key：package-functionname Value：应用名-函数名 函数工作流服务的监控指标说明 存储 云硬盘（仅当挂载到云服务器时） SYS.EVS Key：disk_name Value：云服务器实例ID-盘符名（例如sda为盘符名） 云硬盘的监控指标说明 对象存储服务 SYS.OBS Key：bucket_name Value：桶名 Key：tenant_id Value：租户Id Key：api_name Value：接口 Key：http_code Value：HTTP返回码 Key：domain_name Value：域名 对象存储服务监控指标说明 弹性文件服务 SYS.SFS Key：share_id Value：文件系统 弹性文件服务监控指标说明 云备份 SYS.CBR Key：instance_id Value：存储库名称/ID 云备份监控指标说明 云存储网关 SYS.CSG Key：gateway_id Value：网关ID 云存储网关监控指标说明 弹性文件服务Turbo SYS.EFS Key：efs_instance_id Value：实例 SFS Turbo监控指标说明 网络 弹性公网IP和带宽 SYS.VPC Key：publicip_id Value：弹性公网IP ID Key：bandwidth_id Value：带宽ID 虚拟私有云的监控指标说明 弹性负载均衡 SYS.ELB Key：lbaas_pool_id Value：后端服务器组的ID Key：lbaas_instance_id Value：独享/共享型负载均衡器的ID Key：lbaas_listener_id Value：独享/共享型负载均衡监听器的ID 弹性负载均衡的监控指标说明 云专线 SYS.DCAAS Key：direct_connect_id Value：物理连接 Key：history_direct_connect_id Value：历史物理连接 Key：virtual_interface_id Value：虚拟接口 Key：virtual_gateway_id Value：虚拟网关 云专线的监控指标说明 虚拟专用网络 SYS.VPN Key：connection_id Value：VPN连接 虚拟专用网络的监控指标说明 NAT网关 SYS.NAT Key：nat_gateway_id Value：NAT网关实例标识 Key：vpc_nat_gateway_id Value：私网NAT实例标识 NAT网关的监控指标说明 企业路由器 SYS.ER Key：er_instance_id Value：企业路由器实例 Key：er_attachment_id Value：企业路由器连接 企业路由器的监控指标说明 云连接 SYS.CC Key：cloud_connect_id Value：云连接ID Key：bwp_id Value：带宽包ID Key：region_bandwidth_id Value：域间带宽ID 云连接的监控指标说明 全球加速 SYS.GA Key：ga_accelerator_id Value：全球加速实例的ID Key：ga_listener_id Value：全球加速监听器的ID Key：ga_source_pop Value：全球加速实例的接入点 Key：ga_destination_region Value：全球加速实例的目的区域 Key：ga_source_area Value：全球加速实例的接入大区 Key：ga_listener_region Value：全球加速监听器和目的区域 Key：ga_pop_listener Value：全球加速接入点和监听器 Key：ga_pop_region Value：全球加速接入点和目的区域 Key：ga_pop_listener_region Value：全球加速接入点、监听器和目的区域 Key：ga_source_destination_area Vaue：全球加速接入大区和目的大区 全球加速的监控指标说明 企业连接 SYS.EC Key：enterprise_connect_network Value：企业连接网络 Key：intelligent_enterprise_gateway Value：智能企业网关 Key：ieg_equipment Value：网关设备 企业连接的监控指标说明 应用中间件 分布式消息服务 SYS.DMS 请参考右侧相关文档链接页面。 分布式消息服务Kafka版的监控指标 分布式消息服务RabbitMQ的监控指标 分布式消息服务RocketMQ版的监控指标 API网关 SYS.APIG Key：api_id Value：API API网关的监控指标说明 API专享版网关 SYS.APIC Key：instance_id Value：专享版API网关 Key：api_id Value：API API网关的监控指标说明 分布式缓存服务 SYS.DCS Key：dcs_instance_id Value：Redis实例 Key：dcs_cluster_redis_node Value：数据节点 Key：dcs_cluster_proxy_node Value：Redis3.0 Proxy集群实例Proxy节点 Key：dcs_cluster_proxy2_node Value：Redis4.0/Redis5.0 Proxy集群实例Proxy节点 Key：dcs_memcached_instance_id Value：Memcached实例 分布式缓存服务的监控指标说明 应用与数据集成平台 SYS.ROMA 请参考右侧相关文档链接页面。 应用与数据集成平台的监控指标说明 数据库 关系型数据库 SYS.RDS 请参考右侧相关文档链接页面。 MySQL的监控指标说明 MariaDB的监控指标说明 PostgreSQL的监控指标说明 SQL Server的监控指标说明 文档数据库 SYS.DDS Key：mongodb_node_id Value：文档数据库节点ID Key：mongodb_instance_id Value：文档数据库实例ID 文档数据库的监控指标说明 分布式数据库中间件 SYS.DDMS Key：node_id Value：DDM节点 分布式数据库中间件的监控指标说明 云数据库GaussDB NoSQL SYS.NoSQL 请参考右侧相关文档链接页面。 云数据库GaussDB(for Cassandra)的监控指标说明 云数据库GaussDB(for Mongo)的监控指标说明 云数据库GaussDB(for Influx)的监控指标说明 云数据库GaussDB(for Redis)的监控指标说明 云数据库GaussDB(for MySQL) SYS.GAUSSDB Key：gaussdb_mysql_instance_id Value：GaussDB(for MySQL)实例ID Key：gaussdb_mysql_node_id Value：GaussDB(for MySQL)实例节点ID Key：dbproxy_instance_id Value：GaussDB(for MySQL)Proxy实例ID Key：dbproxy_node_id Value：GaussDB(for MySQL)Proxy节点ID 云数据库GaussDB(for MySQL)的监控指标说明 云数据库 GaussDB SYS.GAUSSDBV5 Key：gaussdbv5_instance_id Value：GaussDB实例 Key：gaussdbv5_node_id Value：GaussDB节点 Key：gaussdbv5_component_id Value：GaussDB组件 云数据库 GaussDB的监控指标说明 数据复制服务 SYS.DRS Key：instance_id Value：数据复制服务实例ID 数据复制服务的监控指标说明 迁移 云数据迁移 SYS.CDM Key：instance_id Value：云数据迁移服务实例 云数据迁移的监控指标说明 大数据 数据仓库服务 SYS.DWS Key：datastore_id Value：数据仓库集群ID Key：dws_instance_id Value：数据仓库节点ID 数据仓库服务的监控指标说明 云搜索服务 SYS.ES Key：cluster_id Value：集群id Key：instance_id Value：实例id 云搜索服务的监控指标说明 数据湖探索 SYS.DLI Key：queue_id Value：队列 Key：flink_job_id Value：Flink作业 Key：elastic_resource_pool_id Value：弹性资源池 数据湖探索的监控指标说明 数据接入服务 SYS.DAYU Key：stream_id Value：实时数据接入 数据接入服务的监控指标说明 表格存储服务 SYS.CloudTable Key：cluster_id Value：CloudTable集群ID Key：instance_name Value：CloudTable集群节点名称 HBase集群的监控指标说明 Doris集群的监控指标说明 ClickHouse集群的监控指标说明 人工智能 ModelArts SYS.ModelArts Key：service_id Value：在线服务ID Key：model_id Value：模型负载ID ModelArts的监控指标说明 图像搜索服务 SYS.IS Key：instanceName Value：实例名称 图形搜索服务的监控指标说明 图像识别 SYS.IRS Key：call_of_interface Value：接口 图像识别的监控指标说明 内容审核 SYS.MODERATION Key：call_of_interface Value：接口 内容审核的监控指标说明 人脸识别 SYS.FRS Key：call_of_api Value：接口 Key：face_set Value：人脸库 人脸识别的监控指标说明 自然语言处理 SYS.NLP Key：call_of_interface Value：接口 自然语言处理的监控指标说明 文字识别 SYS.OCR Key：call_of_interface Value：接口 文字识别的监控指标说明 图引擎服务 SYS.GES Key：instance_id Value：图引擎服务实例 图引擎服务的监控指标说明 语音交互服务 SYS.SIS Key：interface Value：接口 语音交互服务的监控指标说明 人证核身 SYS.IVS Key：call_of_api Value：接口 人证核身的监控指标说明 安全与合规 Web应用防火墙 SYS.WAF Key：instance_id Value：独享引擎实例 Key：waf_instance_id Value：云模式实例 WAF监控指标说明 数据库安全服务 SYS.DBSS Key：audit_id Value：实例 数据库安全服务的监控指标说明 云防火墙 SYS.CFW Key：fw_instance_id Value：云防火墙实例 云防火墙的监控指标说明 DDoS防护 SYS.DDOS Key：zone_ip Value：防护IP Key：instance_id Value：实例ID DDoS防护的监控指标说明 云堡垒机 SYS.CBH Key：server_id Value：CBH实例ID 云堡垒机的监控指标说明 企业应用 应用与数据集成平台 ROMA Connect SYS.ROMA Key：kafka_groups Value：消费组 Key：kafka_groups_topics Value：队列 Key：kafka_groups_partitions Value：分区 应用与数据集成平台的监控指标说明 CDN与智能边缘 智能边缘小站 SYS.IES Key：site_id Value：边缘小站ID 智能边缘小站的监控指标说明 视频 视频直播 SYS.Live Key：domain Value：域名 视频直播的监控指标说明 管理与监管 消息通知服务 SYS.SMN Key：topic_id Value：主题的ID 消息通知服务的监控指标说明

调用说明 云监控服务提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。 同时云监控服务还提供多种编程语言的SDK供您使用，SDK的使用方法请参见https://console.huaweicloud.com/apiexplorer/#/sdkcenter/CES?lang=Java。 父主题： 使用前必读

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "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" } }

文档修订记录 发布日期 修改记录 2023-10-12 第四十六次正式发布： 本次变更如下： 新增告警通知。 新增一键告警。 新增告警通知屏蔽。 新增CES资源标签管理。 2023-08-31 第四十五次正式发布： 本次变更如下： 新增监控看板。 新增监控视图。 新增API V3。 新增查询资源分组下的资源表resources新增字段“event_type”。 新增查询所有资源分组表resource_groups新增字段“type”、“relation_ids”和“resources”。 新增查询某一事件监控详情表detail新增字段“dimensions”。 新增修改告警规则策略(全量修改)表UpdatePolicy新增字段“type”。 新增查询告警规则策略列表表ListPolicy新增字段“extra_info”和“type”。 2022-11-25 第四十四次正式发布： 本次变更如下： 新增告警策略。 新增告警记录。 2022-07-26 第四十三次正式发布： 本次变更如下： 新增API V2。 2021-11-26 第四十二次正式发布： 新增部分指标的API Explorer调试链接。 2020-12-08 第四十一次正式发布： 新增修改告警规则。 新增创建资源分组。 新增更新资源分组。 新增删除资源分组。 新增查询所有资源分组。 新增查询事件监控列表。 新增查询某一事件监控详情。 2020-11-10 第四十次正式发布： 新增创建自定义告警模板。 新增删除自定义告警模板。 新增查询告警历史。 新增查询自定义告警模板列表。 新增更新自定义告警模板。 新增查询资源分组下的资源。 2020-05-30 第三十九次正式发布： 在查询告警规则列表、查询单条告警规则信息和创建告警规则章节新增企业项目ID接口参数“enterprise_project_id”。 2019-09-06 第三十八次正式发布： 新增权限和授权项。 2019-08-30 第三十七次正式发布： 修改快速入门中的步骤一的获取Token样例。 2019-07-31 第三十六次正式发布： 新增图引擎服务监控指标说明。 2019-06-12 第三十五次正式发布： 使用前必读内容优化。 API概览内容优化。 如何调用API内容优化。 快速入门内容优化。 分布式缓存服务新增监控指标。 云文件服务新增监控指标。 弹性文件服务新增监控指标。 自然语言处理新增监控指标。 2019-04-30 第三十四次正式发布： 优化快速入门章节。 新对接云文件服务。 新对接数据库安全服务。 2019-03-30 第三十三次正式发布： 虚拟私有云修改为弹性公网IP和带宽。 布式消息服务监控指标章节内容优化。 2019-03-14 第三十二次正式发布： 分布式缓存服务新增监控指标。 新对接人脸识别服务。 关系型数据库监控指标章节优化。 2019-02-21 第三十一次正式发布： 新对接对话机器人服务。 2019-01-17 第三十次正式发布。 本次变更如下： 弹性云服务器、云硬盘磁盘类指标名称优化。 关系型数据库指标名称优化。 2018-12-30 第二十九次正式发布。 本次变更如下： DMS新增监控指标。 云搜索服务新增监控指标。 2018-11-30 第二十八次正式发布。 本次变更如下： 函数工作流新增监控指标。 弹性负载均衡服务新增监控指标。 2018-10-30 第二十七次正式发布。 本次变更如下： 关系型数据库件新增监控指标。 新对接语音识别、图像识别、内容检测、语音合成。 2018-09-30 第二十六次正式发布。 本次变更如下： 分布式数据库中间件新增监控指标。 弹性负均衡新增监控指标。 云专线新增监控指标。 分布式消息服务新增监控指标。 新增查询API所有版本号的接口。 新增查询API指定版本号的接口。 2018-08-30 第二十五次正式发布。 本次变更如下： 分布式数据库中间件新增监控指标。 操作系统监控新增监控指标。 2018-07-30 第二十四次正式发布。 本次变更如下： 查询告警规则列表与查询单条告警规则信息内容优化。 2018-06-30 第二十三次正式发布。 本次变更如下： Elasticsearch服务新增监控指标。 优化云文件监控指标。 关系型数据库新增监控指标。 2018-05-30 第二十二次正式发布。 本次变更如下： 新增批量查询监控数据接口。 新增上报事件接口。 2018-04-30 第二十一次正式发布。 本次变更如下： 新对接NAT网关服务。 主动监控新增监控指标。 2018-03-30 第二十次正式发布。 本次变更如下： 分布式缓存服务新增监控指标。 新对接预测服务。 新对接Elasticsearch服务。 主动监控新增GPU指标。 2018-02-28 第十九次正式发布。 本次变更如下： 人工智能服务新增监控指标。 新对接云数据迁移服务。 主动监控新增负载指标。 2018-01-30 第十八次正式发布。 本次变更如下： 人工智能服务新增监控指标。 2018-01-26 第十七次正式发布。 本次变更如下： 新对接对象存储服务。 新增主动监控指标说明。 2017-12-30 第十六次正式发布。 本次变更如下： 新对接API网关。 新对接文档型数据库服务。 新对接CloudTable服务。 人工智能服务新增监控指标。 分布式缓存服务新增监控指标。 2017-11-30 第十五次正式发布。 本次变更如下： 新对接分布式数据库中间件。 人工智能服务新增监控指标。 弹性伸缩新增监控指标。 2017-10-30 第十四次正式发布。 本次变更如下： 优化分布式消息指标描述。 2017-09-30 第十三次正式发布。 本次变更如下： 新增人工智能服务监控指标。 新增弹性文件服务监控指标。 新增函数工作流服务监控指标。 新增查询主机配置数据。 2017-07-30 第十二次正式发布。 本次变更如下： 新增人工智能服务监控指标。 新增创建告警规则。 查询已关注指标标记为“已废弃”。 2017-05-26 第十一次正式发布。 本次变更如下： 新增分布式消息服务监控指标。 2017-04-28 第十次正式发布。 本次变更如下： 新增机器学习服务监控指标说明。 新增网页防篡改监控指标说明。 新增数据仓库服务监控指标说明。 2017-03-30 第九次正式发布。 本次变更如下： 新增Workspace监控指标说明。 关系型数据库监控指标说明中新增监控指标。 2017-02-27 第八次正式发布。 本次变更如下： 新增请求参数from的设置建议。 2016-12-30 第七次正式版本。 本次变更如下： 新增Web应用防火墙监控指标说明。 主机漏洞检测监控指标说明。 2016-10-29 第六次正式版本。 本次变更如下： 弹性负载均衡监控指标说明中新增监控指标。 2016-9-30 第五次正式版本。 本次变更如下： 新增分布式缓存服务监控指标说明。 新增分布式消息服务监控指标说明。 关系型数据库监控指标说明中新增监控指标。 2016-8-25 第四次正式发布。 本次变更如下： 弹性云服务器监控指标说明中新增监控指标。 2016-07-30 第三次正式发布。 本次变更如下： 按照开放API功能点组织目录。 新增查询单条告警规则信息接口。 新增启停和删除告警规则接口。 新增添加监控数据接口。 新增关系型数据库监控指标说明。 2016-01-25 第二次正式发布。 本次变更说明如下： 修改“请求签名流程”，更新了SDK jar包和签名过程。 修改“示例代码”，优化代码。 修改“公共请求消息头”，新增消息头，部分消息头更改为非必选。 修改了参数说明以及是否必选、范围等。 “附录”章节新增各服务的监控指标说明。 2015-10-15 第一次正式发布。

v1接口返回体示例 { "code": 400, "element": "Bad Request", "message": "The system received a request which cannot be recognized", "details": { "details": "Some content in message body is not correct", "code": "ces.0014" } }

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 模块 http状态码 错误码 错误码说明 Error Message 描述（处理措施） Cloud Eye通用 500 ces.0007 内部错误 Internal service error. 联系技术支持人员 API 400 ces.0001 请求内容不能为空 The content must be specified. 增加正确的请求内容 400 ces.0003 项目ID为空或不正确 The tenant ID is left blank or incorrect. 添加或使用正确的项目ID 400 ces.0004 未指定API版本号 The API version must be specified. 在请求URL中增加API版本号 400 ces.0005 API版本不正确 The API version is incorrect. 使用正确的API版本号 400 ces.0006 分页地址不正确 The paging address is incorrect. 使用正确的分页信息 403 ces.0009 不允许添加系统指标 Adding SYS metric is not allowed 使用正确权限添加指标数据 403 ces.0010 不允许删除系统指标 Deleting SYS metric is not allowed 使用正确权限删除指标信息 400 ces.0011 请求无效 The request is invalid. 检查请求信息 400 ces.0013 无效的URL参数或参数不存在 The URL parameter is invalid or does not exist. 检查URL参数 400 ces.0014 请求体错误 Some content in message body is not correct. 检查请求Body体参数 401 ces.0015 鉴权失败或未提供有效鉴权信息 Authentication fails or the authentication information is not provided. 检查获取token的用户名或密码（或AK、SK）是否正确 404 ces.0016 请求的资源不存在 The requested resource does not exist. 确认所请求资源是否存在 403 ces.0017 鉴权信息错误或者无相应权限 The authentication information is incorrect or the service invoker does not have sufficient rights. 检查获取token的用户名或密码（或AK、SK）的信息、权限是否正确 数据库 500 ces.0008 数据库错误 Database error. 联系技术支持人员 Zookeeper 500 ces.0021 内部锁错误 Internal locking error. 联系技术支持人员 Blueflood 500 ces.0019 指标处理引擎异常 The metric processing engine is abnormal. 联系技术支持人员 Alarm 400 ces.0002 告警ID不能为空 The alarm ID must be specified. 添加正确的Alarm ID信息 403 ces.0018 Alarm配额不足 The number of alarms exceeds the quota 申请更多的Alarm配额 400 ces.0028 创建告警规则时指标和通知类型不匹配 The metric does not support the alarm action type. 根据参数说明修改指标或通知类型，使二者匹配

监控数据管理接口授权项说明 权限 对应API接口 授权项 IAM项目 企业项目 查询指定时间范围指定指标的指定粒度的监控数据，可以通过参数指定需要查询的数据维度。 GET /V1.0/{project_id}/metric-data?namespace={namespace}&metric_name={metric_name}&dim.{i}=key,value&from={from}&to={to}&period={period}&filter={filter} ces:metricData:list √ × 添加一条或多条自定义指标监控数据，解决系统监控指标不能满足具体业务需求的场景。 POST /V1.0/{project_id}/metric-data ces:metricData:create √ × 批量查询指定时间范围内指定指标的指定粒度的监控数据，目前最多支持10指标的批量查询。 POST /V1.0/{project_id}/batch-query-metric-data ces:metricData:list √ × 查询指定时间范围指定事件类型的主机配置数据，可以通过参数指定需要查询的数据维度（该接口提供给HANA场景下SAP Monitor查询主机配置数据，其他场景下查不到主机配置数据）。 GET /V1.0/{project_id}/event-data ces:sapEventData:list √ × 父主题： 权限和授权项