You need to enable JavaScript to run this app.
导航

查询区域标识符

最近更新时间2023.10.23 16:15:05

首次发布时间2023.09.25 14:36:18

查询用户所在的区域标识符。

注意事项

请求频率:单用户请求频率限制为 100 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=DescribeLiveRegionData&Version=2023-01-01

请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeLiveRegionData接口名称。当前 API 的名称为 DescribeLiveRegionData
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

返回参数

参数类型示例值描述
AreasArray of Areas-大区信息。

Areas

参数类型示例值描述
CodeStringCN大区标识符。
NameString中国大区名称。
CountriesArray of Countries-国家信息。

Countries

参数类型示例值描述
CodeStringCN国家标识符。
NameString中国国家名称。
ProvincesArray of Provinces-省份信息,国外暂不支持该参数。

Provinces

参数类型示例值描述
CodeStringbeijing省份标识符。
NameString北京省份名称。

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveRegionData&Version=2023-01-01

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230831140335992B73F008D5242E199D",
    "Action": "DescribeLiveRegionData",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "Areas": [
      {
        "Code": "CN",
        "Name": "中国",
        "Countries": [
          {
            "Code": "CN",
            "Name": "中国",
            "Provinces": [
              {
                "Code": "beijing",
                "Name": "北京"
              },
              {
                "Code": "shanghai",
                "Name": "上海"
              },
              {
                "Code": "tianjin",
                "Name": "天津"
              }
            ]
          }
        ]
      },
      {
        "Code": "AP1",
        "Name": "亚太一区",
        "Countries": [
          {
            "Code": "CN",
            "Name": "中国",
            "Provinces": [
              {
                "Code": "HK",
                "Name": "香港"
              },
              {
                "Code": "MO",
                "Name": "澳门"
              }
            ]
          },
          {
            "Code": "KH",
            "Name": "柬埔寨",
            "Provinces": []
          },
          {
            "Code": "JP",
            "Name": "日本",
            "Provinces": []
          }
        ]
      },
      {
        "Code": "AP2",
        "Name": "亚太二区",
        "Countries": [
          {
            "Code": "CN",
            "Name": "中国",
            "Provinces": [
              {
                "Code": "TW",
                "Name": "台湾"
              }
            ]
          },
          {
            "Code": "ID",
            "Name": "印度尼西亚",
            "Provinces": []
          },
          {
            "Code": "PH",
            "Name": "菲律宾",
            "Provinces": []
          }
        ]
      },
      {
        "Code": "AP3",
        "Name": "亚太三区",
        "Countries": [
          {
            "Code": "KR",
            "Name": "韩国",
            "Provinces": []
          },
          {
            "Code": "AU",
            "Name": "澳大利亚",
            "Provinces": []
          }
        ]
      },
      {
        "Code": "NA",
        "Name": "北美",
        "Countries": [
          {
            "Code": "US",
            "Name": "美国",
            "Provinces": []
          },
          {
            "Code": "CA",
            "Name": "加拿大",
            "Provinces": []
          }
        ]
      },
      {
        "Code": "SA",
        "Name": "南美",
        "Countries": [
          {
            "Code": "BR",
            "Name": "巴西",
            "Provinces": []
          },
          {
            "Code": "AR",
            "Name": "阿根廷",
            "Provinces": []
          }
        ]
      },
      {
        "Code": "EU",
        "Name": "欧洲",
        "Countries": [
          {
            "Code": "GB",
            "Name": "英国",
            "Provinces": []
          },
          {
            "Code": "NL",
            "Name": "荷兰",
            "Provinces": []
          }
        ]
      },
      {
        "Code": "MEAA",
        "Name": "中东",
        "Countries": [
          {
            "Code": "TR",
            "Name": "土耳其",
            "Provinces": []
          },
          {
            "Code": "SA",
            "Name": "沙特阿拉伯",
            "Provinces": []
          }
        ]
      },
      {
        "Code": "OTHER",
        "Name": "其他",
        "Countries": []
      }
    ]
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持