Lists the Skills in your account.
Operation description
Request
This operation lists the Skills in your account. You can filter the results by criteria such as a search keyword and visibility level.
Q: An optional search keyword for a fuzzy match on Skill names.
Visibility: An optional parameter to filter Skills by their visibility level. You can specify multiple values.
MaxResults: An optional parameter that specifies the maximum number of results to return per page.
NextToken: An optional pagination token for retrieving the next page of results. Omit this parameter for the first request. For subsequent requests, pass the NextToken value from the previous response to fetch the next page.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| MaxResults |
integer |
No |
The maximum number of results to return per page. |
20 |
| NextToken |
string |
No |
The pagination token. Omit this parameter for the first request. For subsequent requests, pass the |
5 |
| Q |
string |
No |
The search keyword for a fuzzy match on Skill names. |
analysis |
| Visibility |
array |
No |
The visibility levels used to filter Skills. You can specify multiple values. |
|
|
string |
No |
project id |
123456 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
824F80BA-1778-5D8A-BAFF-668A4D9C4CC7 |
| PagingInfo |
object |
The pagination result. |
|
| TotalCount |
integer |
The total number of results that match the filter criteria. |
100 |
| MaxResults |
integer |
The maximum number of results returned per page. |
100 |
| NextToken |
string |
The token for the next page. An empty value indicates that no more pages are available. |
5 |
| Skills |
array |
The list of Skills. |
|
|
object |
|||
| Name |
string |
The Skill name. |
my-skill |
| Description |
string |
The Skill description. |
Data analysis skill |
| CreatorId |
string |
The creator ID. |
123456 |
| ModifierId |
string |
The ID of the user who last modified the Skill. |
123456 |
| Visibility |
string |
The visibility level. |
TENANT |
| GmtCreateTime |
string |
The time when the Skill was created. |
1780555634000 |
Examples
Success response
JSON format
{
"RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
"PagingInfo": {
"TotalCount": 100,
"MaxResults": 100,
"NextToken": "5",
"Skills": [
{
"Name": "my-skill",
"Description": "Data analysis skill",
"CreatorId": "123456",
"ModifierId": "123456",
"Visibility": "TENANT",
"GmtCreateTime": "1780555634000"
}
]
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.