设置生命周期的状态 - UpdateState
功能介绍
本接口用于修改或切换数据实例所绑定的生命周期状态,支持单个或批量实例的状态更新。
在调用本接口前,请确保目标数据模型满足以下条件:
接口约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/updateState
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| identifier | 是 | String | 参数解释: 应用的唯一标识。 获取方法请参见获取运行服务清单 - ListEnvs。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID,用于指定实例所属的应用。 当URL路径中已能明确应用上下文时,此参数可不传。 获取方法请参见获取租户下的应用清单 - ListApps。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度固定为1-32个字符。 默认取值: 不涉及。 |
| params | 是 | Array of LifecycleManagedModelUpdateLifecycleStateDTO objects | 参数解释: 请求参数对象数组,每个元素包含一个待修改生命周期状态的数据实例信息。支持批量操作。 约束限制: 单次请求不超过1000条。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: 数据实例ID,用于指定待修改生命周期状态的数据实例。 获取方法请参见分页查询实例 - ShowFindUsingPost。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
| lifecycleState | 是 | ObjectReferenceParamDTO object | 参数解释: 生命周期状态对象,用于指定目标生命周期状态。该状态必须属于实例当前绑定的生命周期模板。 约束限制: 指定的lifecycleState必须存在于当前实例绑定的生命周期模板中。 取值范围: 不涉及。 默认取值: 不涉及。 |
| modifier | 否 | String | 参数解释: 更新者账号,用于记录执行设置生命周期状态操作的用户标识。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: 数据实例ID,用于唯一标识引用的数据实例。 获取方法请参见分页查询实例 - ShowFindUsingPost。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
| clazz | 否 | String | 参数解释: 类名,用于指定引用对象的类类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
请求示例
示例:为单个数据实例设置生命周期状态
为数据实例ID为1设置生命周期状态为609794709757366272,操作人为test1。
POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/LifecycleManagedModel/updateState
{
"params" : [ {
"id" : "1",
"lifecycleState" : {
"id" : "609794709757366272",
"clazz" : "LifecycleState"
},
"modifier" : "test1"
} ]
} 响应示例
状态码:200
OK,表示请求成功。
{
"result" : "SUCCESS",
"data" : [ ],
"errors" : [ ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK,表示请求成功。 |
错误码
请参见错误码。