All Products
Search
Document Center

Microservices Engine:ListConfigTrack

Last Updated:Nov 13, 2024

Obtains the track data of a Nacos configuration center.

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:ListConfigTracklist
  • Cluster
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}
  • EngineNamespace
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RequestParsstringNo

The extended request parameters in the JSON format.

{}
InstanceIdstringYes

The ID of the instance.

mse_prepaid_public_cn-i7m2ne****
DataIdstringNo

The ID of the configuration.

ballot
GroupstringNo

The name of the configuration group.

DEFAULT_GROUP
NamespaceIdstringNo

The ID of the namespace.

f3a510e2-df52-4fad-9815-42d8bc40****
StartTslongYes

The start timestamp. Unit: seconds.

1671010148
EndTslongYes

The end timestamp. Unit: seconds.

1657178373
PageSizelongYes

The number of entries to return on each page.

10
PageNumlongYes

The number of the page to return.

1
ReversebooleanNo

Specifies whether to enable reverse ordering. Valid values:

  • true
  • false
true
IpstringNo

The IP address of the listener.

192.168.22.2
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
Tracesarray<object>

The track data.

Traceobject

The details of the data.

LogDatestring

The logging time.

2022-11-28 15:09:15
Tsstring

The timestamp that indicates the time when the metric value is collected.

Unit: seconds.

1659666529
RequestIpstring

The source IP address of the request.

192.168.1.2
ResponseIpstring

The response node.

mse-1973b9a0-1670834*****-reg-center-0-2
DataIdstring

The ID of the configuration.

eir-server.properties
Groupstring

The name of the configuration group.

DEFAULT_GROUP
Eventstring

The event. Valid values:

  • pull: configuration acquisition events
  • persist: persistence events
pull
Resultstring

The result.

ok
Delaystring

The response latency. Unit: milliseconds.

0
Md5string

The MD5 value.

d21c9091c60daa0ff7ee2f420141e5a0
Typestring

The release type. Valid values:

  • beta: beta release
  • tag: canary release
  • batch: batch release
beta
Pushboolean

Indicates whether messages are pushed by a server. Valid values:

  • true
  • false
false
Clientboolean

Indicates whether the request is sent from the client. Valid values:

  • true
  • false
false
PageSizelong

The number of entries returned per page.

10
PageNumberlong

The page number of the returned page.

1
TotalCountlong

The total number of entries returned.

3
RequestIdstring

The ID of the request.

0CE3ABD2-1E04-561F-A9B4-0423D50****
Messagestring

The message returned.

The request was successfully processed.
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

{
  "HttpCode": "200",
  "Traces": [
    {
      "LogDate": "2022-11-28 15:09:15",
      "Ts": "1659666529",
      "RequestIp": "192.168.1.2",
      "ResponseIp": "mse-1973b9a0-1670834*****-reg-center-0-2",
      "DataId": "eir-server.properties",
      "Group": "DEFAULT_GROUP",
      "Event": "pull",
      "Result": "ok",
      "Delay": "0",
      "Md5": "d21c9091c60daa0ff7ee2f420141e5a0",
      "Type": "beta",
      "Push": false,
      "Client": false
    }
  ],
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 3,
  "RequestId": "0CE3ABD2-1E04-561F-A9B4-0423D50****",
  "Message": "The request was successfully processed.\n",
  "ErrorCode": "mse-100-000",
  "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-25The Error code has changedView Change Details