Updating an Attachment

Function

This API is used to update basic information about an attachment.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
er:commonAttachments:update	Write	attachments *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	er:attachments:update	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
er_id	Yes	String	Enterprise router ID
attachment_id	Yes	String	Attachment ID

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
attachment	No	UpdateAttachmentBody object	Change basic information about the attachment.

**Table 3** UpdateAttachmentBody
Parameter	Mandatory	Type	Description
description	No	String	Description of the attachment. The value contains a maximum of 36 characters in UUID format with hyphens (-). Minimum: 0 Maximum: 255
name	No	String	Attachment name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). Minimum: 1 Maximum: 64

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
attachment	AttachmentResponse object	Attachment basic information
request_id	String	Request ID

**Table 5** AttachmentResponse
Parameter	Type	Description
name	String	Attachment name
id	String	Attachment ID
description	String	Description
state	String	Definition: Attachment status. Range: pending available modifying deleting deleted failed pending_acceptance rejected initiating_request freezed invalid
created_at	String	Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ
updated_at	String	Update time in the format of YYYY-MM-DDTHH:mm:ss.sssZ
tags	Array of Tag objects	Attachment tags.
project_id	String	Project ID
resource_id	String	Attached resource ID on its own service console
resource_type	String	Attachment type. vgw: Direct Connect virtual gateway vpn: VPN gateway gdgw: global DC gateway peering: peering connection. A cloud connection is used to connect two enterprise routers from different regions to form a peering connection attachment. vpc: VPC
resource_project_id	String	ID of the project that the resource belongs to

**Table 6** Tag
Parameter	Type	Description
key	String	Tag key. A tag key can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@ A tag key cannot be left blank. A tag key can contain 1 to 128 characters. Tags with the tag key starting with _sys_ are system tags and cannot be added by tenants. Minimum: 1 Maximum: 128
value	String	Tag value. A tag value can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@ A tag value can be left blank or set to null. A tag value can contain 0 to 255 characters. Minimum: 0 Maximum: 255

Example Requests

Updating an attachment (not a VPC attachment)

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

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

Example Responses

Status code: 200

{
  "attachment" : {
    "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
    "name" : "attachment",
    "description" : "attachment",
    "state" : "available",
    "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"
}