ListDoctorHDFSDirectories - E-MapReduce - Alibaba Cloud Documentation Center

Retrieves batch analysis results for specific directories using EMR Doctor. The directory depth cannot exceed five levels.

Operation description

Queries the analysis results for HDFS directories.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr:ListDoctorHDFSDirectories

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
ClusterId	string	Yes	The ID of the cluster.	c-b933c5aac8fe****
NextToken	string	No	The token that is used to start the next query.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	No	The maximum number of entries to return on each page.	20
DateTime	string	Yes	The date. The value is in the ISO 8601 format. For example, `2023-01-01` represents January 1, 2023.	2023-01-01
DirPath	string	No	The path of the directory. The directory depth cannot exceed five levels. If you do not specify this parameter, the analysis results of all directories are returned.	/tmp/test
OrderType	string	No	The sort order. Valid values: ASC: ascending DESC: descending	ASC
OrderBy	string	No	The property based on which to sort the query results. Valid values: totalFileCount: the total number of files. largeFileCount: the number of large files. A large file is 1 GB or larger. mediumFileCount: the number of medium-sized files. A medium-sized file is larger than 128 MB and smaller than 1 GB. smallFileCount: the number of small files. A small file is larger than 10 MB and less than or equal to 128 MB. tinyFileCount: the number of tiny files. A tiny file is larger than 0 MB and less than or equal to 10 MB. emptyFileCount: the number of empty files. An empty file is 0 MB in size. hotDataSize: the size of hot data. Hot data is data that was accessed in the last 7 days. warmDataSize: the size of warm data. Warm data is data that was not accessed in the last 7 days but was accessed in the last 30 days. coldDataSize: the size of cold data. Cold data is data that was not accessed in the last 30 days but was accessed in the last 90 days. freezeDataSize: the size of freeze data. Freeze data is data that was not accessed in the last 90 days. totalDataSize: the total data size. totalFileDayGrowthCount: the daily increase in the total number of files. largeFileDayGrowthCount: the daily increase in the number of large files. A large file is 1 GB or larger. mediumFileDayGrowthCount: the daily increase in the number of medium-sized files. A medium-sized file is larger than 128 MB and smaller than 1 GB. smallFileDayGrowthCount: the daily increase in the number of small files. A small file is larger than 10 MB and less than or equal to 128 MB. tinyFileDayGrowthCount: the daily increase in the number of tiny files. A tiny file is larger than 0 MB and less than or equal to 10 MB. emptyFileDayGrowthCount: the daily increase in the number of empty files. An empty file is 0 MB in size. hotDataDayGrowthSize: the daily increase in the size of hot data. Hot data is data that was accessed in the last 7 days. warmDataDayGrowthSize: the daily increase in the size of warm data. Warm data is data that was not accessed in the last 7 days but was accessed in the last 30 days. coldDataDayGrowthSize: the daily increase in the size of cold data. Cold data is data that was not accessed in the last 30 days but was accessed in the last 90 days. freezeDataDayGrowthSize: the daily increase in the size of freeze data. Freeze data is data that was not accessed in the last 90 days. totalDataDayGrowthSize: the daily increase in the total data size. totalFileCountDayGrowthRatio: the day-over-day growth ratio of the total number of files. largeFileCountDayGrowthRatio: the day-over-day growth ratio of the number of large files. A large file is 1 GB or larger. mediumFileCountDayGrowthRatio: the day-over-day growth ratio of the number of medium-sized files. A medium-sized file is larger than 128 MB and smaller than 1 GB. smallFileCountDayGrowthRatio: the day-over-day growth ratio of the number of small files. A small file is larger than 10 MB and less than or equal to 128 MB. tinyFileCountDayGrowthRatio: the day-over-day growth ratio of the number of tiny files. A tiny file is larger than 0 MB and less than or equal to 10 MB. emptyFileCountDayGrowthRatio: the day-over-day growth ratio of the number of empty files. An empty file is 0 MB in size.	smallFileCount

Response elements

Element	Type	Description	Example
	object	Returned data
Data	array<object>	The analytical data for the batch analysis of HDFS directories.
	object	Analytical data for an HDFS directory.
DirPath	string	The directory name.	/tmp/test
Depth	integer	The directory level.	2
User	string	The owner of the directory.	DW
Group	string	The group of the folder.	DW
Metrics	object	The metric information.
TotalFileCount	object	The total number of files.
Name	string	The name of the metric.	totalFileCount
Value	integer	The metric value.	51683279
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Number of total files
LargeFileCount	object	The number of large files. A large file is a file that is 1 GB or larger.
Name	string	The name of the metric.	largeFileCount
Value	integer	The metric value.	123
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Number of large files
MediumFileCount	object	The number of files larger than 128 MB and up to 1 GB.
Name	string	The name of the metric.	mediumFileCount
Value	integer	The value of the metric.	323
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Number of medium files
SmallFileCount	object	The number of small files. A small file is a file with a size from 10 MB to 128 MB.
Name	string	The name of the metric.	smallFileCount
Value	integer	The value of the metric.	12345
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Number of small files
TinyFileCount	object	The number of tiny files. A tiny file is larger than 0 MB and up to 10 MB in size.
Name	string	The name of the metric.	tinyFileCount
Value	integer	The value of the metric.	232131
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of tiny files
EmptyFileCount	object	The count of empty files. An empty file is a file with a size of 0 MB.
Name	string	The name of the metric.	emptyFileCount
Value	integer	The metric value.	15595897
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Number of empty files
HotDataSize	object	The size of the hot data. Hot data is data accessed within the last 7 days.
Name	string	The name of the metric.	hotDataSize
Value	integer	The value of the metric.	6701531944206
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the hot data size
WarmDataSize	object	The size of the warm data. Warm data is data that has been accessed within the past 30 days, but not within the past 7 days.
Name	string	The name of the metric.	warmDataSize
Value	integer	The metric value.	4062349775577
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the warm data size
ColdDataSize	object	The size of the cold data. Cold data is data that was last accessed between 30 and 90 days ago.
Name	string	The name of the metric.	coldDataSize
Value	integer	The metric value.	5570958082267
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the cold data size
FreezeDataSize	object	The size of the frozen data. Data is considered frozen if it has not been accessed in the last 90 days.
Name	string	The name of the metric.	freezeDataSize
Value	integer	The metric value.	1231312431
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the freeze data size
TotalDataSize	object	The total data size.
Name	string	The name of the metric.	totalDataSize
Value	integer	The metric value.	62086342083623
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Total data size in megabytes (MB)
TotalFileDayGrowthCount	object	The daily growth in the total file count.
Name	string	The name of the metric.	totalFileDayGrowthCount
Value	integer	The value of the metric.	27809
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth count of total files
LargeFileDayGrowthCount	object	The daily increase in the number of large files. A large file is a file larger than 1 GB.
Name	string	The name of the metric.	largeFileDayGrowthCount
Value	integer	The value of the metric.	2
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth count of large files
MediumFileDayGrowthCount	object	The daily increase in the number of medium-sized files. A medium-sized file is larger than 128 MB and less than or equal to 1 GB.
Name	string	The name of the metric.	mediumFileDayGrowthCount
Value	integer	The value of the metric.	176
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth count of medium files
SmallFileDayGrowthCount	object	The number of new small files added each day. A small file is 10 MB to 128 MB.
Name	string	The name of the metric.	smallFileDayGrowthCount
Value	integer	The metric value.	12345
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth count of small files
TinyFileDayGrowthCount	object	The daily growth in the tiny file count. A tiny file is a file larger than 0 MB and smaller than 10 MB.
Name	string	The name of the metric.	tinyFileDayGrowthCount
Value	integer	The metric value.	-123
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth count of tiny files
EmptyFileDayGrowthCount	object	The daily growth in the number of empty files. An empty file has a size of 0 MB.
Name	string	The name of the metric.	emptyFileDayGrowthCount
Value	integer	The metric value.	114
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth count of empty files
HotDataDayGrowthSize	object	The daily increase in hot data size. Hot data is data that has been accessed within the last 7 days.
Name	string	The name of the metric.	hotDataDayGrowthSize
Value	integer	The value of the metric.	123154
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Day growth size of hot data
WarmDataDayGrowthSize	object	The daily growth in the size of warm data. Warm data is data that has not been accessed in the last 7 days, but has been accessed in the last 30 days.
Name	string	The name of the metric.	warmDataDayGrowthSize
Value	integer	The value of the metric.	-64806998319
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Day growth size of warm data
ColdDataDayGrowthSize	object	The daily growth in the size of cold data. Cold data is data that was last accessed between 30 and 90 days ago.
Name	string	The name of the metric.	coldDataDayGrowthSize
Value	integer	The value of the metric.	-182636577752
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Day growth size of cold data
FreezeDataDayGrowthSize	object	The daily growth in the size of freeze data. Freeze data is data that has not been accessed for 90 days.
Name	string	The name of the metric.	freezeDataDayGrowthSize
Value	integer	The value of the metric.	-167683929450
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Day growth size of freeze data
TotalDataDayGrowthSize	object	The daily growth in the total data size.
Name	string	The name of the metric.	totalDataDayGrowthSize
Value	integer	The metric value.	256482228248
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Day growth size of total data
TotalFileCountDayGrowthRatio	object	The day-over-day growth ratio of the total file count.
Name	string	The name of the metric.	totalFileCountDayGrowthRatio
Value	number	The metric value.	0.02
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of total files
LargeFileCountDayGrowthRatio	object	The day-over-day growth ratio of the large file count. A large file is a file that is 1 GB or larger.
Name	string	The name of the metric.	largeFileCountDayGrowthRatio
Value	number	The metric value.	0.39
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of large files
MediumFileCountDayGrowthRatio	object	The day-over-day growth ratio of the number of medium-sized files. A medium-sized file is larger than 128 MB and smaller than 1 GB.
Name	string	The name of the metric.	mediumFileCountDayGrowthRatio
Value	number	The value of the metric.	0.19
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of medium files
SmallFileCountDayGrowthRatio	object	The day-over-day growth ratio of the number of small files. A small file has a size greater than 10 MB and less than or equal to 128 MB.
Name	string	The name of the metric.	smallFileCountDayGrowthRatio
Value	number	The metric value.	0.02
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of small files
TinyFileCountDayGrowthRatio	object	The daily growth rate of tiny files. A tiny file is larger than 0 MB and smaller than 10 MB.
Name	string	The name of the metric.	tinyFileCountDayGrowthRatio
Value	number	The metric value.	0.003
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of tiny files
EmptyFileCountDayGrowthRatio	object	The day-over-day growth ratio of the empty file count. An empty file is a file with a size of 0 MB.
Name	string	The name of the metric.	emptyFileCountDayGrowthRatio
Value	number	The metric value.	0.005
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of empty files
HotDataSizeDayGrowthRatio	object	The daily growth rate of the hot data size. Hot data is any data accessed in the past 7 days.
Name	string	The name of the metric.	hotDataSizeDayGrowthRatio
Value	number	The value of the metric.	0.1114
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of hot data size
WarmDataSizeDayGrowthRatio	object	The day-over-day growth ratio of the warm data size. Warm data has not been accessed in the last 7 days but has been accessed in the last 30 days.
Name	string	The name of the metric.	warmDataSizeDayGrowthRatio
Value	number	The value of the metric.	-0.015
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of warm data size
ColdDataSizeDayGrowthRatio	object	The day-over-day growth rate of the cold data size. Cold data refers to data last accessed between 30 and 90 days ago.
Name	string	The name of the metric.	coldDataSizeDayGrowthRatio
Value	number	The metric value.	-0.03
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of cold data size
FreezeDataSizeDayGrowthRatio	object	The daily growth rate of freeze data. Freeze data is data that has not been accessed in 90 days.
Name	string	The name of the metric.	freezeDataSizeDayGrowthRatio
Value	number	The value of the metric.	-0.09
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of freeze data size
TotalDataSizeDayGrowthRatio	object	The day-over-day growth ratio of the total data size.
Name	string	The name of the metric.	totalDataSizeDayGrowthRatio
Value	number	The value of the metric.	0.14
Unit	string	The unit of the metric.	”“
Description	string	The description of the metric.	Day growth ratio of total data size
RequestId	string	The ID of the request.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	The starting position for the next read.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	The maximum number of records returned.	20
TotalCount	integer	The total number of entries that match the request.	200

Examples

Success response

JSON format

{
  "Data": [
    {
      "DirPath": "/tmp/test",
      "Depth": 2,
      "User": "DW",
      "Group": "DW",
      "Metrics": {
        "TotalFileCount": {
          "Name": "totalFileCount",
          "Value": 51683279,
          "Unit": "”“\n",
          "Description": "Number of total files\n"
        },
        "LargeFileCount": {
          "Name": "largeFileCount",
          "Value": 123,
          "Unit": "”“\n",
          "Description": "Number of large files\n"
        },
        "MediumFileCount": {
          "Name": "mediumFileCount",
          "Value": 323,
          "Unit": "”“\n",
          "Description": "Number of medium files\n"
        },
        "SmallFileCount": {
          "Name": "smallFileCount",
          "Value": 12345,
          "Unit": "”“\n",
          "Description": "Number of small files\n"
        },
        "TinyFileCount": {
          "Name": "tinyFileCount\n",
          "Value": 232131,
          "Unit": "\"\"",
          "Description": "Number of tiny files"
        },
        "EmptyFileCount": {
          "Name": "emptyFileCount",
          "Value": 15595897,
          "Unit": "”“\n",
          "Description": "Number of empty files"
        },
        "HotDataSize": {
          "Name": "hotDataSize",
          "Value": 6701531944206,
          "Unit": "MB\n",
          "Description": "Size of the hot data size\n"
        },
        "WarmDataSize": {
          "Name": "warmDataSize\n",
          "Value": 4062349775577,
          "Unit": "MB\n",
          "Description": "Size of the warm data size\n"
        },
        "ColdDataSize": {
          "Name": "coldDataSize",
          "Value": 5570958082267,
          "Unit": "MB",
          "Description": "Size of the cold data size\n"
        },
        "FreezeDataSize": {
          "Name": "freezeDataSize",
          "Value": 1231312431,
          "Unit": "MB\n",
          "Description": "Size of the freeze data size\n"
        },
        "TotalDataSize": {
          "Name": "totalDataSize",
          "Value": 62086342083623,
          "Unit": "MB\n",
          "Description": "Total data size in megabytes (MB)\n"
        },
        "TotalFileDayGrowthCount": {
          "Name": "totalFileDayGrowthCount",
          "Value": 27809,
          "Unit": "”“\n",
          "Description": "Day growth count of total files\n"
        },
        "LargeFileDayGrowthCount": {
          "Name": "largeFileDayGrowthCount",
          "Value": 2,
          "Unit": "”“\n",
          "Description": "Day growth count of large files\n"
        },
        "MediumFileDayGrowthCount": {
          "Name": "mediumFileDayGrowthCount",
          "Value": 176,
          "Unit": "”“\n",
          "Description": "Day growth count of medium files\n"
        },
        "SmallFileDayGrowthCount": {
          "Name": "smallFileDayGrowthCount",
          "Value": 12345,
          "Unit": "”“\n",
          "Description": "Day growth count of small files\n"
        },
        "TinyFileDayGrowthCount": {
          "Name": "tinyFileDayGrowthCount",
          "Value": -123,
          "Unit": "”“\n",
          "Description": "Day growth count of tiny files"
        },
        "EmptyFileDayGrowthCount": {
          "Name": "emptyFileDayGrowthCount",
          "Value": 114,
          "Unit": "”“\n",
          "Description": "Day growth count of empty files\n"
        },
        "HotDataDayGrowthSize": {
          "Name": "hotDataDayGrowthSize",
          "Value": 123154,
          "Unit": "MB\n",
          "Description": "\t\nDay growth size of hot data\n"
        },
        "WarmDataDayGrowthSize": {
          "Name": "warmDataDayGrowthSize",
          "Value": -64806998319,
          "Unit": "MB\n",
          "Description": "Day growth size of warm data\n"
        },
        "ColdDataDayGrowthSize": {
          "Name": "coldDataDayGrowthSize",
          "Value": -182636577752,
          "Unit": "MB\n",
          "Description": "Day growth size of cold data\n"
        },
        "FreezeDataDayGrowthSize": {
          "Name": "freezeDataDayGrowthSize",
          "Value": -167683929450,
          "Unit": "MB\n",
          "Description": "Day growth size of freeze data\n"
        },
        "TotalDataDayGrowthSize": {
          "Name": "totalDataDayGrowthSize",
          "Value": 256482228248,
          "Unit": "MB\n",
          "Description": "Day growth size of total data\n"
        },
        "TotalFileCountDayGrowthRatio": {
          "Name": "totalFileCountDayGrowthRatio\n",
          "Value": 0.02,
          "Unit": "”“\n",
          "Description": "Day growth ratio of total files\n"
        },
        "LargeFileCountDayGrowthRatio": {
          "Name": "largeFileCountDayGrowthRatio",
          "Value": 0.39,
          "Unit": "”“\n",
          "Description": "Day growth ratio of large files\n"
        },
        "MediumFileCountDayGrowthRatio": {
          "Name": "mediumFileCountDayGrowthRatio",
          "Value": 0.19,
          "Unit": "”“\n",
          "Description": "Day growth ratio of medium files\n"
        },
        "SmallFileCountDayGrowthRatio": {
          "Name": "smallFileCountDayGrowthRatio",
          "Value": 0.02,
          "Unit": "”“\n",
          "Description": "Day growth ratio of small files\n"
        },
        "TinyFileCountDayGrowthRatio": {
          "Name": "tinyFileCountDayGrowthRatio",
          "Value": 0.003,
          "Unit": "”“\n",
          "Description": "Day growth ratio of tiny files\n"
        },
        "EmptyFileCountDayGrowthRatio": {
          "Name": "emptyFileCountDayGrowthRatio",
          "Value": 0.005,
          "Unit": "”“\n",
          "Description": "Day growth ratio of empty files"
        },
        "HotDataSizeDayGrowthRatio": {
          "Name": "hotDataSizeDayGrowthRatio",
          "Value": 0.1114,
          "Unit": "”“\n",
          "Description": "Day growth ratio of hot data size\n"
        },
        "WarmDataSizeDayGrowthRatio": {
          "Name": "\t\nwarmDataSizeDayGrowthRatio\n",
          "Value": -0.015,
          "Unit": "”“\n",
          "Description": "Day growth ratio of warm data size\n"
        },
        "ColdDataSizeDayGrowthRatio": {
          "Name": "coldDataSizeDayGrowthRatio",
          "Value": -0.03,
          "Unit": "”“\n",
          "Description": "Day growth ratio of cold data size\n"
        },
        "FreezeDataSizeDayGrowthRatio": {
          "Name": "freezeDataSizeDayGrowthRatio",
          "Value": -0.09,
          "Unit": "”“",
          "Description": "Day growth ratio of freeze data size\n"
        },
        "TotalDataSizeDayGrowthRatio": {
          "Name": "totalDataSizeDayGrowthRatio",
          "Value": 0.14,
          "Unit": "”“\n",
          "Description": "Day growth ratio of total data size\n"
        }
      }
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

Error codes

HTTP status code	Error code	Error message
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.