All Products
Search
Document Center

Microservices Engine:ListNacosConfigs

Last Updated:Nov 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListNacosConfigsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RequestParsstringNo

The extended request parameters. The JSON format is supported.

{\\"appGroup\\":\\"sm_zk_asi_na610\\",\\"appName\\":\\"sm-zk\\",\\"appStage\\":\\"PUBLISH\\",\\"appUnit\\":\\"center\\",\\"bucId\\":\\"193554\\",\\"bucName\\":\\"Alibaba Mobile Business Group-UC\\",\\"provider\\":\\"aliyun\\"}
PageNumintegerYes

The number of the page to return.

5
PageSizeintegerYes

The number of entries to return on each page.

200
InstanceIdstringYes

The ID of the instance.

mse-cn-7mz2fj****
RegionIdstringNo

The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).

cn-hangzhou
DataIdstringNo

The ID of the data.

zeekr-*
GroupstringNo

The name of the group. Default value: default

crm
AppNamestringNo

The name of the application.

fpx-pds-pns
TagsstringNo

The tags.

billing
NamespaceIdstringNo

The ID of the namespace.

fad732a7-ff1a-4f21-8126-4edd4****
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

HttpCodestring

The HTTP status code returned.

200
TotalCountinteger

The total number of returned instances.

12
RequestIdstring

The ID of the request.

4081087F-3429-5873-A1E7-D4B5479D0B84
Messagestring

The message returned.

The request was successfully processed.
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
ErrorCodestring

The error code returned if the request failed.

mse-100-000
Configurationsarray<object>

The configurations.

NacosConfigForListModelobject

The data structure.

AppNamestring

The name of the application.

test
DataIdstring

The ID of the configuration.

log.yaml
Idstring

The ID of the application.

132****
Groupstring

The ID of the group.

public
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "HttpCode": "200",
  "TotalCount": 12,
  "RequestId": "4081087F-3429-5873-A1E7-D4B5479D0B84",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "ErrorCode": "mse-100-000",
  "Configurations": [
    {
      "AppName": "test",
      "DataId": "log.yaml",
      "Id": "132****",
      "Group": "public"
    }
  ],
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400duplicatedClusterAliasNameduplicated cluster alias nameThe instance name is duplicate. User another name.
400illegalRequestillegal request:%sInvalid request: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404clusterNotFoundcluster not foundThe cluster is not found.
500systemErrorsystem errorAn error occurred on the system. Try again later.

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

Change history

Change timeSummary of changesOperation
2023-04-25API Description UpdateView Change Details