Modifies the name and description of an ECR attachment for an Enterprise Edition Transit Router.
Operation description
UpdateTransitRouterEcrAttachmentAttribute is an asynchronous call. After you send a request, the system returns a request ID, but the ECR attachment is not modified immediately. The modification task runs in the background. You can call ListTransitRouterEcrAttachments to query the status of the ECR attachment.
If an ECR attachment is in the Modifying state, you can only query the attachment and cannot perform other operations on it. When the attachment enters the Attached state, the modification is complete.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
cen:UpdateTransitRouterEcrAttachmentAttribute |
update |
*TransitRouterEcrAttachment
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
The client token that ensures the idempotence of the request. You can generate a token from your client, but you must ensure that it is unique across requests. The Note
If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. |
123e4567-e89b-12d3-a456-42665544**** |
| TransitRouterAttachmentId |
string |
Yes |
The ID of the ECR attachment. |
tr-attach-r6g0m3epjehw57**** |
| TransitRouterAttachmentName |
string |
No |
The new name of the ECR attachment. The name can be empty or 1 to 128 characters in length. It cannot start with |
nametest |
| TransitRouterAttachmentDescription |
string |
No |
The new description of the ECR attachment. The description can be empty or 1 to 256 characters in length. It cannot start with |
desctest |
| DryRun |
boolean |
No |
Specifies whether to perform a dry run to check for potential issues, including permissions and instance status. Valid values:
|
false |
| OrderType |
string |
No |
The payer for the network instance. This operation does not support changing the payer for an ECR attachment. |
PayByCenOwner |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
54B48E3D-DF70-471B-AA93-08E683A1B457 |
Examples
Success response
JSON format
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidTransitRouterAttachmentId.NotFound | TransitRouterAttachmentId is not found. | The error message returned because the ID of the network instance does not exist. |
| 400 | IncorrectStatus.TransitRouterAttachment | The status of TransitRouterAttachment is incorrect. | The error message returned because the status of the transit router attachment does not support this operation. Try again later. |
| 400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | The error message returned because you do not have the permissions to perform this operation. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.