ジャンプ先

• リクエスト
• レスポンス

エンドポイントの取得

get

/omlmod/v1/deployment

コール元に表示され、オプションのmodelName、version、namespace、modelTypeおよび共有パラメータを満たすエンドポイントのリストを取得します。コール元に表示されるのは、共有エンドポイントおよびコール元が作成したエンドポイントのみです。

リクエスト

問合せパラメータ

• modelName: string
  モデル名。
• modelType: string
  モデル・タイプ。

  使用可能な値: [ "OML", "ONNX", "ONNX_IMG" ]
• namespace: string
  モデル・ネームスペース。
• shared: boolean
  モデルが共有かどうか。

  許容値: [ true, false ]
• version: string
  モデル・バージョン。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

コール元に表示され、オプションのmodelName、versionおよびnamespaceパラメータを満たすエンドポイントのリスト。

本文()

ルート・スキーマ : DeploymentEndpointCollection

型: object

ソースの表示

• items(required): array items
• links(required): array links

{
    "required":[
        "items",
        "links"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DeploymentEndpoint"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

ネストされたスキーマ : items

型: array

ソースの表示

• 配列: object DeploymentEndpoint

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeploymentEndpoint"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object OMLResourceLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OMLResourceLink"
    }
}

ネストされたスキーマ : DeploymentEndpoint

型: object

ソースの表示

• createdBy(required): string
  パターン: [a-zA-Z][a-zA-Z0-9_$#]{1,127}
• description: string
• modelName(required): string
  パターン: [a-zA-Z0-9_]{1,50}
• modelType(required): string
  使用可能な値: [ "OML", "ONNX", "ONNX_IMG" ]
• namespace: string
  パターン: [a-zA-Z0-9_]{0,50}
• shared(required): boolean
  許容値: [ true, false ]
• version(required): string
  パターン: ^[1-9]?[0-9](\\.[0-9][0-9]?$)?

{
    "required":[
        "modelName",
        "version",
        "modelType",
        "createdBy",
        "shared"
    ],
    "properties":{
        "modelName":{
            "pattern":"[a-zA-Z0-9_]{1,50}",
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "version":{
            "pattern":"^[1-9]?[0-9](\\\\.[0-9][0-9]?$)?",
            "type":"string"
        },
        "modelType":{
            "type":"string",
            "enum":[
                "OML",
                "ONNX",
                "ONNX_IMG"
            ]
        },
        "createdBy":{
            "pattern":"[a-zA-Z][a-zA-Z0-9_$#]{1,127}",
            "type":"string"
        },
        "namespace":{
            "pattern":"[a-zA-Z0-9_]{0,50}",
            "type":"string"
        },
        "shared":{
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/CreatedEndpoint"
        }
    ]
}

すべて一致

ソースの表示

• object CreatedEndpoint

{
    "required":[
        "modelName",
        "version",
        "modelType",
        "createdBy",
        "shared"
    ],
    "properties":{
        "modelName":{
            "pattern":"[a-zA-Z0-9_]{1,50}",
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "version":{
            "pattern":"^[1-9]?[0-9](\\\\.[0-9][0-9]?$)?",
            "type":"string"
        },
        "modelType":{
            "type":"string",
            "enum":[
                "OML",
                "ONNX",
                "ONNX_IMG"
            ]
        },
        "createdBy":{
            "pattern":"[a-zA-Z][a-zA-Z0-9_$#]{1,127}",
            "type":"string"
        },
        "namespace":{
            "pattern":"[a-zA-Z0-9_]{0,50}",
            "type":"string"
        },
        "shared":{
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/CreatedEndpoint"
        }
    ]
}

ネストされたスキーマ : CreatedEndpoint

型: object

ソースの表示

• deployedOn(required): string (date-time)
• links(required): array links
• modelId(required): string
• uri(required): string
  パターン: [a-zA-Z0-9_]{1,200}

{
    "required":[
        "modelId",
        "deployedOn",
        "uri",
        "links"
    ],
    "properties":{
        "modelId":{
            "type":"string"
        },
        "deployedOn":{
            "type":"string",
            "format":"date-time"
        },
        "uri":{
            "pattern":"[a-zA-Z0-9_]{1,200}",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object OMLResourceLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OMLResourceLink"
    }
}

ネストされたスキーマ : OMLResourceLink

型: object

ソースの表示

• href(required): string
• rel(required): string

{
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        }
    }
}

400レスポンス

不正なリクエストです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

401レスポンス

認可されていません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

404レスポンス

リソースが見つかりません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

500レスポンス

リポジトリへの接続中の問題、問合せ実行中の問題、またはその他の予期しないエラーの問題です。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る