All Products
Search
Document Center

File Storage NAS:DescribeLogAnalysis

Last Updated:Dec 11, 2024

Queries the log dump information configured in log analysis.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 10.

1
PageNumberintegerNo

The page number. Default value: 1.

1
FileSystemTypestringNo

The type of the file system.

Valid values:

  • standard: General-purpose NAS file system
  • extreme: Extreme NAS file system
  • all (default): all types
all

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of log dump entries in the region.

10
PageSizeinteger

The number of log dump entries returned per page.

10
RequestIdstring

The request ID.

C84F77AF-3DE5-48F1-B19B-37FCBE24****
PageNumberinteger

The page number.

1
Analysesarray<object>

The collection of log dump information.

Analysisobject
MetaKeystring

The ID of the file system.

0c7154xxxx
MetaValueobject

The log dump information of the file system.

RoleArnstring

The role that is used by NAS to access Simple Log Service.

acs:ram::162165525211xxxx:role/aliyunnaslogarchiverole
Regionstring

The region where the dedicated Logstore resides.

cn-hangzhou
Logstorestring

The name of the dedicated Logstore that is used to store NAS operation logs.

nas-nfs
Projectstring

The name of the project where the dedicated Logstore resides.

nas-1746495857602745-cn-hangzhou
Codestring

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "PageSize": 10,
  "RequestId": "C84F77AF-3DE5-48F1-B19B-37FCBE24****",
  "PageNumber": 1,
  "Analyses": {
    "Analysis": [
      {
        "MetaKey": "0c7154xxxx",
        "MetaValue": {
          "RoleArn": "acs:ram::162165525211xxxx:role/aliyunnaslogarchiverole",
          "Region": "cn-hangzhou",
          "Logstore": "nas-nfs",
          "Project": "nas-1746495857602745-cn-hangzhou"
        }
      }
    ]
  },
  "Code": "200"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-09-09The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-06-05The request parameters of the API has changedView Change Details