创建 forecast agent 实例
接口说明
创建资产盘点任务,支持选择实例、数据库、表维度进行知识盘点,返回任务 ID
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DataRegion |
string |
否 |
数据湖所属的地域。 |
cn-hangzhou |
| DryRun |
boolean |
否 |
是否开启 DryRun 模式。true:开启 false(默认值):关闭 DryRun 模式用于测试 API 调用,验证您是否具有相应资源的权限,以及请求参数是否配置正确。DryRun 模式开启后,KMS 会始终返回失败并提示失败原因。失败原因包含如下:DryRunOperationError:不配置 DryRun 参数时,请求会成功。ValidationError:请求中指定的参数有误。AccessDeniedError:您无权在 KMS 资源上执行该操作。 |
True |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
427688B8-ADFB-4C4E-9D45-EF5C1FD6**** |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Success |
boolean |
请求是否成功,返回值如下:
|
true |
| ErrorCode |
string |
错误码。 |
UnknownError |
| Message |
string |
执行失败时,返回的错误信息。 |
UnknownError |
| Root |
object |
Dify 相关信息。 |
|
| InstanceUuid |
string |
恢复目标服务器数据库备份客户端唯一标识。 说明
调用 DescribeUniBackupDatabase 接口可以获取该参数。 |
*** |
| RegionId |
string |
选择 DMS 的服务地域,用于调用该接口,取值请参见 RegionID 参数说明。 说明
请根据应用所在地就近选择。 |
cn-chengdu |
| Status |
string |
Dify 实例的状态。包括 DEPLOYED(运行中)、未配置等。 |
DEPLOYED |
| CurrentStep |
string |
任务当前操作步数。 |
PRE_CHECK |
| TaskId |
string |
任务 ID。 |
t-0002kwya4y5ydqvuof6b |
| ImageVersion |
string |
镜像版本。 说明
当您指定了实例 ID( |
3.5.3.925 |
| FailureMessage |
string |
失败消息。创建失败后,返回该字段。 |
missing parameter: aliyunParentUid |
示例
正常返回示例
JSON格式
{
"RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
"HttpStatusCode": 200,
"Success": true,
"ErrorCode": "UnknownError",
"Message": "UnknownError",
"Root": {
"InstanceUuid": "***",
"RegionId": "cn-chengdu",
"Status": "DEPLOYED",
"CurrentStep": "PRE_CHECK",
"TaskId": "t-0002kwya4y5ydqvuof6b",
"ImageVersion": "3.5.3.925",
"FailureMessage": "missing parameter: aliyunParentUid"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。