百度机器学习BML

    预测服务相关接口

    镜像管理

    获取镜像列表

    接口描述

    获取可用的镜像列表。

    请求(Request)

    • 请求语法

       GET /v{version}/imageConfig?marker={marker}&maxKeys={maxKeys} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 参数类型 必要性 参数描述
      version String 必选 API 版本,当前为 2
      marker String 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
      maxKeys Int 可选 每页包含的最大数量,最大数量不能超过 1000,默认值为1000。

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 参数类型 参数描述
      marker String 标记查询的起始位置
      truncated Boolean true 表示后面还有数据,false 表示已经是最后一页
      nextMarker String 获取下一页所需要传递的 marker 值。当 truncated 为 false 时,该域不出现
      imageConfigList List<ImageConf> 镜像信息列表

    示例

    • 请求示例

       GET /v{version}/imageConfig?maxKeys=2 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json 
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T03:41:15Z/1800/host/031e3ba7b763426e1cf89f897c0eff4fc3f98ccdc3d05c08c42bb87f47fb4d76    
    • 响应示例

       {
           "truncated": false,
           "marker": "",
           "imageConfigList": [
               {
                   "imageId": "pds-abcd1234abcd1234",
                   "imageName": "公共镜像"
               }
           ]
       }

    预测模型管理

    获取预测模型列表

    接口描述

    获取可用的预测模型列表。

    请求(Request)

    • 请求语法

       GET /v{version}/modelConfig?marker=&maxKeys=&sourceType=&modelConfigName= HTTP/1.1
       Host: bml.{region}.baidubce.com  
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 参数类型 必要性 参数描述
      marker string 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
      maxKeys int 可选 每页大小,大于0小于1000,默认10
      sourceType string 可选 获取模型类型,system或者custom,传错或不传默认custom
      modelConfigName string 可选 根据模型名称模糊搜索

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 类型 描述
      truncated Bool true 表示后面还有数据,false 表示已经是最后一页
      nextMarker String 获取下一页所需要传递的 marker 值。当 truncated 为 false 时,该域不出现
      modelConfigList List<ModelConfig> 模型信息列表

    示例

    • 请求示例

       GET /v2/modelConfig?maxKey=2&sourceType=system HTTP/1.1
       host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T04:49:49Z/1800/host/66ea293f7e6177ab614c2fa94443e72db2a22a90f8f16453f4f74619a40bb3c9
    • 响应示例

       {
           "truncated": false,
           "marker": "",
           "modelConfigList": [
               {
                   "modelConfigId": "ifr-i6smyaac3hpjij2c",
                   "modelConfigName": "SE_ResNeXt50_32x4d",
                   "modelConfigDescription": "最新图像分类模型,使用ImageNet-1k数据集预训练,实现图像1000分类,具体信息参见https://github.com/hujie-frank/SENet",
                   "sourceType": "system",
                   "modelURI": "系统模型库",
                   "createTime": "2018-07-19 11:29:13"
               }
           ]
       }

    创建预测模型

    接口描述

    创建一个预测模型。

    请求(Request)

    • 请求语法
     POST /v{version}/modelConfig HTTP/1.1
     Host: bml.{region}.baidubce.com
     Content-Type: application/json
     Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 参数类型 必要性 参数描述
      modelConfigName string 必选 预测模型名称
      modelConfigDescription string 可选 描述
      modelURI string 必选 模型文件,如BOS地址
      modelFormat string 必选 必须是以下之一:paddle-fluid-v1.3.1,paddle-fluid-v1.4.0,tensorRT-v4_uff,sklearn-v0.20,xgboost-v0.81,xgboost-v0.82,tensorflow-v1.12,tensorflow-v1.13.1,pytorch-v1.1.0
      modelExtraInfo ModelExtraInfo 可选 某些模型格式所需的额外信息
      imageId string 可选 Inference Code,选择的镜像UUID
      imageSourceType string 必选 镜像类型,system/custom,当指定 system 时 imageId 无效

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 参数类型 参数描述
      modelConfId string 预测模型ID

    示例

    • 请求示例

          POST /v2/modelConfig HTTP/1.1
          Host: bml.bj.baidubce.com
          Content-Type: application/json  
          Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-25T03:46:09Z/1800/host/f748adfbb754844d1740f02bfb0a44b8a428e799418a9e333c6b9ed39686cb9c
      
          {
          “modelConfigName”: “test05”,
          “modelConfigDescription”: “this is test”,
          “modelURI”: “bos:/paddle-serving-test/SE_ResNeXt50_32x4d/“,
              “imageId”: “pds-abcd1234abcd1234”,
              “imageSourceType”: “custom”
          }
    • 响应示例

      {
          “modelConfigId”: “ifr-wvcnkiapdfwvvb26”
      }

    更新预测模型

    接口描述

    更新预测模型描述

    请求(Request)

    • 请求语法

       PUT /v{version}/modelConfig/{modelConfigId} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域:

      除公共头域,还包含

      参数名 类型 是否必须 描述
      x-bce-if-match string 必选 要更新的eTag
    • 请求参数:

      参数名 类型 是否必须 描述
      modelConfigDescription string 必选 描述

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数 ​ 无

    示例

    • 请求示例
     PUT /v2/modelConfig/ifr-dzsec4m2ihcwh7uq HTTP/1.1
     Host: bml.bj.baidubce.com
     Content-Type: application/json
     Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:05:36Z/1800/host/0ef61d91d9035aca5c8286603db3e04bf88195811eae09770e0feecede434e08
    
     {
         "modelConfigDescription": "test update"
     }
    • 响应示例 ​ 无

    删除预测模型

    接口描述

    删除指定的预测模型

    请求(Request)

    • 请求语法

       DELETE /v{version}/modelConfig/{modelConfigId} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例

       DELETE /v2/modelConfig/ifr-dzsec4m2ihcwh7uq HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:13:09Z/1800/host/d0ed4b068c1661753c3c048a3b430e960ea8cdf520d6b4267ddb699f04c8d579 
       {
          "modelConfId": "pds-mu4hc4x8mg9ih88i"
       }
    • 响应示例 ​ 无

    获取预测模型详情

    接口描述

    获取一个预测模型详细信息

    请求(Request)

    • 请求语法

       GET /v{version}/modelConfig/{modelConfigId} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数 ​

      参数名 类型 描述
      modelConfigId string 预测模型ID
      modelConfigName string 预测模型名称
      modelConfigDescription string 备注
      modelURI string 模型文件
      modelFormat string 模型格式
      modelExtraInfo ModelExtraInfo 某些模型格式所需的额外信息
      imageId string 镜像 ID,只有选择自定义镜像时才返回
      imageSourceType string 镜像类型,custom/system
      imageName string 镜像名称
      sourceType string 模型类型,custom/system
      createTime string 模型创建时间
      eTag string eTag

    示例

    • 请求示例

       GET /v2/modelConfig/ifr-wvcnkiapdfwvvb26 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:01:24Z/1800/host/328f661d308de082bfcd9cdac9b4452339b06a34d1eeaa7a15a98a8411b3b7b1
    • 响应示例

       {
           "modelConfigId": "ifr-wvcnkiapdfwvvb26",
           "modelConfigName": "test05",
           "modelConfigDescription": "this is test",
           "sourceType": "custom",
           "modelURI": "bos:/paddle-serving-test/SE_ResNeXt50_32x4d/",
           "modelFormat": "paddle-fluid-v0.14",
           "imageName": "公共镜像",
           "imageSourceType": "system",
           "createTime": "2018-10-25 11:49:03",
           "eTag": "e6f2998a76d580fc1855f9417c952790"
       }

    资源套餐管理

    获取资源套餐列表

    接口描述

    获取可用的资源套餐列表。

    请求(Request)

    • 请求语法
     GET /v{version}/resourceConfig?marker=&maxKeys= HTTP/1.1
     Host: bml.{region}.baidubce.com
     Content-Type: application/json
     Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 参数类型 必要性 参数描述
      version String 必选 API 版本,当前为 2
      marker String 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
      maxKeys Int 可选 每页包含的最大数量,最大数量不能超过 1000。

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 参数类型 参数描述
      marker String 标记查询的起始位置
      truncated Boolean true 表示后面还有数据,false 表示已经是最后一页
      nextMarker String 获取下一页所需要传递的 marker 值。当 truncated 为 false 时,该域不出现
      resourceConfigList List<ResourceConfig> 资源套餐信息列表

    示例

    • 请求示例

       GET /v2/resourceConfig?maxKeys=3 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:17:58Z/1800/host/a305e7945b3b2cd3b5eddb0bf705dc6f954d120e3bf19c6dfcf078288d1b3d9d
    • 响应示例
     {
         “truncated”: false,
         “marker”: “”,
         “resourceConfigList”: [
             {
                 “resourceConfigId”: “pds-bbcdabcd2bcdabcd”,
                 “resourceConfigName”: “CPU-4Cores_Memory-8GB”,
                 “resourceConfigDescription”: “CPU:4核,内存:8G”
             }
         ]
     }

    配置端点

    获取端点配置列表

    接口描述

    获取可用的端点配置列表。

    请求(Request)

    • 请求语法

       GET /v{version}/endpointConfig?marker=&maxKeys=&endpointConfigName= HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 类型 是否必须 描述
      marker string 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
      maxKeys int 可选 每页大小,大于0小于1000,默认10
      endpointConfigName string 可选 根据端点配置名称模糊搜索

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 参数类型 参数描述
      truncated Bool true 表示后面还有数据,false 表示已经是最后一页
      nextMarker String 获取下一页所需要传递的 marker 值。当 truncated 为 false 时,该域不出现
      endpointConfigList List<EndpointConf> 当前查询页的端点配置

    示例

    • 请求示例

       GET /v2/endpointConfig?endpointConfigName=&maxKeys=2 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:53:28Z/1800/host/7ebfd747a63a9181c140428db0c9b1b39a712ce014b96fee34cfbfd41d538aff
    • 响应示例

       {
           “truncated”: false,
           “marker”: “”,
           “endpointConfigList”: [
               {
                   “endpointConfigId”: “ifr-tmba81stnxi830e4”,
                   “endpointConfigName”: “endpointConfig-demo-test”,
                   “endpointConfigDescription”: “test by demo”,
                   “eTag”: “35de3d7b0de411f2e97ab4013f6e7e5e”,
                   “createTime”: “2018-10-16 14:25:10”,
                   “modifyTime”: “2018-10-16 14:25:10”
               }
           ]
       }

    创建预测模型

    接口描述

    创建一个预测模型。

    请求(Request)

    • 请求语法

       POST v{version}/endpointConfig HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 类型 是否必须 描述
      endpointConfigName string 必选 端点配置名称
      endpointConfigDescription string 可选 备注
      variantConfigs List<VariantConf> 必选 变体配置详情列表

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 类型 描述
      endpointConfigId string 创建的端点配置ID

    示例

    • 请求示例

      POST /v2/endpointConfig HTTP/1.1
      Host: bml.bj.baidubce.com
      Content-Type: application/json
      Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:25:10Z/1800/host/d090669e7b2f147ac8d3c95d09f0742aa64fd5a8749ec0447ac8d8e6bdca738a
      
      {
          “endpointConfigName”: “endpointConfig-demo-test”,
          “endpointConfigDescription”: “test by demo”,
          “variantConfigs”:[
              {
                  “varConfigName”: “v1”,
                  “varConfigDescription”: “demo test”,
                  “instanceCount”: 2,
                  “weight”: 5.0,
                  “modelConfigId”: “ifr-r1svi13gzjuwjejt”,
                  “resourceConfigId”: “pds-bbcdabcd2bcdabcd”
              }
          ]
      }
    • 响应示例

      {
          “endpointConfigId”: “ifr-tmba81stnxi830e4”
      }

    删除端点配置

    接口描述

    删除指定的端点配置

    请求(Request)

    • 请求语法

       DELETE v{version}/endpointConfig/{endpointConfigId} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例
     DELETE /v2/endpointConfig/ifr-tmba81stnxi830e4 HTTP/1.1
     Host: bml.bj.baidubce.com
     Content-Type: application/json
     Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:58:59Z/1800/host/85443ebb6bca1c25e2a92379cfd98149de84f7a00403b4c5f2d2149333cfc32e
    • 响应示例 无

    获取端点配置详情

    接口描述

    获取一个预测模型详细信息

    请求(Request)

    • 请求语法

       GET v{version}/endpointConfig/{endpointConfigId} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 参数类型 参数描述
      endpointConfigId string 端点配置ID
      endpointConfigName string 端点配置名称
      endpointConfigDescription string 备注
      eTag string 当前数据tag
      createTime string 当前配置第一次创建时间
      modifyTime string 当前配置最后一次修改时间
      variantConfigs List<VariantConfInfo> 变体配置详情列表(数据量少,不分页)

    示例

    • 请求示例

       GET /v2/endpointConfig/ifr-tmba81stnxi830e4 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T06:57:30Z/1800/host/07faa1005fe7bbe00dbf95583fd04739367ef1376c847b0c35d1212891895fa3
    • 响应示例

       {
           “endpointConfigId”: “ifr-tmba81stnxi830e4”,
           “endpointConfigName”: “endpointConfig-demo-test”,
           “endpointConfigDescription”: “test by demo”,
           “eTag”: “35de3d7b0de411f2e97ab4013f6e7e5e”,
           “createTime”: “2018-10-16 14:25:10”,
           “modifyTime”: “2018-10-16 14:25:10”,
           “variantConfigs”: [
               {
                   “varConfigId”: “ifr-8799ed6zdyjk19qd”,
                   “varConfigName”: “v1”,
                   “varConfigDescription”: “demo test”,
                   “instanceCount”: 2,
                   “weight”: 5,
                   “modelConfigId”: “ifr-r1svi13gzjuwjejt”,
                   “modelConfigName”: “test01”,
                   “resourceConfigId”: “pds-bbcdabcd2bcdabcd”,
                   “resourceConfigName”: “CPU-4Cores_Memory-8GB”,
                   “createTime”: “2018-10-16 14:25:10”,
                   “modifyTime”: “2018-10-16 14:25:10”
               }
           ]
       }

    更新预测模型

    接口描述

    更新预测模型描述

    请求(Request)

    • 请求语法

       PUT v{version}/endpointConfig/{endpointConfigId} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      除公共头域,还包含

      参数名 类型 是否必须 描述
      x-bce-if-match string 必选 要更新的eTag
    • 请求参数

      参数名 类型 是否必须 描述
      endpointConfigDescription string 可选 endpointConfig 备注
      variantConfigs List<VariantConf> 必选 变体配置详情列表

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      无特殊Header参数响应

    示例

    • 请求示例

       PUT /v2/endpointConfig/ifr-7m7fuep5izrsf591 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T07:04:01Z/1800/host/7bc90f601155a59720beddf0812f46df988e089412f0def404da84c869a2b81f
       x-bce-if-match: f58da65801ee0fd7583b3c34a9964324
       
       {
           "endpointConfigName":"update by test",
           "endpointConfigDescription":"update endpointConfigDescription", 
           "variantConfigs":[
               {
                   "varConfigName":"vartest",
                   "instanceCount":1,
                   "weight":1.0,
                   "modelConfigId":"ifr-r1svi13gzjuwjejt",
                   "resourceConfigId":"pds-bbcdabcd2bcdabcd"
               }
           ]
       }
    • 响应示例

    Endpoint

    获取端点列表

    接口描述

    获取可用的端点列表。

    请求(Request)

    • 请求语法

       GET /v{version}/endpoint?marker=&maxKeys=&endpointName= HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 参数类型 必要性 参数描述
      marker string 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
      maxKeys int 可选 每页大小,大于0小于1000,默认10
      endpointName string 可选 根据端点名称模糊搜索

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 参数类型 参数描述
      truncated Bool true 表示后面还有数据,false 表示已经是最后一页
      nextMarker String 获取下一页所需要传递的 marker 值。当 truncated 为 false 时,该域不出现
      endpointList List<Endpoint> 端点信息列表

    示例

    • 请求示例
     GET /v2/endpoint?maxKeys= HTTP/1.1
     Host: bml.bj.baidubce.com
     Content-Type: application/json
     Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T07:18:52Z/1800/host/ebed816695f7219a272fda3211b7f54bce54a2260971dd82bece286a8bfa4464
    • 响应示例
     {
         “truncated”: false,
         “marker”: “”,
         “endpointList”: [
             {
                 “endpointId”: “ifr-zzavjcvy4uzknt85”,
                 “endpointName”: “demo-endpoint”,
                 “status”: 1,
                 “statusUpdateTime”: “2018-10-16 15:18:06”,
                 “entry”: “https://bml-runtime.bj.baidubce.com/v1/endpoints/demo-endpoint/invocations”,
                 “createTime”: “2018-10-16 15:17:16”,
                 “modifyTime”: “2018-10-16 15:18:06”
             }
         ]
     }

    创建端点

    接口描述

    根据一个端点配置创建端点,云平台此时会进行实例分配与服务部署

    请求(Request)

    • 请求语法
    POST v{version}/endpoint HTTP/1.1
    Host: bml.{region}.baidubce.com
    Content-Type: application/json
    Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 参数类型 必要性 参数描述
      endpointName string 必选 端点名称
      endpointDescription string 可选 备注
      endpointConfigId string 必选 要部署的端点配置Id

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 类型 描述
      endpointId string 创建的端点ID

    示例

    • 请求示例

       POST /v2/endpoint HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T07:17:16Z/1800/host/8fbe0ff48f771c3d8e0711b1da46a5bfbfa82077fa71e750f458e4264afe73ec
       
       {
           "endpointName": "demo-endpoint",
           "endpointDescription": "this is demo",
           "endpointConfigId": "ifr-7m7fuep5izrsf591"
       }
    • 响应示例

      {
          "endpointId": "ifr-zzavjcvy4uzknt85"
      }

    启动端点

    接口描述

    根据一个已有的端点上启动端点,要求端点的状态为已停止

    请求(Request)

    • 请求语法

       PUT v{version}/endpoint/{endpointId}?start HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例

       PUT /v2/endpoint/ifr-zzavjcvy4uzknt85?start HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T07:25:36Z/1800/host/586e9ad146388a196ebbe0fcde848ca5e95928c43d76cefce63bc4c897d287ef
    • 响应示例

    停止端点

    接口描述

    根据一个已有的端点上启动端点,要求端点的状态为已停止

    请求(Request)

    • 请求语法

       PUT v{version}/endpoint/{endpointId}?stop HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例
     PUT /v2/endpoint/ifr-zzavjcvy4uzknt85?stop HTTP/1.1
     Host: bml.bj.baidubce.com
     Content-Type: application/json
     Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T07:26:21Z/1800/host/bed27f4b784906ad3d56e686bb0fcf0c7480f35b24d3c6a42f2ecf9592d719cb
    • 响应示例

    删除端点

    接口描述

    删除指定的端点,云平台会下线端点服务,并删除相关的实例。

    请求(Request)

    • 请求语法

       DELETE v{version}/endpoint/{endpointId} HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例

       DELETE /v2/endpoint/ifr-zzavjcvy4uzknt85 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T08:28:14Z/1800/host/b54e6ec43e6828d3e5382dbe46122227faea71584ffea39c7f0882aec0e68f19
    • 响应示例

    获取端点详情

    接口描述

    获取指定的端点详细信息

    请求(Request)

    • 请求语法

       GET v{version}/endpoint/{endpointId}
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

      参数名 类型 描述
      endpointId string 端点实例ID
      endpointName string 端点实例name
      endpointDescription string 端点实例描述
      status int 当前状态StatusCode
      statusUpdateTime string 状态更新时间
      entry string 服务访问入口
      eTag string etag
      createTime string 创建时间
      modifyTime string 更新时间
      variants List<FullVariant> 变体详情列表

    示例

    • 请求示例

       GET /v2/endpoint/ifr-zzavjcvy4uzknt85 HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T07:21:07Z/1800/host/b2b08e18125ab08c20392dc7bed4533e5999e31286c523f91f38e62b7afecd6b
    • 响应示例

       {
           “endpointId”: “ifr-zzavjcvy4uzknt85”,
           “endpointName”: “demo-endpoint”,
           “endpointDescription”: “this is demo”,
           “status”: 1,
           “statusUpdateTime”: “2018-10-16 15:18:06”,
           “entry”: “https://bml-runtime.bj.baidubce.com/v1/endpoints/demo-endpoint/invocations”,
           “createTime”: “2018-10-16 15:17:16”,
           “modifyTime”: “2018-10-16 15:18:06”,
           “eTag”: “5abee734411b2cc7c1d20d33b42b7e29”,
           “variants”: [
               {
                   “variantId”: “ifr-gtgt1hsbhjbhkepz”,
                   “variantConfigId”: “ifr-v15we3j1vbuekedt”,
                   “variantConfigName”: “vartest”,
                   “modelConfigId”: “ifr-r1svi13gzjuwjejt”,
                   “modelConfigName”: “test01”,
                   “resourceConfigId”: “pds-bbcdabcd2bcdabcd”,
                   “resourceConfigName”: “CPU-4Cores_Memory-8GB”,
                   “currentWeight”: 1,
                   “desiredWeight”: 1,
                   “currentInstanceCount”: 0,
                   “desiredInstanceCount”: 1,
                   “createTime”: “2018-10-16 15:17:16”
               }
           ]
       }

    全量更新端点

    接口描述

    更新指定端点的名称及描述,也可使用一份端点配置更新此端点,在线变更。

    变更流程:使用新端点配置部署新端点,流量从老端点切换到新端点,下线并删除老端点。

    请求(Request)

    • 请求语法

       PUT v{version}/endpoint/{endpointId}?update HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      无特殊 Header 参数

    • 请求参数

      参数名 类型 是否必须 描述
      endpointConfigId string 必选 要部署的端点配置Id

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例

       PUT /v2/endpoint/ifr-zzavjcvy4uzknt85?update HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T07:32:06Z/1800/host/74c83a7eff87a5b0aba524cd5511020d44bdd50cce87a857619df980df55fed6
       x-bce-if-match: 5abee734411b2cc7c1d20d33b42b7e29
       
       {
         "endpointConfigId": "ifr-mm9kpkemsxv6s5tm"
       }
    • 响应示例 ​ 无

    部分更新端点

    接口描述

    更新指定的Endpoint下面的部分Variant的配置,包括instance数量和流量分配的权重;每个VariantWeightInstance中指明的VariantId都会被更新,未出现的Variant不会更新。也可以更新端点描述。 ​ 请求(Request)

    • 请求语法
     PUT v{version}/endpoint/{endpointId}?partialUpdate HTTP/1.1
     Host: bml.{region}.baidubce.com
     Content-Type: application/json
     Authorization: {bce-authorization-string}
    • 请求头域

      无特殊Header参数

    • 请求参数

      参数名 参数类型 必要性 参数描述
      variantWeightCapacities List<VariantWeightCapacity> 必选 变体Weight和instanceCount配置列表

    响应(Response)

    • 响应头域

    无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例

       PUT /v2/endpoint/ifr-d2vca31d983p0y3z?partialUpdate HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T08:33:17Z/1800/host/a45922d52a0f6b11cd435c3995c807000f2ff572d03d42c432ba679895b7651f
       {
         "variantWeightCapacities": [
           {
             "variantId": "ifr-3b91khqfihpbiqjd",
             "weight": 2,
             "instanceCount": 2
           }  
         ]
       }
    • 响应示例

    更新端点描述

    接口描述

    更新端点描述;

    请求(Request)

    • 请求语法

       PUT v{version}/endpoint/{endpointId}?updateDescription HTTP/1.1
       Host: bml.{region}.baidubce.com
       Content-Type: application/json
       Authorization: {bce-authorization-string}
    • 请求头域

      公共头域外, 还包含:

      参数名 类型 是否必须 描述
      x-bce-if-match string 必选 要更新的eTag
    • 请求参数

      参数名 参数类型 必要性 参数描述
      endpointDescription string 必选 备注

    响应(Response)

    • 响应头域

      无特殊Header参数响应

    • 响应参数

    示例

    • 请求示例

       PUT /v2/endpoint/ifr-zzavjcvy4uzknt85?updateDescription HTTP/1.1
       Host: bml.bj.baidubce.com
       Content-Type: application/json
       Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T08:26:52Z/1800/host/ad17188ba68760c40ddd57c7393f32539f584358e457d321a8c6f6a1d612c6dc
       x-bce-if-match: 93602d8c60e73569816c94096ed9a816
      
       {
         "endpointDescription": "update description for endpoint"
       }
    • 响应示例