注意:以下文档只适用于TOP接口,请谨慎使用!

yunos.ospush.open.tagvalue.get (标签tagValues查询接口)

标签tagValues查询接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
session_id String 必须 DX1234
  • 最大长度:63
  • 自定义随机字符串,用以标识本次调用。每次调用值不要相同
    tag_code String 必须 tag1 用以查询的tagCode
    page_start Number 必须 0
  • 最大长度:10
  • 每页起始查询参数
    page_size Number 必须 100
  • 最大长度:3
  • 每页查询数量
    cond_map Json 可选 {} 备用参数,目前未启用

    响应参数

    名称 类型 示例值 描述
    result TopResult result result
    • model
    • OpenTagValueResult
    • model
    • model
    • └ session_id
    • String
    • DX1234
    • sessionId
    • └ tag_code
    • String
    • 传入的tagCode
    • tagCode
    • └ total_size
    • Number
    • 此tagCode有的tagValues数量
    • totalSize
    • tag_value_list
    • OpenTagValue []
    • OpenTagValue
    • tagValueList
    • └ value_code
    • String
    • 1
    • valueCode
    • └ value_name
    • String
    • 测试值1
    • valueName
    • └ code
    • String
    • 10000
    • code
    • └ msg
    • String
    • 操作成功
    • msg

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    YunosOspushOpenTagvalueGetRequest req = new YunosOspushOpenTagvalueGetRequest();
    req.setSessionId("DX1234");
    req.setTagCode("tag1");
    req.setPageStart(0L);
    req.setPageSize(100L);
    req.setCondMapString("{}");
    YunosOspushOpenTagvalueGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <yunos_ospush_open_tagvalue_get_response>
        <result>
            <model>
                <session_id>DX1234</session_id>
                <tag_code>传入的tagCode</tag_code>
                <total_size>此tagCode有的tagValues数量</total_size>
                <tag_value_list>
                    <open_tag_value>
                        <value_code>1</value_code>
                        <value_name>测试值1</value_name>
                    </open_tag_value>
                </tag_value_list>
            </model>
            <code>10000</code>
            <msg>操作成功</msg>
        </result>
    </yunos_ospush_open_tagvalue_get_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    isv.10100 入参参数非法 入参参数非法
    isv.10020 push渠道非法 push渠道非法
    isv.13000 tagCode查询失败! 检查tagCode
    isv.13001 未找到此tagCode 未找到此tagCode
    isp.13100 标签value查询失败! 可以联系管理员查看
    isv.13101 未找到此tagCode对应的标签值 未找到此tagCode对应的标签值
    isv.13102 此tagCode非checkbox类型 非checkBox的tagCode不能查询

    API工具

    如何获得此API

    FAQ

    返回
    顶部