Queries the names of user-defined functions (UDFs) in a metadatabase by page.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request parameters.
Request syntax
GET /api/metastore/catalogs/databases/functions/names
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
CatalogId | String | Query | No | 1344371 |
The catalog ID of the metadatabase. Default value: the user ID of your Alibaba Cloud account. |
DatabaseName | String | Query | No | database_test |
The name of the metadatabase. |
FunctionNamePattern | String | Query | No | .* |
The regular expression that is used to match function names. |
NextPageToken | String | Query | No | '' |
The pagination token. The token is returned in the return results. If no pagination token is returned, set this parameter to an empty string. |
PageSize | Integer | Query | No | 10 |
The number of entries to return on each page. |
RegionId | String | Host | No | cn-hangzhou |
The ID of the region where Data Lake Formation (DLF) is activated. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | OK |
The description of the status code. |
FunctionNames | Array of String | func2 |
The names of functions. |
Message | String | . |
The error message that is returned. |
NextPageToken | String | 2cb472ec1bf84f8d92f9c4baa0d21c19aa |
The pagination token. |
RequestId | String | B7F4B621-E41E-4C84-B97F-42B5380A32BB |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful. |
Error codes
InternalError: An internal error has occurred. Troubleshoot the error based on the error message that is returned.
Examples
Sample requests
GET /api/metastore/catalogs/databases/functions/names HTTP/1.1
{
"FunctionNamePattern":".*",
"PageSize":"10",
"NextPageToken":"''",
"DatabaseName":"database_test",
"RegionId":"cn-hangzhou",
"CatalogId":"1344371"
}
Sample success responses
JSON
format
{
"Message": "",
"RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
"NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
"Code": "OK",
"Success": true,
"FunctionNames": ["func1","func2"]
}
Error codes
For a list of error codes, visit the API Error Center.