You need to enable JavaScript to run this app.
导航
返回结构
最近更新时间:2024.07.16 17:04:59首次发布时间:2023.12.08 15:01:59

2020-12-01

  • 房间管理、云端媒体处理、公共流、应用管理、业务标识管理、实时消息通信模块下:
    当 HTTP 响应状态码 !=200 时,表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaDataCodeMessage 字段解析错误原因。
    当 HTTP 响应状态码 ==200 时,你仍需解析返回结构中的 BaseResponse.ResponseMetaData.Error 结构体。当 Error 为空时,表示调用成功。

返回结构

BaseResponse 返回结构如下:

参数名类型描述
ResponseMetadataResponseMetadata
Resultinterface{}仅在请求成功时返回, 具体值参考每个 API 的说明。

ResponseMetadata

参数名类型示例值描述
RequestIdStringYour_RequestId请求标识
ActionStringStartRecord接口名称
VersionString2020-12-01接口版本
ServiceStringrtc接口所属服务
RegionStringcn-north-1地域参数:
  • cn-north-1 (华北)
  • ap-singapore-1 (新加坡)
  • us-east-1 (美东)
  • ErrorErrorInfo-仅在请求失败时返回。

    ErrorInfo 错误的结构定义。

    参数名称类型描述
    CodeNUint32网关的错误码。(请求失败时返回)
    CodeStringAPI 的错误码,参看错误码
    MessageString具体的错误信息

    返回结构示例

    调用成功:

    {
            "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                 "Action": "DismissRoom",
                "Version": "2020-12-01",
                "Service": "rtc",
                "Region": "cn-north-1"
            },
            "Result":{
                "Message": "success"
            }
        }
    

    调用失败:

    {
             "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                "Action": "DismissRoom",
                "Version": "2020-12-01",
                "Service": "rtc",
                "Region": "cn-north-1"
                "Error":{
                    "Code": "InvalidParameter.AccountIdMismatch",
                    "Message": "Check owner failed"
            }
        },
            "Result": {}        
        }
    
    • 获取数据指标和歌曲查询模块下:

    当 HTTP 响应状态码 !=200 时,表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaDataCodeMessageBaseResponse.Result 字段解析错误原因。
    当 HTTP 响应状态码 ==200 时,表示调用成功。

    返回结构

    BaseResponse 返回结构如下:

    参数名类型描述
    ResponseMetadataResponseMetadata
    Resultinterface{}具体值参考每个 API 的说明。

    ResponseMetadata

    参数名类型示例值描述
    RequestIdStringYour_RequestId请求标识
    ActionStringStartRecord接口名称
    VersionString2020-12-01接口版本
    ServiceStringrtc接口所属服务
    RegionStringcn-north-1地域参数:
  • cn-north-1 (华北)
  • ap-singapore-1 (新加坡)
  • us-east-1 (美东)
  • ErrorErrorInfo-仅在请求失败时返回。

    ErrorInfo 错误的结构定义。

    参数名称类型描述
    CodeNUint32网关的错误码
    CodeStringAPI 的错误码,参看错误码
    MessageString具体的错误信息

    返回结构示例

    调用成功:

    {
            "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                 "Action": "DismissRoom",
                "Version": "2020-12-01",
                "Service": "rtc",
                "Region": "cn-north-1"
            },
            "Result":{
                "Message": "success"
            }
        }
    

    调用失败:

    {
             "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                "Action": "DismissRoom",
                "Version": "2020-12-01",
                "Service": "rtc",
                "Region": "cn-north-1"
                "Error":{
                    "Code": "InvalidParameter.AccountIdMismatch",
                    "Message": "Check owner failed"
            }
        },
            "Result": {}        
        }
    

    2022-06-01

    当 HTTP 响应状态码 !=200 时,表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaDataCodeMessage 字段解析错误原因。
    当 HTTP 响应状态码 ==200 时,你仍需解析返回结构中的 BaseResponse.ResponseMetaData.Error 结构体。当 Error 为空时,表示调用成功。

    返回结构

    BaseResponse 返回结构如下:

    参数名类型描述
    ResponseMetadataResponseMetadata
    Resultinterface{}仅在请求成功时返回, 具体值参考每个 API 的说明。

    ResponseMetadata

    参数名类型示例值描述
    RequestIdStringYour_RequestId请求标识
    ActionStringStartRecord接口名称
    VersionString2022-06-01接口版本
    ServiceStringrtc接口所属服务
    RegionStringcn-north-1地域参数:
  • cn-north-1 (华北)
  • ap-singapore-1 (新加坡)
  • us-east-1 (美东)
  • ErrorErrorInfo-仅在请求失败时返回。

    ErrorInfo 错误的结构定义。

    参数名称类型描述
    CodeNUint32网关的错误码
    CodeStringAPI 的错误码,参看错误码
    MessageString具体的错误信息

    返回结构示例

    调用成功:

    {
            "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                 "Action": "DismissRoom",
                "Version": "2022-06-01",
                "Service": "rtc",
                "Region": "cn-north-1"
            },
            "Result":{
                "Message": "success"
            }
        }
    

    调用失败:

    {
             "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                "Action": "DismissRoom",
                "Version": "2022-06-01",
                "Service": "rtc",
                "Region": "cn-north-1"
                "Error":{
                    "CodeN": 10009,
                    "Code": "InvalidParameter.AccountIdMismatch",
                    "Message": "Check owner failed"
            }
        },
            "Result": {}        
        }
    

    2023-06-01

    当 HTTP 响应状态码 !=200 时,表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaDataCodeMessage 字段解析错误原因。
    当 HTTP 响应状态码 ==200 时,你仍需解析返回结构中的 BaseResponse.ResponseMetaData.Error 结构体。当 Error 为空时,表示调用成功。

    返回结构

    BaseResponse 返回结构如下:

    参数名类型描述
    ResponseMetadataResponseMetadata
    Resultinterface{}仅在请求成功时返回, 具体值参考每个 API 的说明。

    ResponseMetadata

    参数名类型示例值描述
    RequestIdStringYour_RequestId请求标识
    ActionStringStartRecord接口名称
    VersionString2023-06-01接口版本
    ServiceStringrtc接口所属服务
    RegionStringcn-north-1地域参数:
  • cn-north-1 (华北)
  • ap-singapore-1 (新加坡)
  • us-east-1 (美东)
  • ErrorErrorInfo-仅在请求失败时返回。

    ErrorInfo 错误的结构定义。

    参数名称类型描述
    CodeNUint32网关的错误码
    CodeStringAPI 的错误码,参看错误码
    MessageString具体的错误信息

    返回结构示例

    调用成功:

    {
            "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                 "Action": "DismissRoom",
                "Version": "2023-06-01",
                "Service": "rtc",
                "Region": "cn-north-1"
            },
            "Result":{
                "Message": "success"
            }
        }
    

    调用失败:

    {
             "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                "Action": "DismissRoom",
                "Version": "2023-06-01",
                "Service": "rtc",
                "Region": "cn-north-1"
                "Error":{
                    "CodeN": 10009,
                    "Code": "InvalidParameter.AccountIdMismatch",
                    "Message": "Check owner failed"
            }
        },
            "Result": {}        
        }
    

    2023-07-20

    当 HTTP 响应状态码 !=200 时,表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaDataCodeMessage 字段解析错误原因。
    当 HTTP 响应状态码 ==200 时,表示调用成功。

    返回结构

    BaseResponse 返回结构如下:

    参数名类型描述
    ResponseMetadataResponseMetadata
    Resultinterface{}具体值参考每个 API 的说明。

    ResponseMetadata

    参数名类型示例值描述
    RequestIdStringYour_RequestId请求标识
    ActionStringStartRecord接口名称
    VersionString2023-07-20接口版本
    ServiceStringrtc接口所属服务
    RegionStringcn-north-1地域参数:
  • cn-north-1 (华北)
  • ap-singapore-1 (新加坡)
  • us-east-1 (美东)
  • ErrorErrorInfo-仅在请求失败时返回。

    ErrorInfo 错误的结构定义。

    参数名称类型描述
    CodeStringAPI 的错误码,参看错误码
    MessageString具体的错误信息

    返回结构示例

    调用成功:

    {
            "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                 "Action": "DismissRoom",
                "Version": "2023-07-20",
                "Service": "rtc",
                "Region": "cn-north-1"
            },
            "Result":{
                "Message": "success"
            }
        }
    

    调用失败:

    {
             "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                "Action": "DismissRoom",
                "Version": "2023-07-20",
                "Service": "rtc",
                "Region": "cn-north-1"
                "Error":{
                    "Code": "InvalidParameter.AccountIdMismatch",
                    "Message": "Check owner failed"
            }
        },
            "Result": {}        
        }
    

    2023-11-01 & 2024-06-01

    当 HTTP 响应状态码 !=200 时,表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaDataCodeMessage 字段解析错误原因。
    当 HTTP 响应状态码 ==200 时,表示调用成功。

    返回结构

    BaseResponse 返回结构如下:

    参数名类型描述
    ResponseMetadataResponseMetadata
    Resultinterface{}具体值参考每个 API 的说明。

    ResponseMetadata

    参数名类型示例值描述
    RequestIdStringYour_RequestId请求标识
    ActionStringStartRecord接口名称
    VersionString2023-11-01接口版本
    ServiceStringrtc接口所属服务
    RegionStringcn-north-1地域参数:
  • cn-north-1 (华北)
  • ap-singapore-1 (新加坡)
  • us-east-1 (美东)
  • ErrorErrorInfo-仅在请求失败时返回。

    ErrorInfo 错误的结构定义。

    参数名称类型描述
    CodeStringAPI 的错误码,参看错误码
    MessageString具体的错误信息

    返回结构示例

    调用成功:

    {
            "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                 "Action": "DismissRoom",
                "Version": "2023-11-01",
                "Service": "rtc",
                "Region": "cn-north-1"
            },
            "Result":{
                "Message": "success"
            }
        }
    

    调用失败:

    {
             "ResponseMetadata": {
                "RequestId": "Your_RequestId",
                "Action": "DismissRoom",
                "Version": "2023-11-01",
                "Service": "rtc",
                "Region": "cn-north-1"
                "Error":{
                    "Code": "InvalidParameter.AccountIdMismatch",
                    "Message": "Check owner failed"
            }
        },
            "Result": {}        
        }