All Products
Search
Document Center

Microservices Engine:GetNacosConfig

Last Updated:Feb 20, 2024

Queries 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:GetNacosConfigRead
  • Cluster
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

mse-cn-i7m2h0****
DataIdstringYes

The ID of the data.

halvie-mp-item****
GroupstringYes

The name of the configuration group.

common
NamespaceIdstringNo

The ID of the namespace.

ddaf8f12-****-b1c1-86e7c72e266b
BetabooleanNo

Specifies whether to perform a beta release. Valid values:

  • true: yes
  • false: no
true
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

Messagestring

The message returned.

success
RequestIdstring

The ID of the request.

B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD
Configurationobject

The configuration information.

Typestring

The format of the configuration.

text
AppNamestring

The name of the application.

test
Tagsstring

The tags of the configuration.

context
Md5string

The message digest of the configuration.

123rfsdf3
DataIdstring

The ID of the configuration.

log.yaml
Contentstring

The content of the configuration.

log.level=error
Groupstring

The name of the configuration group.

test
Descstring

The description of the configuration.

For testing
EncryptedDataKeystring

The encryption key.

key
BetaIpsstring

The list of IP addresses where the beta release of the configuration is performed.

1.1.XX.XX,2.2.XX.XX
ErrorCodestring

The error code returned if the request failed.

mse-100-000
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD",
  "Configuration": {
    "Type": "text",
    "AppName": "test",
    "Tags": "context",
    "Md5": "123rfsdf3",
    "DataId": "log.yaml",
    "Content": "log.level=error",
    "Group": "test",
    "Desc": "For testing\n",
    "EncryptedDataKey": "key",
    "BetaIps": "1.1.XX.XX,2.2.XX.XX"
  },
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2023-04-25API Description Updatesee changesets
Change itemChange content
API DescriptionAPI Description Update.