All Products
Search
Document Center

E-MapReduce:ListDoctorHDFSUGI

Last Updated:Dec 12, 2024

Obtains the analysis results of Hadoop Distributed File System (HDFS) storage resources for multiple owners or groups at a time on E-MapReduce (EMR) Doctor.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****
NextTokenstringNo

The pagination token that is used in the request to retrieve a new page of results.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsintegerNo

The maximum number of entries to return on each page.

20
DateTimestringYes

Specify the date in the ISO 8601 standard. For example, 2023-01-01 represents January 1, 2023.

2023-01-01
TypestringYes

The filter condition. Valid values:

  • user
  • group
group
OrderTypestringNo

The order in which you want to sort the query results. Valid values:

  • ASC: in ascending order
  • DESC: in descending order
ASC
OrderBystringNo

The basis on which you want to sort the query results. Valid values:

  • totalFileCount: the total number of files
  • totalDataSize: the total data size
  • totalDirCount: the total number of directories
totalFileCount

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataarray<object>

The results of batch HDFS analysis.

ListDoctorHDFSUGIDTOobject
Namestring

The actual name of the owner or group returned based on the value of Type.

DW
Metricsobject

The metric information.

TotalFileCountobject

The total number of files.

Namestring

The name of the metric.

totalFileCount
Valuelong

The value of the metric.

34
Unitstring

The unit of the metric.

”“
Descriptionstring

The description of the metric.

Number of total files
TotalDataSizeobject

The total data size.

Namestring

The name of the metric.

totalDataSize
Valuelong

The value of the metric.

40440503
Unitstring

The unit of the metric.

MB
Descriptionstring

The description of the metric.

Total data size in megabytes (MB)
TotalDirCountobject

The total number of directories.

Namestring

The name of the metric.

totalDirCount
Valuelong

The value of the metric.

123
Unitstring

The unit of the metric.

”“
Descriptionstring

The description of the metric.

Number of total dirs
RequestIdstring

The request ID.

DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextTokenstring

A pagination token.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

The maximum number of entries that are returned.

20
TotalCountinteger

The total number of entries returned.

200

Examples

Sample success responses

JSONformat

{
  "Data": [
    {
      "Name": "DW",
      "Metrics": {
        "TotalFileCount": {
          "Name": "totalFileCount",
          "Value": 34,
          "Unit": "”“\n",
          "Description": "Number of total files\n"
        },
        "TotalDataSize": {
          "Name": "totalDataSize",
          "Value": 40440503,
          "Unit": "MB\n",
          "Description": "Total data size in megabytes (MB)"
        },
        "TotalDirCount": {
          "Name": "totalDirCount",
          "Value": 123,
          "Unit": "”“\n",
          "Description": "Number of total dirs\n"
        }
      }
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

Error codes

HTTP status codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.
400NotAuthorizedYou do not have permission to perform this action. %s
400ThrottlingExceptionThe request was denied due to request throttling. %s
404ResourceNotFoundThe resource not found by %s.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.
503ServiceFailureThe request has failed due to a temporary failure of %s service.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.

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

Change history

Change timeSummary of changesOperation
No change history