ModifyInstance_实例_API参考_开发参考

修改指定实例配置。

描述

如果实例已经执行了全量数据导入任务，则行业名称和场景名称信息无法修改，所以需要在全量导入之前确认您的行业和场景选择是否正确。

修改数据源信息（ dataSources ）必须全量提交，暂时不支持增量提交。

方法

PUT

URI

/openapi/instances/{instanceId}

请求参数

参数	类型	是否必需	描述
Name	String	否	实例名称。
Industry	String	否	行业名称。
Scene	String	否	场景名称。
DataSources	List< DataSource >	否	数据源列表。

返回参数

参数	类型	描述
RequestId	String	当前请求的RequestID
Result	Instance	实例基本信息

示例

请求示例

修改名称

PUT /openapi/instances/airec-cn-xxxxxx
{
    "name": "abc"
}

修改行业场景和数据源

{
  "industry": "content",
  "scene": "gul",
  "dataSources": [
    {
      "tableName": "user",
      "meta": {
        "type": "ODPS",
        "tableName": "table",
        "accessKeyId": "ak",
        "accessKeySecret": "secret",
        "projectName": "project_name",
        "timestamp": 1544112000000,
        "partition": "dt=20181122",
        "incEnabled": false, // 当前数据源是否支持实时数据
        "fullEnabled": true // 当前数据源是否支持历史全量数据
      }
    },
    {
      "tableName": "item",
      "meta": {
        "accessKeyId": "ak",
        "accessKeySecret": "secret",
        "projectName": "project",
        "type": "ODPS",
        "tableName": "table",
        "partition": "dt=20181122",
        "timestamp": 1544112000000,
        "incEnabled": false, // 当前数据源是否支持实时数据
        "fullEnabled": true // 当前数据源是否支持历史全量数据
      }
    },
    {
      "tableName": "behavior",
      "meta": {
        "type": "ODPS",
        "accessKeyId": "ak",
        "accessKeySecret": "secret",
        "projectName": "project",
        "tableName": "table",
        "partition": "dt=20181122",
        "timestamp": 1544112000000,
        "incEnabled": false, // 当前数据源是否支持实时数据
        "fullEnabled": true // 当前数据源是否支持历史全量数据
      }
    }
  ]
}

正常返回示例

JSON 格式

{
  "Result": {
    "InstanceId": "airec-cn-xxxxxx",
    "Name": "airec-cn-xxxxxx",
    "Type": "Standard",
    "Status": "Ready",
    "Industry": "content",
    "Scene": "gul",
    "RegionId": "cn-beijing",
    "ChargeType": "PrePaid",
    "CommodityCode": "airecpre",
    "GmtCreate": "2018-12-04T09:00:07.000Z",
    "GmtModified": "2018-12-07T02:24:25.000Z",
    "ExpiredTime": "2019-01-04T16:00:00.000Z",
    "LockMode": "Unlock"
  },
  "RequestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}

异常返回示例

JSON 格式

{
  "RequestId": "EDF43C1F-99E4-431F-A7C0-8B260A5A792E",
  "Code": "DataSourceUnavailable",
  "Message": "An error occurred while validating the data source, error infomation:  com.aliyun.odps.OdpsException: ODPS-0410042:Invalid signature value - User signature dose not match."
  }
}