首页 云数据库 RDS API参考 API目录 集群版实例 ModifyDBInstanceEndpoint - 修改实例的Endpoint权重信息

ModifyDBInstanceEndpoint - 修改实例的Endpoint权重信息

该接口用于修改RDS MySQL集群版实例的Endpoint权重信息。

接口说明

适用引擎

RDS MySQL

调试

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

调试

授权信息

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

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

请求参数

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

该参数用于保证请求的幂等性,防止重复提交请求。参数值由客户端生成,保证在不同请求间唯一。

该参数值由ASCII字符组成,最长不超过64个字符,不能包含非ASCII字符。

6000170000591aed949d0f****
DBInstanceIdstring

实例ID。可调用DescribeDBInstances查询。

rm-****
DBInstanceEndpointIdstring

实例的Endpoint ID。可调用DescribeDBInstanceEndpoints查询。

ep-****
DBInstanceEndpointDescriptionstring

用户自定义的Endpoint描述。

for readonly business
NodeItemsobject []

Endpoint节点相关信息列表。

DBInstanceIdstring

实例ID。可调用DescribeDBInstances查询。

rm-****
NodeIdstring

节点ID。

可以通过以下方式查询节点ID:

rn-xxxx-****
Weightlong

节点当前权重取值,按照该取值分配读流量。

取值范围:0~100

50

返回参数

名称类型描述示例值
object

返回参数详情。

Dataobject

返回字段列表。

DBInstanceNamestring

实例ID。

rm-****
DBInstanceEndpointIdstring

实例的Endpoint ID。

ep-****
RequestIdstring

请求ID。

F2911788-25E8-42E5-A3A3-1B38D263F01E

示例

正常返回示例

JSON格式

{
  "Data": {
    "DBInstanceName": "rm-****",
    "DBInstanceEndpointId": "ep-****"
  },
  "RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}

错误码

HTTP status code错误码错误信息描述
400InvalidSourceCategoryspecified source category is invalid.指定的源类别无效。
400InvalidDBInstanceConnType.FormatSpecified DB instance conn type is not valid.操作失败,当前数据库实例的连接类型不支持此操作。
400APICallingFailedMeta db calling failed.API调用异常。
400InvalidNodeItems.JsonFormatNodeItems is not a json string.NodeItems要求是一个JSON字符串。
400EmptyEndpointNodeConfigSpecified endpoint has no nodes, add node to endpoint first.endpoint下没有挂任何节点,请先给endpoint添加节点。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.数据库实例ID不存在,请检查。
404Endpoint.NotFoundSpecified endpoint is not existed.目标的endpoint不存在。
404InvalidConnectionString.NotFoundSpecified connection string or net type is not found.连接串不存在。请检查连接串是否正确。
404InvalidWeight.FormatThe Specified Weight format is not valid.无效的权重范围。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

阿里云首页 关系型数据库 相关技术圈