Doc CenterSign in to zenConsole

ModifyCloudRoutersAttribute

1. API Description

This API is used to modify information of one or more Layer 3 cloud routers, including names and descriptions.

Note

If any of the cloud router IDs does not exist, the operation will fail immediately. Information of other cloud routers will not be modified.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

cloudRouterIds

Yes

Array of String

Cloud router ID list. You can query up to 100 IDs in each request.

cloudRouterName

No

String

Cloud router name.

Up to 255 characters in length are allowed. One of the name and the description must be specified. If the name value is null, the current name will not be modified.

cloudRouterDescription

No

String

Cloud router description.

Up to 255 characters in length are allowed. One of the name and the description must be specified. If the description value is null, the current description will not be modified.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Modify a Layer 3 cloud router name.

POST /api/v2/sdn HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyCloudRoutersAttribute
<Common Request Params>

Request：
{
    "cloudRouterIds": ["your-cloud-router-id"],
    "cloudRouterName": "Global-Edge-Router"
}

Response：
{   
  "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​

Last updated