ExportNacosConfig - Microservices Engine - Alibaba Cloud Documentation Center

Exports specified Nacos configurations.

Operation description

Note The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the official documentation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ExportNacosConfig	get	Cluster acs:mse:{#regionId}:{#AccountId}:instance/{#InstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	mse-cn-2r42ddc****
NamespaceId	string	No	The ID of the namespace.	ae77c258-4d4f-478f-baaa-084aee0****
Ids`deprecated`	string	No	The ID of the primary key of a configuration item. Note Multiple export methods are supported. You must specify this parameter if you want to export multiple configurations. - You can obtain the value of this parameter by calling the ListNacosConfigs operation. - If you specify this parameter, multiple configurations are exported. The DataId and Group parameters are invalid.	1709,1710
DataId`deprecated`	string	Yes	The ID of the data that you want to export. Note Multiple export methods are supported. If you want to export a single configuration, you must leave the Ids parameter empty and specify the DataID and Group parameters.	sms-mes-develop.prop****
Group`deprecated`	string	No	The name of the configuration group.	TIMEDTASK_COMMON_GROUP
AppName`deprecated`	string	No	The application tag.	qjl-gateway-openapi
DataIds	string	Yes	The configuration group name and the ID of the configuration that you want to export. Separate multiple configurations with comma (,).	testGroup+testDataId1,testGroup+testDataId2
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The data structure.
HttpStatusCode	integer	The HTTP status code returned.	200
RequestId	string	The ID of the request.	92245803-49B7-54CF-8D49-01A34A0E1CD6
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	True
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Code	integer	The status code returned.	200
Message	string	The message returned.	The request was successfully processed.
DynamicMessage	string	The dynamic part in the error message. This parameter is used to replace %s in the ErrMessage parameter. Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.	The specified parameter is invalid.
Data	object	The details of the data.
Url	string	The URL that is used to download the exported configurations.	http://xxxxxxxxx

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "92245803-49B7-54CF-8D49-01A34A0E1CD6",
  "Success": true,
  "ErrorCode": "mse-100-000",
  "Code": 200,
  "Message": "The request was successfully processed.\n",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "Url": "http://xxxxxxxxx"
  }
}

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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-10	The request parameters of the API has changed	View Change Details
2023-04-25	API Description Update. The Error code has changed	View Change Details