文档首页/企业路由器 ER/API参考（安卡拉区域）/API/其他连接/更新连接基本信息
更新时间：2024-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新连接基本信息

功能介绍

修改连接基本信息。

调用方法

请参见如何调用API。

URI

PUT /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

er_id

是

String

企业路由器实例ID

attachment_id

是

String

连接ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

attachment

否

UpdateAttachmentBody object

更新连接基本信息

表3 UpdateAttachmentBody

参数

是否必选

参数类型

描述

description

否

String

连接描述信息，取值范围：最大长度36字节，带“-”连字符的UUID格式

最小长度：0

最大长度：255

name

否

String

连接名称，取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最小长度：1

最大长度：64

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

attachment

AttachmentResponse object

连接基本信息详情

request_id

String

请求id

表5 AttachmentResponse

参数

参数类型

描述

name

String

连接名字

id

String

连接ID

description

String

描述信息

state

String

连接状态:pending|available|modifying|deleting|deleted|failed|pending_acceptance|rejected|initiating_request|freezed

created_at

String

创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

String

更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

tags

Array of Tag objects

企业路由器关联tag

project_id

String

项目ID

resource_id

String

内部连接关联的资源ID

resource_type

String

内部连接关联的资源类型:

  • vgw：云专线的虚拟网关

  • vpn：vpn网关

  • gdgw：下一代专线网关

  • vpc：虚拟私有云

resource_project_id

String

资源所属项目ID

表6 Tag

参数

参数类型

描述

key

String

标签键，规则：

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及字符：下划线“_”，点“.”，冒号“:”，等号“=”，加号“+”，中划线“-”，“@”。

  • _sys_开头属于系统标签，租户不能输入。

  • 标签key不能为空（长度不能为0）。

  • 长度在1-128之间。

最小长度：1

最大长度：128

value

String

标签值，规则：

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及字符：下划线“_”，点“.”，冒号“:”，等号“=”，加号“+”，中划线“-”，“@”。

  • 资源标签值可以为空（empty or null）。

  • 长度在0-255之间。

最小长度：0

最大长度：255

请求示例

更新企业路由器内其他类型连接（非VPC连接）的名称

PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/212d3f0b-8496-472d-bc99-05a7c96d6655/attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8

{
  "attachment" : {
    "name" : "attachment",
    "description" : "attachment"
  }
}

响应示例

状态码： 200

OK

{
  "attachment" : {
    "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
    "name" : "attachment",
    "description" : "attachment",
    "state" : "avaliable",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
    "resource_type" : "vpc",
    "resource_project_id" : "0605767a9980d5762fbcc00b3537e757"
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：其他连接