Replicating a Parameter Template
Function
This API is used to replicate a parameter template. Before calling this API:
- Learn how to authenticate it.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/configurations/{configuration_id}/copy
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
| configuration_id | Yes | String | Definition ID of a custom parameter template. Constraints N/A Range To obtain this value, see Querying Parameter Templates. After the request is processed, the value of id in the response body is the value of configuration_id. Enter the ID of the configuration whose user_defined is set to true. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A |
| X-Language | No | String | Definition Request language type. Constraints N/A Range Default Value en-us |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Definition Name of a parameter template generated after replication. Constraints N/A Range The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed. Default Value N/A |
| description | No | String | Definition Description of a parameter template generated after replication Constraints N/A Range The description can consist of up to 256 characters. It cannot contain carriage returns or any of the following special characters: >!<"&'= Default Value Empty |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| configuration_id | String | Definition Parameter template ID. Range The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Example Request
Replicating a parameter template
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/a2069d40256f40078c52d90d6a91ee63pr07/copy
{
"name" : "paramTemplate-new",
"description" : "new-parameter-group"
} Example Response
Status code: 200
Success.
{
"configuration_id" : "7b4e07852bd54016906e89461b3182cdpr02"
} Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.