文档

UpdateInstance - 更新实例信息(旧)

更新实例信息,同时检查该实例连通性。

接口说明

调用 UpdateInstance 更新实例信息前,请先通过调用接口 GetInstanceListInstances 获取实例的完整信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:UpdateInstanceWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。

3***
InstanceTypestring

数据库类型,取值请参见 DbType 参数说明

mysql
InstanceSourcestring

数据库实例来源,取值如下:

  • PUBLIC_OWN:代表公网自建实例
  • RDS:代表 RDS 实例
  • ECS_OWN:代表 ECS 自建实例
  • VPC_IDC:代表 VPC IDC 自建实例
ECS_OWN
EnvTypestring

环境类型,取值如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT 环境
  • uat:UAT 环境
  • pet:压测环境
  • stag:STAG 环境
product
EcsInstanceIdstring

ECS 的实例 ID。

说明 如果 InstanceSource 取值为 ECS_OWN,此值必填。
i-2zei9gs1t7h8l7ac****
VpcIdstring

实例 VPC ID。

说明 如果 InstanceSource 取值为 VPC_IDC 时,此值必填。
vpc-xxx
EcsRegionstring

实例所在地域。

说明 如果 InstanceSource 取值为 RDS、ECS_OWN 或 VPC_IDC,此值必填。
cn-hangzhou
Hoststring

实例连接地址。

192.XXX.0.56
Portinteger

实例访问端口。

3306
Sidstring

实例 Sid。

说明 如果 InstanceType 为 ORACLE,此项必填。
XXX
DatabaseUserstring

数据库账号。

dbuser
DatabasePasswordstring

数据库访问密码。

******
InstanceAliasstring

实例别名,帮助用户快速区分定位该实例。

instance_test
DbaIdstring

实例 DBA 角色的用户 ID,可通过调用接口 ListUsersGetInstance 获取该参数的值。

27****
SafeRuleIdstring

实例的安全规则集(GroupName),可通过调用接口 ListStandardGroupsGetInstance 获取该参数的值。

3****
QueryTimeoutinteger

实例查询超时时间。

60
ExportTimeoutinteger

实例导出超时时间。

600
DataLinkNamestring

输入跨库查询 datalink 名称。

说明
  • 如果 UseDsql 取值为 1,此值必填。
  • DBLink 名称只能使用小写字母和下划线(_)。
  • DBLink 名称需要在租户内保持全局唯一性。
  • datalink_test
    DdlOnlineinteger

    实例是否开启无锁结构变更,取值如下:

    • 0 :不使用
    • 1 :原生无锁优先,失败转 DMS 执行
    • 2 :DMS 无锁变更执行
    0
    UseDsqlinteger

    是否启用跨实例查询,取值如下:

    • 0:不开启
    • 1:开启
    说明 支持的数据库类型:MySQL、SQL Server、PostgreSQL、PolarDB PostgreSQL 版(兼容 Oracle)、Redis。
    0
    InstanceIdstring

    实例 ID,可通过调用接口 GetInstance 获取该参数的值。

    126****
    SkipTestboolean

    实例是否忽略测试连通性。取值如下:

    • true:忽略
    • false:不忽略
    false
    EnableSellSitdstring
    • Y:开启敏感数据保护
    • N:关闭敏感数据保护
    • NULL 或其它:不更新敏感数据保护的状态,即保持原始的开启或关闭状态。
    Y
    TemplateIdlong

    更新分类分级模板 ID。您可以调用 ListClassificationTemplates 接口获取该参数的值。

    3***
    TemplateTypestring

    更新分类分级模板类型。您可以调用 ListClassificationTemplates 接口获取该参数的值。

    INNER

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    E9BEBF41-4F69-4605-A5D5-A67955173941
    ErrorCodestring

    错误码。

    UnknownError
    ErrorMessagestring

    错误信息。

    UnknownError
    Successboolean

    请求是否成功,返回值如下:

    • true:请求成功
    • false:请求失败
    false

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "E9BEBF41-4F69-4605-A5D5-A67955173941",
      "ErrorCode": "UnknownError",
      "ErrorMessage": "UnknownError",
      "Success": false
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈