lianfan.huiwa.model.get (模型查询接口)

模型查询接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
model_page_top_query ModelPageTopQuery 必须 查询参数
  • model_page_query
  • ModelPageQuery
  • 必须
  • 查询参数
  • └ page_index
  • Number
  • 可选
  • 1
  • 页码
  • └ model_ids
  • Number []
  • 可选
  • [122]
  • 模型id列表
  • └ page_size
  • Number
  • 可选
  • 10
  • 页大小
  • └ source
  • Number
  • 必须
  • 1
  • 模型来源,0:系统预置,1:用户私有
  • └ tag
  • String
  • 可选
  • 户外
  • 标签,仅支持查询预置模型,即source=0
  • └ type
  • Number
  • 必须
  • 1
  • 模型类型,1:模特,2:商品,3:参考图
  • └ ratio
  • String
  • 可选
  • 1:1
  • 仅在参考图下生效,参考图的比例

响应参数

名称 类型 示例值 描述
pagination PaginationDTO 分页
  • └ total
  • Number
  • 100
  • 总数量
  • └ page_size
  • Number
  • 20
  • 页大小
  • └ page
  • Boolean
  • true
  • 是否分页
  • └ current_page
  • Number
  • 1
  • 页码
succeed Boolean true 请求是否成功
error_codes ErrorCodeDTO [] 错误码
  • └ code
  • String
  • error
  • 错误码
  • └ message
  • String
  • error
  • 错误描述
model ModelDTO [] 查询结果
  • └ model_id
  • Number
  • 1222
  • 模型id
  • └ type
  • Number
  • 1
  • 模型类型
  • └ name
  • String
  • tom
  • 模型名称
  • └ cover_image_url
  • String
  • https://img.alicdn.com/imgextra/i4/O1CN01ebbzA11aTeFBRjNmQ_!!6000000003331-0-tps-768-1024.jpg
  • 封面图
  • task_status
  • ModelTaskStatusDTO
  • 模型训练状态
  • └ status_value
  • Number
  • 1
  • 模型训练状态值,1:排队中,2:生成中,4:生成成功,-1:生成失败
  • └ remark
  • String
  • error
  • 失败时的失败原因
  • └ pass_through
  • String
  • {}
  • 扩展字段
  • └ image_ratio
  • String
  • 3:4
  • 参考图比例
error ErrorCodeDTO 错误信息
  • └ code
  • String
  • error
  • 错误码
  • └ message
  • String
  • message
  • 错误描述

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LianfanHuiwaModelGetRequest req = new LianfanHuiwaModelGetRequest();
LianfanHuiwaModelGetRequest.ModelPageTopQuery obj1 = new LianfanHuiwaModelGetRequest.ModelPageTopQuery();
LianfanHuiwaModelGetRequest.ModelPageQuery obj2 = new LianfanHuiwaModelGetRequest.ModelPageQuery();
obj2.setPageIndex(1L);
obj2.setModelIds(new Long[] { 122 };
);
obj2.setPageSize(10L);
obj2.setSource(1L);
obj2.setTag("户外");
obj2.setType(1L);
obj2.setRatio("1:1");
obj1.setModelPageQuery(obj2);
req.setModelPageTopQuery(obj1);
LianfanHuiwaModelGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<lianfan_huiwa_model_get_response>
    <pagination>
        <total>100</total>
        <page_size>20</page_size>
        <page>true</page>
        <current_page>1</current_page>
    </pagination>
    <succeed>true</succeed>
    <error_codes>
        <error_code_d_t_o>
            <code>error</code>
            <message>error</message>
        </error_code_d_t_o>
    </error_codes>
    <model>
        <model_d_t_o>
            <model_id>1222</model_id>
            <type>1</type>
            <name>tom</name>
            <cover_image_url>https://img.alicdn.com/imgextra/i4/O1CN01ebbzA11aTeFBRjNmQ_!!6000000003331-0-tps-768-1024.jpg</cover_image_url>
            <task_status>
                <status_value>1</status_value>
                <remark>error</remark>
            </task_status>
            <pass_through>{}</pass_through>
            <image_ratio>3:4</image_ratio>
        </model_d_t_o>
    </model>
    <error>
        <code>error</code>
        <message>message</message>
    </error>
</lianfan_huiwa_model_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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部