# 查询直播平台列表 - ListLivePlatforms #### 功能介绍 该接口用于查询直播平台列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-metastudio/metastudio_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-metastudio/metastudio_02_0071.html)。 #### URI GET /v1/{project_id}/live-platforms/platforms 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | 否 | Integer | 每页显示的条目数量。 **取值范围：** 1\~100 **默认取值：** 10 | | access_type | 否 | String | 平台对接类型。\| - MEITUAN_OFFICIAL：对接美团直播平台官方接口 - MSS_STANDARD：对接MetaStudio定义的标准接口 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 | | X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 请求ID。 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | live_platforms | Array of [LivePlatformInfo] objects | 直播平台列表 | 表6LivePlatformInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | platform_id | String | 平台ID | | access_type | String | 平台对接类型。 - MEITUAN_OFFICIAL：对接美团直播平台官方接口 - MSS_STANDARD：对接MetaStudio定义的标准接口 | | name | String | 直播平台名称 | | authorization_info | [PlatformAuthorizationInfo] object | 直播平台授权信息 | | auth_config | [CustomPlatformAuthConfig] object | 自定义直播平台鉴权配置 | | callback_config | Array of [StandardPlatformApiConfig] objects | 自定义直播平台回调配置。同一种类型仅保留一个配置，如果配置多个会随机保存一个。 | 表7PlatformAuthorizationInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | authorize_state | String | 授权状态。 - AUTHORIZED: 已授权 - UNAUTHORIZED: 未授权 | | authorized_time | String | 授权时间 | | expire_time | String | 过期时间 | | account | String | 授权账号信息。 美团平台对应：opBizCode | 表8CustomPlatformAuthConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 密钥Key。调用自定义直播平台时使用。 使用方式： 调用接口时，增加两个头域：x-hw-mss-time，x-hw-mss-secret - x-hw-mss-time：当前时间戳。Unix时间戳的十六进制结果。1分钟内有效。 示例： 66df9308（即2024.09.10 08:30:00） - x-hw-mss-secret：鉴权串。hmac_sha256(Key, URI（product_query_url,query参数按照Key的字典序排列）+ x-hw-mss-time) 示例： URL https://api.example.com/v1/products?live_id=111\&limit=10\&offset=0 Key：GCTbw44s6MPLh4GqgDpnfuFHgy25Enly hwTime：66df9308 x-hw-mss-secret=hmac_sha256(GCTbw44s6MPLh4GqgDpnfuFHgy25Enly,api.example.com/v1/products?limit=10\&live_id=111\&offset=066df9308)=5e7fe8869a12a87ea966d9edbc02e38cd4ce62c73b8b05c638f15835e78902d7 x-hw-mss-secret: 5e7fe8869a12a87ea966d9edbc02e38cd4ce62c73b8b05c638f15835e78902d7 | 表9StandardPlatformApiConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | api_type | String | API类型。 - PRODUCT_QUERY: 查询商品 - LIVE_EVENT_CALLBACK: 直播事件回调 | | url | String | URL。仅支持HTTPS形式URL | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://metastudio.xxxx.myhuaweicloud.com/v1/{project_id}/live-platforms/platforms ``` #### 响应示例 **状态码：200** 成功。 ``` { "live_platforms" : [ { "name" : "meituan" } ] } ``` **状态码：400** 请求传参异常，包含错误码及对应描述。 ``` { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } ``` **状态码：401** 未鉴权或鉴权失败。 ``` { "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" } ``` **状态码：500** 内部服务错误。 ``` { "error_code" : "MSS.00000004", "error_msg" : "Internal Error" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功。 | | 400 | 请求传参异常，包含错误码及对应描述。 | | 401 | 未鉴权或鉴权失败。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。