API:목록
이 문서는 MediaWiki Action API 문서의 부분입니다. |
GET request to list items that match select criteria.
API documentation
Lists generally return aggregations of data, such as pages gathered from across a wiki, or links gathered within a single page. To request a list, pass the list
parameter of your query string a valid list submodule, such as allimages
or usercontribs
.
To use the list API, specify action=query&list=list1|list2
in the URL.
See individual list API pages for more concrete examples of how to use lists:
- allcategories
- alldeletedrevisions
- allfileusages
- allimages
- alllinks
- allpages
- allredirects
- allrevisions
- alltransclusions
- allusers
- backlinks
- blocks
- categorymembers
- deletedrevs
- embeddedin
- exturlusage
- filearchive
- imageusage
- iwbacklinks
- langbacklinks
- logevents
- pagepropnames
- pageswithprop
- prefixsearch
- protectedtitles
- querypage
- random
- recentchanges
- search
- tags
- usercontribs
- users
- watchlist
- watchlistraw
Additional notes
- Most list submodules can be used as generators , unless otherwise noted.
- Lists differ from properties in that, instead of appending data to the elements in the
pages
element, each list has its own separated branch in thequery
element.
- List query limits:
- The results limit can be set as high as 500 for regular users, or 5000 for users with the
apihighlimits
right (typically bots and sysops). - Some modules impose stricter limits under certain conditions. See this subpage for more details.
- If you are not sure which limit applies to you and just want as many results as possible, set the limit to
max
. In that case, alimits
element will be returned, specifying the limits used. - The limit parameter for a given module consists of the module prefix followed by
limit
, soptlimit
is the maximum number ofprotectedtitles
returned, andcmlimit
is the maximum number ofcategorymembers
returned.
- The results limit can be set as high as 500 for regular users, or 5000 for users with the
See also
- Maintained by MediaWiki Interfaces Team.
- Live chat (IRC): #mediawiki-core connect
- Issue tracker: Phabricator MediaWiki-Action-API (Report an issue)