文档首页/ 分布式缓存服务 DCS/ API参考/ API V2（推荐）/ 实例管理/ 开启/修改实例公网访问
更新时间：2024-12-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

开启/修改实例公网访问

功能介绍

开启/修改实例公网访问。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/instances/{instance_id}/public-ip

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip_id

否

String

公网访问绑定的ELB的EIP的ID，当Redis版本为3.0时，该参数为必填参数。

enable_ssl

否

Boolean

是否开启SSL，仅在开启SSL时有值，当Redis版本为3.0时，该参数为必填参数。

elb_id

否

String

公网访问绑定的ELB ID，当Redis版本为4.0，5.0，6.0和企业版时，该参数为必填参数。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

请求提交任务ID。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

请求示例

  • 开启Redis 4.0及以上版本公网访问。

    POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/public-ip

{
  "elb_id" : "3ee8da68-5a23-4ca4-b5e0-74ff996e16be"
}

  • 开启Redis 3.0版本公网访问。

    {
  "enable_ssl" : true,
  "publicip_id" : "00130845-97c3-43fa-88eb-85cfb08d87ca"
}

响应示例

状态码： 200

提交开启实例公网访问任务成功。

{
  "job_id" : "ff808081816ba43101816ba4e0ea0000"
}

状态码： 400

非法请求。

{
  "error_code" : "DCS.4063",
  "error_msg" : "Invalid {0} parameter in the request."
}

状态码

状态码

描述

200

提交开启实例公网访问任务成功。

204

开启/修改 Redis 3.0 实例公网访问成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 实例管理

相关文档