Clone Nacos Configurations Across Namespaces via API - Microservices Engine - Alibaba Cloud - Microservices Engine

Clones existing Nacos configurations to another namespace.

Operation description

Note

The current OpenAPI is not a Nacos-SDK API. For information about Nacos-SDK APIs, see the official documentation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:CloneNacosConfig

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	mse_prepaid_public_cn-i7m25igg403
OriginNamespaceId	string	No	The source namespace ID.	be821963-6d48-4ea5-9910-6057d****
TargetNamespaceId	string	No	The destination namespace ID.	08be4b5d-2d1c-4e6e-aa85-83b9****
Policy	string	Yes	The policy used when a write conflict occurs. Valid values: ABORT SKIP OVERWRITE. Valid values: ABORT : Abort. OVERWRITE : Overwrite. SKIP : Skip.	OVERWRITE
Ids `deprecated`	string	No	The list of configuration IDs.	253661,253662
DataIds	string	No	The configuration items to clone, in the format of dataId+group. Separate multiple configuration items with commas (,).	test+test,test1+test1
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response struct.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	6678DBA9-5600-5948-ACF8-ED3105B288A3
Success	boolean	The request result. Valid values: `true`: The request was successful. `false`: The request failed.	true
ErrorCode	string	The error code.	mse-100-000
Code	integer	The response code.	200
Message	string	The response message.	Clone Completed Successfully
DynamicMessage	string	The dynamic error message, which is used to replace the %s placeholder in the ErrMessage error message. Note If ErrMessage returns The Value of Input Parameter %s is not valid and DynamicMessage returns DtsJobId, the request parameter DtsJobId is invalid.	The specified parameter is invalid.
Data	object	The data overview.
SuccCount	integer	The number of successful configurations.	100
SkipCount	integer	The number of skipped configurations.	1
SkipData	array<object>	The skipped configuration information.
	object	The data structure.
DataId	string	Data ID.	test.yaml
Group	string	Group ID.	public
FailData	array<object>	The failed configuration information.
	object	The data structure.
DataId	string	Data ID.	test2.yaml
Group	string	Group ID.	test
Reason	string	The reason for the current operation.	The current import configuration format is invalid.

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "6678DBA9-5600-5948-ACF8-ED3105B288A3",
  "Success": true,
  "ErrorCode": "mse-100-000",
  "Code": 200,
  "Message": "Clone Completed Successfully",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "SuccCount": 100,
    "SkipCount": 1,
    "SkipData": [
      {
        "DataId": "test.yaml",
        "Group": "public "
      }
    ],
    "FailData": [
      {
        "DataId": "test2.yaml",
        "Group": "test",
        "Reason": "The current import configuration format is invalid."
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.