获取热点标注信息,后处理时使用

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetHotspotTag

系统规定参数。取值:GetHotspotTag

RegionId String cn-hangzhou

地域信息

PreviewToken String 344794c32937474a9c59eb130936****

预览token

SubSceneUuid String 123456

子场景Uid

Type String 1

类型0:未发布。1:已发布

Enabled Boolean true/false

是否开启自用资源访问

Domain String www.aliyundoc.com

自定义OSS域名(可为CDN域名)

返回数据

名称 类型 示例值 描述
RequestId String 4F882EA7-3A1D-0113-94E4-70162C4B***

请求ID

ObjectString String "{}"

热点信息字符串

Data String {"watermarkImg":[],"enabledTitleTag":0}

热点信息

ErrMessage String success

错误消息

Success Boolean true

请求是否成功

示例

请求示例

Config config = new Config();
        config.setAccessKeyId("yourAccessKeyId");
        config.setAccessKeySecret("yourAccessKeySecret");
        config.setEndpoint("lyj.cn-hangzhou.aliyuncs.com");

        Client client = new Client(config);

        GetHotspotTagRequest request = new GetHotspotTagRequest();
        request.setPreviewToken("ah3h4cssfdsfd****");
        request.setSubSceneUuid("123");
        request.setType("1");
        request.setEnabled(false);
        request.setDomain("www.aliyundoc.com");

        GetHotspotTagResponse response = client.getHotspotTag(request);
        if (response.getBody().success){
            // ...
        }

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetHotspotTagResponse>
    <RequestId>4F882EA7-3A1D-0113-94E4-70162C4B***</RequestId>
    <ObjectString>"{}"</ObjectString>
    <Data>json数据</Data>
    <ErrMessage>success</ErrMessage>
    <Success>true</Success>
</GetHotspotTagResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4F882EA7-3A1D-0113-94E4-70162C4B***",
  "ObjectString" : "\"{}\"",
  "Data" : "json数据",
  "ErrMessage" : "success",
  "Success" : true
}

错误码

访问错误中心查看更多错误码。