Queries algorithm models that are deployed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request headers. For more information, see Common request parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.

inServiceOnly Boolean Query No false

Specifies whether to return only algorithm models that are in service.

algorithmType String Query No POP

The type of the algorithm. Valid values:

  • POP: popularity sorting
  • CP: category prediction

Response parameters

Parameter Type Example Description
requestId String 7F4DC674-961B-562A-BCAD-83D20A43A1B5

The ID of the request.

result Array of result

The deployment information of algorithms that are deployed.

For more information, see DeployedAlgorithm.

appGroupName String tongtianhe_apitest

The name of the application.

apps List [ "100298098" ]

The application version on which the algorithm takes effect.

desc String ""

The description of the algorithm that is deployed.

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

The time when the algorithm was deployed.

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

The time when the algorithm was last updated.

id String 281

The ID of the deployment.

models Array of models

The algorithm models that are deployed.

For more information, see DeployedAlgorithmModel.

algorithmType String POP

The type of the algorithm. Valid values:

  • POP: popularity sorting
  • CP: category prediction
modelId Integer 363

The ID of the model.

modelName String popV2

The name of the model.

progress Integer 100

The prediction progress, in percentage.

projectId Integer 1747

The ID of the algorithm project.

status String IN_SERVICE

The status of the deployment.

For more information, see the status parameter of the DeployedAlgorithm operation.

scene String SECOND_RANK

The scenario of the deployment. Valid values:

  • FIRST_RANK: rough sort
  • SECOND_RANK: fine sort
status String IN_SERVICE

The status of the deployment. Valid values:

  • UNKNOWN
  • PREDICTING
  • PENDING
  • REINDEX_PENDING
  • REINDEXING
  • DEPLOYING
  • IN_SERVICE
  • OFFLINE
  • TARGET_MISSING

Examples

Sample requests

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

Sample success responses

XML format

<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 format

{
    "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
    }
}

Error codes

For a list of error codes, visit the API Error Center.