GetPoiCategories - 获取POI分类元数据--内容定制-火山引擎

文档中心

立即注册

导航

GetPoiCategories - 获取POI分类元数据

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

获取POI分类元数据

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
UtmSource	String	是	xxx_default_content	渠道号。
Product	String	是	interest_map	产品线，这里统一为 interest_map。
CategoryType	String	是	poi_category	分类类型：poi_category

返回参数

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

参数	类型	示例值	描述
Categories	Array of Object		分类列表
ModifyTime	Long	1730171462	最近更新时间，单位秒。

请求示例

POST /?Action=GetPoiCategories&Version=2024-01-01 HTTP/1.1
Host: https://mercury.volcengineapi.com?Action=GetPoiCategories&Version=2024-01-01
Content-Type: application/json; charset=UTF-8
X-Date: 20241031T064841Z
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",
  "Product": "interest_map",
  "CategoryType": "poi_category"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202410311448531621072211013158A3",
    "Action": "GetPoiCategories",
    "Version": "2024-01-01",
    "Service": "volc_torchlight_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "Categories": [
      {
        "Code": "170000",
        "Name": "丽人",
        "SubNodes": [
          {
            "Code": "170000/170200",
            "Name": "其他丽人",
            "SubNodes": [
              {
                "Code": "170000/170200/170201",
                "Name": "丽人服务",
                "SubNodes": null
              }
            ]
          }
        ]
      }
    ],
    "ModifyTime": 1730171462
  }
}

错误码

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