ListCityMetasForSDK - 获取兴趣地图可用城市列表--内容定制-火山引擎

文档中心

立即注册

导航

ListCityMetasForSDK - 获取兴趣地图可用城市列表

最近更新时间：2024.11.01 14:03:09首次发布时间：2024.11.01 14:03:09

返回全量兴趣地图可用城市列表。

请求说明

请求方式：POST
请求地址：https://mercury.volcengineapi.com?Action=ListCityMetasForSDK&Version=2024-01-01
请求头：
- ServiceName:volc_torchlight_api
- Content-Type:application/json

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	ListCityMetasForSDK	要执行的操作，取值：ListCityMetasForSDK。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。

Body

参数	类型	是否必填	示例值	描述
UtmSource	String	是	xxx_default_content	渠道号

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
CityMetas	Array of Object		该渠道下开放的城市列表，常规情况下只增不减，减少的情况下会提前通知客户进行相应调整。

请求示例

POST /?Action=ListCityMetasForSDK&Version=2024-01-01 HTTP/1.1
Host: https://mercury.volcengineapi.com?Action=ListCityMetasForSDK&Version=2024-01-01
Content-Type: application/json; charset=UTF-8
X-Date: 20241031T060027Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241031/cn-beijing/volc_torchlight_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UtmSource": "xxx_default_content"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202410311400321462472220405C25BD",
    "Action": "ListCityMetasForSDK",
    "Version": "2024-01-01",
    "Service": "volc_torchlight_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "CityMetas": [
      {
        "CityName": "北京市",
        "CityCode": "110000",
        "PoiCount": 1000
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。