获取已经部署成功的算法模型列表。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /v4/openapi/app-groups/[appGroupIdentity]/deployed-algorithm-models HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
appGroupIdentity String Path my_app_group_name

应用名称

inServiceOnly Boolean Query false

是否只返回服务中的算法模型

algorithmType String Query POP

算法类型

  • POP 人气模型
  • CP 类目预测

返回数据

名称 类型 示例值 描述
requestId String 7F4DC674-961B-562A-BCAD-83D20A43A1B5

请求ID

result Array of result

部署成功的部署信息

参考:DeployedAlgorithm

appGroupName String tongtianhe_apitest

应用名称

apps List [ "100298098" ]

部署生效的版本

desc String ""

描述

gmtCreate String 2020-02-07T10:59:12+0000

部署时间

gmtModified String 2020-02-07T11:15:02+0000

更新时间

id String 281

部署ID

models Array of models

部署成功的算法模型

参考:DeployedAlgorithmModel

algorithmType String POP

算法类型

  • POP 人气模型
  • CP 类目预测
modelId Integer 363

模型ID

modelName String popV2

模型名称

progress Integer 100

预测进度,百分比

projectId Integer 1747

算法工程ID

status String IN_SERVICE

部署状态

参考:DeployedAlgorithm的 status

scene String SECOND_RANK

部署场景

  • FIRST_RANK 粗排
  • SECOND_RANK 精排
status String IN_SERVICE

部署状态

  • UNKNOWN 未知
  • PREDICTING 预测中
  • PENDING 待部署
  • REINDEX_PENDING 等待索引重建
  • REINDEXING 索引重建中(粗排部署中)
  • DEPLOYING 部署中(精排部署中)
  • IN_SERVICE 已生效
  • OFFLINE 已下线
  • TARGET_MISSING 部署目标消失

示例

请求示例

GET /v4/openapi/app-groups/os_function_test_v1/deployed-algorithm-models?algorithmType=CP&inServiceOnly=true

正常返回示例

XML格式

<requestId>7F4DC674-961B-562A-BCAD-83D20A43A1B5</requestId>
<result>
    <id>281</id>
    <appGroupName>tongtianhe_apitest</appGroupName>
    <scene>SECOND_RANK</scene>
    <desc/>
    <models>
        <modelName>popV2</modelName>
        <modelId>363</modelId>
        <progress>100</progress>
        <status>IN_SERVICE</status>
        <projectId>1747</projectId>
        <algorithmType>POP</algorithmType>
    </models>
    <gmtCreate>2020-02-07T10:59:12+0000</gmtCreate>
    <gmtModified>2020-02-07T11:15:02+0000</gmtModified>
    <status>IN_SERVICE</status>
    <apps>100298098</apps>
</result>

JSON格式

{
    "requestId": "7F4DC674-961B-562A-BCAD-83D20A43A1B5",
    "result": {
        "id": 281,
        "appGroupName": "tongtianhe_apitest",
        "scene": "SECOND_RANK",
        "desc": "",
        "models": {
            "modelName": "popV2",
            "modelId": 363,
            "progress": 100,
            "status": "IN_SERVICE",
            "projectId": 1747,
            "algorithmType": "POP"
        },
        "gmtCreate": "2020-02-07T10:59:12+0000",
        "gmtModified": "2020-02-07T11:15:02+0000",
        "status": "IN_SERVICE",
        "apps": 100298098
    }
}

错误码

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