文档中心 > API类目 > miniapp开放API

taobao.miniapp.widget.template.instance.query (小部件实例化版本查询)

小部件实例化版本查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param0 MiniAppInstantiateAppOpenQuery 可选 入参
  • └ page_size
  • Number
  • 可选
  • 20
  • 分页大小
  • └ template_id
  • String
  • 可选
  • 模版id
  • 模版id
  • └ page_num
  • Number
  • 可选
  • 1
  • 分页

响应参数

名称 类型 示例值 描述
result Result 返回结果 返回结果
  • └ err_code
  • String
  • 错误码
  • 错误码
  • └ err_message
  • String
  • 错误信息
  • 错误信息
  • model
  • MiniappInstanceAppAllVersionsDTO []
  • 返回结果
  • 返回结果
  • mini_app_entity_template_dto
  • MiniAppEntityTemplateDTO
  • 实体信息
  • 实体信息
  • └ id
  • String
  • 实例id
  • 实例id
  • └ appkey
  • String
  • 小部件appkey
  • 小部件appkey
  • └ app_name
  • String
  • 小部件名称
  • 小部件名称
  • app_version_list
  • MiniAppInstanceVersionDTO []
  • 版本信息
  • 版本信息
  • └ version
  • String
  • 实例版本
  • 实例版本
  • └ client
  • String
  • └ app_id
  • String
  • 小部件id
  • 小部件id
  • └ status
  • String
  • ONLINE
  • 版本状态
  • └ template_id
  • String
  • 模版id
  • 模版id
  • └ template_version
  • String
  • 模版版本
  • 模版版本
  • └ success
  • String
  • true
  • 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
MiniappWidgetTemplateInstanceQueryRequest req = new MiniappWidgetTemplateInstanceQueryRequest();
MiniappWidgetTemplateInstanceQueryRequest.MiniAppInstantiateAppOpenQuery obj1 = new MiniappWidgetTemplateInstanceQueryRequest.MiniAppInstantiateAppOpenQuery();
obj1.setPageSize(20L);
obj1.setTemplateId("模版id");
obj1.setPageNum(1L);
req.setParam0(obj1);
MiniappWidgetTemplateInstanceQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<miniapp_widget_template_instance_query_response>
    <result>
        <err_code>错误码</err_code>
        <err_message>错误信息</err_message>
        <model>
            <miniapp_instance_app_all_versions_d_t_o>
                <mini_app_entity_template_dto>
                    <id>实例id</id>
                    <appkey>小部件appkey</appkey>
                    <app_name>小部件名称</app_name>
                </mini_app_entity_template_dto>
                <app_version_list>
                    <mini_app_instance_version_d_t_o>
                        <version>实例版本</version>
                        <client>端</client>
                        <app_id>小部件id</app_id>
                        <status>ONLINE</status>
                        <template_id>模版id</template_id>
                        <template_version>模版版本</template_version>
                    </mini_app_instance_version_d_t_o>
                </app_version_list>
            </miniapp_instance_app_all_versions_d_t_o>
        </model>
        <success>true</success>
    </result>
</miniapp_widget_template_instance_query_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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部