UpdateInstance_数据管理_API文档-阿里云OpenAPI开发者门户

接口说明

调用 UpdateInstance 更新实例信息前，请先通过调用接口 GetInstance 或 ListInstances 获取实例的完整信息。

流控信息

请求速率为100/1(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

dms:UpdateInstance	Update	全部资源 *	无	无

请求参数

字段名称	字段详情
Tidinteger<int64>	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:3***
InstanceTypestring	数据库类型，取值请参见 DbType 参数说明。示例值:mysql参考取值来源: GetInstance AddInstance RegisterInstance ListInstances
InstanceSourcestring	数据库实例来源，取值如下：展开详情示例值:ECS_OWN参考取值来源: GetInstance RegisterInstance AddInstance ListInstances
EnvTypestring	环境类型，取值如下：展开详情示例值:product枚举值:productpredevtest
EcsInstanceIdstring	ECS 的实例 ID。展开详情示例值:i-2zei9gs1t7h8l7ac****参考取值来源: ListInstances GetInstance
VpcIdstring	实例 VPC ID。展开详情示例值:vpc-xxx
EcsRegionstring	实例所在地域。展开详情示例值:cn-hangzhou
Hoststring	实例连接地址。示例值:192.XXX.0.56
Portinteger<int32>	实例访问端口。示例值:3306
Sidstring	实例 Sid。展开详情示例值:XXX
DatabaseUserstring	数据库账号。示例值:dbuser
DatabasePasswordstring	数据库访问密码。示例值:******
InstanceAliasstring	实例别名，帮助用户快速区分定位该实例。示例值:instance_test参考取值来源: ListInstances AddInstance RegisterInstance GetInstance
DbaIdstring	实例 DBA 角色的用户 ID，可通过调用接口 ListUsers 或 GetInstance 获取该参数的值。示例值:27****
SafeRuleIdstring	实例的安全规则集（GroupName），可通过调用接口 ListStandardGroups 或 GetInstance 获取该参数的值。示例值:3****
QueryTimeoutinteger<int32>	实例查询超时时间。示例值:60
ExportTimeoutinteger<int32>	实例导出超时时间。示例值:600
DataLinkNamestring	输入跨库查询 datalink 名称。展开详情示例值:datalink_test
DdlOnlineinteger<int32>	实例是否开启无锁结构变更，取值如下：展开详情示例值:0枚举值:012
UseDsqlinteger<int32>	是否启用跨实例查询，取值如下：展开详情示例值:0枚举值:01
InstanceIdstring	实例 ID，可通过调用接口 GetInstance 获取该参数的值。示例值:126****参考取值来源: GetInstance ListInstances
SkipTestboolean	实例是否忽略测试连通性。取值如下：展开详情示例值:false
EnableSellSitdstring	Y：开启敏感数据保护展开详情示例值:Y
TemplateIdinteger<int64>	更新分类分级模板 ID。您可以调用 ListClassificationTemplates 接口获取该参数的值。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:3***参考取值来源: AddAuthorityTemplateItems UpdateAuthorityTemplate ListAuthorityTemplate CreateAuthorityTemplate GetClassificationTemplate
TemplateTypestring	更新分类分级模板类型。您可以调用 ListClassificationTemplates 接口获取该参数的值。示例值:INNER参考取值来源: GetClassificationTemplate ListClassificationTemplates

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:E9BEBF41-4F69-4605-A5D5-A67955173941
ErrorCodestring	错误码。示例值:UnknownError
ErrorMessagestring	错误信息。示例值:UnknownError
Successboolean	请求是否成功，返回值如下：展开详情示例值:false

返回示例

变更历史

暂无变更历史