Replicating a Parameter Template
API Description
This API is used to replicate a parameter template.
Constraints
- Only custom parameter templates can be replicated.
- The name of the parameter template cannot be the same as that of the default or an existing parameter template.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dds:configuration:copy
write
-
-
dds:param:create
-
URI
|
Name |
Type |
IN |
Mandatory |
Description |
|---|---|---|---|---|
|
X-Auth-Token |
string |
header |
Yes |
User token obtained from IAM. For details, see Authentication. |
|
project_id |
string |
path |
Yes |
Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID. |
|
Name |
Mandatory |
Type |
Description |
|---|---|---|---|
|
config_id |
Yes |
String |
ID of the parameter template to be replicated. |
Request
- Parameter description
Table 3 Request body parameters Name
Mandatory
Type
Description
name
Yes
String
Name of the replicated parameter template.
The parameter template name can contain 1 to 64 characters. It can contain only letters, digits, hyphens (-), underscores (_), and periods (.).
description
No
String
Parameter template description.
The value is left blank by default. The description must consist of a maximum of 256 characters and cannot contain the carriage return character or the following special characters: >!<"&'=
Example Request
{
"name" : "paramsGroup-2434",
"description" : "Replicate a parameter template",
}
Response
- Parameter description
Table 4 Response body parameters Name
Type
Description
configuration_id
String
ID of the replicated parameter template.
- Example Response
{
"configuration_id": "7b4e07852bd54016906e89461b3182cdpr02"
}
SDK
Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot