MediaWiki API 帮助
这是自动生成的MediaWiki API文档页面。
文档和例子:https://www.mediawiki.org/wiki/API:Main_page/zh
主模块
- 来源:MediaWiki
- 许可协议:GPL-2.0+
状态信息:本页所展示的所有特性都应正常工作,但是API仍在开发当中,将会随时变化。请订阅mediawiki-api-announce 邮件列表以便获得更新通知。
错误请求:当API收到错误请求时,HTTP header将会返回一个包含"MediaWiki-API-Error"的值,随后header的值与error code将会送回并设置为相同的值。详细信息请参阅API: 错误与警告。
测试中:测试API请求的易用性,请参见Special:ApiSandbox。
- action
要执行的操作。
- 以下值中的一个:block,changeauthenticationdata,checktoken,clearhasmsg,clientlogin,compare,createaccount,cspreport,delete,edit,emailuser,expandtemplates,feedcontributions,feedrecentchanges,feedwatchlist,filerevert,help,imagerotate,import,linkaccount,login,logout,managetags,mergehistory,mobileview,move,opensearch,options,paraminfo,parse,patrol,protect,purge,query,removeauthenticationdata,resetpassword,revisiondelete,rollback,rsd,setnotificationtimestamp,stashedit,tag,tokens,unblock,undelete,unlinkaccount,upload,userrights,watch
- 默认:help
- format
输出的格式。
- 以下值中的一个:json,jsonfm,none,php,phpfm,rawfm,xml,xmlfm
- 默认:jsonfm
- maxlag
最大延迟可被用于MediaWiki安装于数据库复制集中。要保存导致更多网站复制延迟的操作,此参数可使客户端等待直到复制延迟少于指定值时。万一发生过多延迟,错误代码maxlag会返回消息,例如等待$host中:延迟$lag秒。
参见Manual: Maxlag parameter以获取更多信息。- 类型:整数
- smaxage
设置
s-maxage
HTTP缓存控制头至这些秒。错误不会缓存。- 类型:整数
- 默认:0
- maxage
设置
max-age
HTTP缓存控制头至这些秒。错误不会缓存。- 类型:整数
- 默认:0
- assert
如果设置为user就验证用户是否登录,或如果设置为bot就验证是否有机器人用户权限。
- 以下值中的一个:user,bot
- assertuser
验证当前用户是命名用户。
- 类型:用户名
- requestid
任何在此提供的值将包含在响应中。可能可以用以区别请求。
- servedby
包含保存结果请求的主机名。
- 类型:布尔值(详细信息)
- curtimestamp
在结果中包括当前时间戳。
- 类型:布尔值(详细信息)
- origin
当通过跨域名AJAX请求(CORS)访问API时,设置此作为起始域名。这必须包括在任何pre-flight请求中,并因此必须是请求的URI的一部分(而不是POST正文)。
对于已验证的请求,这必须正确匹配
Origin
标头中的原点之一,因此它已经设置为像https://zh.wikipedia.org或https://meta.wikimedia.org的东西。如果此参数不匹配Origin
页顶,就返回403错误响应。如果此参数匹配Origin
页顶并且起点被白名单,将设置Access-Control-Allow-Origin
和Access-Control-Allow-Credentials
开头。对于未验证的请求,会指定值*。这将导致
Access-Control-Allow-Origin
标头被设置,但Access-Control-Allow-Credentials
将为false
,且所有用户特定数据将受限制。- uselang
用于消息翻译的语言。action=query&meta=siteinfo与siprop=languages可返回语言代码列表,或指定user以使用当前用户的语言设置,或指定content以使用此wiki的内容语言。
- 默认:user
- 主模块帮助。
- api.php?action=help [在沙盒中打开]
- 一个页面中的所有帮助。
- api.php?action=help&recursivesubmodules=1 [在沙盒中打开]
action=block
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
封禁一位用户。
- user
您要封禁的用户、IP地址或IP地址段。
- 这个参数是必须的。
- 类型:用户名
- expiry
到期时间。可以是相对时间(例如5 months或2 weeks)或绝对时间(例如2014-09-18T12:34:56Z)。如果设置为infinite、indefinite或never,封禁将无限期。
- 默认:never
- reason
封禁的原因。
- 默认:(空)
- anononly
只封禁匿名用户(也就是说禁止此 IP 地址的匿名编辑)。
- 类型:布尔值(详细信息)
- nocreate
防止创建帐户。
- 类型:布尔值(详细信息)
- autoblock
自动封禁最近使用的IP地址,以及以后他们尝试登陆使用的IP地址。
- 类型:布尔值(详细信息)
- noemail
阻止用户通过wiki发送电子邮件。(需要
blockemail
权限)。- 类型:布尔值(详细信息)
- hidename
从封禁日志中隐藏用户名。(需要
hideuser
权限)。- 类型:布尔值(详细信息)
- allowusertalk
允许用户编辑自己的讨论页(取决于$wgBlockAllowsUTEdit)。
- 类型:布尔值(详细信息)
- reblock
如果该用户已被封禁,则覆盖已有的封禁。
- 类型:布尔值(详细信息)
- watchuser
监视用户或该 IP 的用户页和讨论页。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 封禁IP地址192.0.2.5三天,原因First strike。
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [在沙盒中打开]
- 无限期封禁用户Vandal,原因Vandalism,并阻止新账户创建和电子邮件发送。
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [在沙盒中打开]
action=changeauthenticationdata (changeauth)
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
更改当前用户的身份验证数据。
- changeauthrequest
使用此身份验证请求,通过返回自action=query&meta=authmanagerinfo的id与amirequestsfor=change。
- 这个参数是必须的。
- changeauthtoken
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- *
- 此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfo与amirequestsfor=change(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。
action=checktoken
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从action=query&meta=tokens检查令牌有效性。
- type
已开始测试的令牌类型。
- 这个参数是必须的。
- 以下值中的一个:createaccount,csrf,login,patrol,rollback,userrights,watch
- token
要测试的令牌。
- 这个参数是必须的。
- maxtokenage
令牌的最大允许年龄,以秒计。
- 类型:整数
- 测试csrf令牌的有效性。
- api.php?action=checktoken&type=csrf&token=123ABC [在沙盒中打开]
action=clearhasmsg
- 此模块需要读取权限。
- 此模块需要写入权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
清除当前用户的hasmsg
标记。
- 清除当前用户的
hasmsg
标记。 - api.php?action=clearhasmsg [在沙盒中打开]
action=clientlogin (login)
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
使用交互式流登录wiki。
使用此模块的一般程序是:
- 通过amirequestsfor=login取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokens的login令牌。
- 向用户显示字段,并获得其提交内容。
- 发送至此模块,提供loginreturnurl及任何相关字段。
- 在响应中检查status。
- 如果您收到了PASS或FAIL,您已经完成。操作要么成功,要么不成功。
- 如果您收到了UI,present the new fields to the user and obtain their submission. Then post to this module with logincontinue and the relevant fields set, and repeat step 4.
- 如果您收到了REDIRECT,direct the user to the redirecttarget and wait for the return to loginreturnurl. Then post to this module with logincontinue and any fields passed to the return URL, and repeat step 4.
- 如果您收到了RESTART,that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
- loginrequests
Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=login or from a previous response from this module.
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- loginmessageformat
返回消息使用的格式。
- 以下值中的一个:html,wikitext,raw,none
- 默认:wikitext
- loginmergerequestfields
合并用于所有身份验证请求的字段信息至一个数组中。
- 类型:布尔值(详细信息)
- loginpreservestate
从之前失败的登录尝试中保持状态,如果可能。
- 类型:布尔值(详细信息)
- loginreturnurl
Return URL for third-party authentication flows, must be absolute. Either this or logincontinue is required.
Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a logincontinue request to this API module.
- logincontinue
此请求是在早先的UI或REDIRECT响应之后的附加请求。必需此值或loginreturnurl。
- 类型:布尔值(详细信息)
- logintoken
从action=query&meta=tokens取回的“login”令牌
- 这个参数是必须的。
- *
- 此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfo与amirequestsfor=login(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。
- 开始作为用户Example和密码ExamplePassword登录至wiki的过程。
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [在沙盒中打开]
- 在UI响应双因素验证后继续登录,补充OATHToken 987654。
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [在沙盒中打开]
action=compare
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取2个页面之间的差别。
用于“from”和“to”的修订版本号、页面标题或页面 ID 必须获得通过。
- fromtitle
要比较的第一个标题。
- fromid
要比较的第一个页面 ID。
- 类型:整数
- fromrev
要比较的第一个修订版本。
- 类型:整数
- totitle
要比较的第二个标题。
- toid
要比较的第二个页面 ID。
- 类型:整数
- torev
要比较的第二个修订版本。
- 类型:整数
- 在版本1和2中创建差异。
- api.php?action=compare&fromrev=1&torev=2 [在沙盒中打开]
action=createaccount (create)
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
创建一个新用户账户。
使用此模块的一般程序是:
- 通过amirequestsfor=create取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokens的createaccount令牌。
- 向用户显示字段,并获得其提交内容。
- 发送至此模块,提供createreturnurl及任何相关字段。
- 在响应中检查status。
- 如果您收到了PASS或FAIL,您已经完成。操作要么成功,要么不成功。
- 如果您收到了UI,present the new fields to the user and obtain their submission. Then post to this module with createcontinue and the relevant fields set, and repeat step 4.
- 如果您收到了REDIRECT,direct the user to the redirecttarget and wait for the return to createreturnurl. Then post to this module with createcontinue and any fields passed to the return URL, and repeat step 4.
- 如果您收到了RESTART,that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
- createrequests
Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=create or from a previous response from this module.
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- createmessageformat
返回消息使用的格式。
- 以下值中的一个:html,wikitext,raw,none
- 默认:wikitext
- createmergerequestfields
合并用于所有身份验证请求的字段信息至一个数组中。
- 类型:布尔值(详细信息)
- createpreservestate
从之前失败的登录尝试中保持状态,如果可能。
如果action=query&meta=authmanagerinfo返回用于hasprimarypreservedstate的真值,标记为primary-required的请求应被忽略。如果它返回用于preservedusername的非空值,用户名必须用于username参数。
- 类型:布尔值(详细信息)
- createreturnurl
Return URL for third-party authentication flows, must be absolute. Either this or createcontinue is required.
Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a createcontinue request to this API module.
- createcontinue
此请求是在早先的UI或REDIRECT响应之后的附加请求。必需此值或createreturnurl。
- 类型:布尔值(详细信息)
- createtoken
从action=query&meta=tokens取回的“createaccount”令牌
- 这个参数是必须的。
- *
- 此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfo与amirequestsfor=create(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。
action=cspreport
- 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
由浏览器使用以报告违反内容安全方针的内容。此模块应永不使用,除了在被CSP兼容的浏览器自动使用时。
- reportonly
标记作为来自监视方针的报告,而不是执行方针的报告
- 类型:布尔值(详细信息)
- source
生成引发此报告的CSP标头的事物
- 默认:internal
action=delete
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
删除一个页面。
- title
要删除的页面标题。不能与pageid一起使用。
- pageid
要删除的页面的页面 ID。不能与title一起使用。
- 类型:整数
- reason
删除原因。如果未设置,将使用一个自动生成的原因。
- tags
要在删除日志中应用到实体的更改标签。
- 值(以|或替代物分隔):
- watch
- 已弃用。
将该页面加入当前用户的监视列表。
- 类型:布尔值(详细信息)
- watchlist
无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。
- 以下值中的一个:watch,unwatch,preferences,nochange
- 默认:preferences
- unwatch
- 已弃用。
将该页面从当前用户的监视列表删除。
- 类型:布尔值(详细信息)
- oldimage
由action=query&prop=imageinfo&iiprop=archivename提供的要删除的旧图片名称。
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 删除Main Page。
- api.php?action=delete&title=Main%20Page&token=123ABC [在沙盒中打开]
- 删除Main Page,原因Preparing for move。
- api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move [在沙盒中打开]
action=edit
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
创建和编辑页面。
- title
要编辑的页面标题。不能与pageid一起使用。
- pageid
要编辑的页面的页面 ID。不能与title一起使用。
- 类型:整数
- section
段落数。0用于首段,new用于新的段落。
- sectiontitle
新段落的标题。
- text
页面内容。
- summary
编辑摘要。当section=new且未设置sectiontitle时,还包括小节标题。
- tags
更改标签以应用修订。
- 值(以|或替代物分隔):
- minor
小编辑。
- 类型:布尔值(详细信息)
- notminor
不是小编辑。
- 类型:布尔值(详细信息)
- bot
标记此编辑为机器人编辑。
- 类型:布尔值(详细信息)
- basetimestamp
基础修订的时间戳,用于检测编辑冲突。也许可以通过action=query&prop=revisions&rvprop=timestamp得到。
- 类型:时间戳(允许格式)
- starttimestamp
编辑过程开始的时间戳,用于检测编辑冲突。当开始编辑过程时(例如当加载要编辑的页面时)使用curtimestamp可能取得一个适当的值。
- 类型:时间戳(允许格式)
- recreate
覆盖有关该页面在此期间已被删除的任何错误。
- 类型:布尔值(详细信息)
- createonly
不要编辑页面,如果已经存在。
- 类型:布尔值(详细信息)
- nocreate
如果该页面不存在,则抛出一个错误。
- 类型:布尔值(详细信息)
- watch
- 已弃用。
将页面加入当前用户的监视列表。
- 类型:布尔值(详细信息)
- unwatch
- 已弃用。
将页面从当前用户的监视列表中移除。
- 类型:布尔值(详细信息)
- watchlist
无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。
- 以下值中的一个:watch,unwatch,preferences,nochange
- 默认:preferences
- md5
text参数或prependtext和appendtext级联参数的MD5哈希值。如果设置,除非哈希值正确否则编辑无法完成。
- prependtext
将该文本添加到该页面的开始。覆盖text。
- appendtext
将该文本添加到该页面的结尾。覆盖text。
采用section=new来添加一个新的章节,而不是这个参数。
- undo
撤销此次修订。覆盖text、prependtext和appendtext。
- 类型:整数
- undoafter
撤销从undo至此的所有修订。如果不设置就撤销一次修订。
- 类型:整数
- redirect
自动解决重定向。
- 类型:布尔值(详细信息)
- contentformat
用于输入文本的内容序列化格式。
- 以下值中的一个:text/x-wiki,text/javascript,application/json,text/css,text/plain
- contentmodel
新内容的内容模型。
- 以下值中的一个:wikitext,javascript,json,css,text
- token
从action=query&meta=tokens取回的“csrf”令牌
令牌应总是发送为最后参数,或至少在text参数之后。
- 这个参数是必须的。
- captchaword
回答验证码
- captchaid
之前请求的验证码ID
- 编辑一个页面。
- api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [在沙盒中打开]
- 页面中预置__NOTOC__。
- api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [在沙盒中打开]
- 通过13585撤销修订版本13579并自动填写编辑摘要。
- api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [在沙盒中打开]
action=emailuser
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
电子邮件联系一位用户。
- target
电子邮件的目标用户。
- 这个参数是必须的。
- subject
主题页眉。
- text
邮件正文。
- 这个参数是必须的。
- ccme
给我发送一份该邮件的副本。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 向用户WikiSysop发送邮件,带文字Content。
- api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [在沙盒中打开]
action=expandtemplates
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
展开维基文本中的所有模板。
- title
页面标题。
- 默认:API
- text
要转换的wiki文本。
- 这个参数是必须的。
- revid
修订版本ID,用于{{REVISIONID}}和类似变体。
- 类型:整数
- prop
要获取的那条信息。
注意如果没有选定值,结果将包含wiki文本,但将以弃用的格式显示。
- wikitext
- 扩充的wiki文本。
- categories
- 任何在输出中提供的,未在wiki文本输出中表现的分类。
- properties
- 由wiki文本中扩充的魔术字定义的页面属性。
- volatile
- 无论输出是否常常变动,均不应被在页面中其他任何位置重用。
- ttl
- 结果缓存应无效化后的最长时间。
- modules
- 任何解析器函数请求添加至输出的ResourceLoader模块。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。
- jsconfigvars
- 针对页面提供JavaScript配置变量。
- encodedjsconfigvars
- 针对页面提供JavaScript配置变量为一个JSON字符串。
- parsetree
- 输入的XML分析树。
- 值(以|或替代物分隔):wikitext,categories,properties,volatile,ttl,modules,jsconfigvars,encodedjsconfigvars,parsetree
- includecomments
输出时是否包含HTML摘要。
- 类型:布尔值(详细信息)
- generatexml
- 已弃用。
生成XML解析树(取代自prop=parsetree)。
- 类型:布尔值(详细信息)
- 展开wiki文本{{Project:Sandbox}}。
- api.php?action=expandtemplates&text={{Project:Sandbox}} [在沙盒中打开]
action=feedcontributions
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回用户贡献纲要。
- feedformat
纲要的格式。
- 以下值中的一个:rss,atom
- 默认:rss
- user
获取哪些用户的贡献。
- 这个参数是必须的。
- 类型:用户名
- namespace
过滤哪些命名空间的贡献。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- year
起始年份(及更早)。
- 类型:整数
- month
起始月份(及更早)。
- 类型:整数
- tagfilter
过滤有这些标签的贡献者。
- 值(以|或替代物分隔):mw-contentmodelchange,mobile edit,mobile web edit
- 默认:(空)
- deletedonly
仅显示已删除的贡献。
- 类型:布尔值(详细信息)
- toponly
仅仅显示那些作为最新修订的编辑。
- 类型:布尔值(详细信息)
- newonly
仅仅显示那些作为页面创建的编辑。
- 类型:布尔值(详细信息)
- hideminor
隐藏小编辑。
- 类型:布尔值(详细信息)
- showsizediff
显示修订版本之间的大小差别。
- 类型:布尔值(详细信息)
- 返回用户Example的贡献。
- api.php?action=feedcontributions&user=Example [在沙盒中打开]
action=feedrecentchanges
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回最近更改的摘要。
- feedformat
纲要的格式。
- 以下值中的一个:rss,atom
- 默认:rss
- namespace
用于限制结果的命名空间。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- invert
除所选定者外的所有命名空间。
- 类型:布尔值(详细信息)
- associated
包括相关的命名空间(讨论页或主要)。
- 类型:布尔值(详细信息)
- days
用于限制结果的天数。
- 值必须不少于1。
- 类型:整数
- 默认:7
- limit
所要返回结果的最大数目。
- 值必须介于1和50之间。
- 类型:整数
- 默认:50
- from
显示自那时以来的更改。
- 类型:时间戳(允许格式)
- hideminor
隐藏小更改。
- 类型:布尔值(详细信息)
- hidebots
隐藏机器人所做的更改。
- 类型:布尔值(详细信息)
- hideanons
隐藏匿名用户做出的更改。
- 类型:布尔值(详细信息)
- hideliu
隐藏注册用户做出的更改。
- 类型:布尔值(详细信息)
- hidepatrolled
隐藏已巡查更改。
- 类型:布尔值(详细信息)
- hidemyself
隐藏当前用户做出的更改。
- 类型:布尔值(详细信息)
- hidecategorization
隐藏分类成员更改。
- 类型:布尔值(详细信息)
- tagfilter
按标签过滤。
- target
仅仅显示从该页面链出的那些页面的变更。
- showlinkedto
仅仅显示链入到该页面的那些页面的变更。
- 类型:布尔值(详细信息)
action=feedwatchlist
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回监视列表纲要。
- feedformat
纲要的格式。
- 以下值中的一个:rss,atom
- 默认:rss
- hours
列出从现在起数小时内修改的页面。
- 值必须介于1和72之间。
- 类型:整数
- 默认:24
- linktosections
如果可能的话,直接链接到已变更的小节。
- 类型:布尔值(详细信息)
- allrev
将同一页面的多个修订包含于指定的时间表内。
- 类型:布尔值(详细信息)
- wlowner
与token一起使用以访问不同用户的监视列表。
- 类型:用户名
- wltoken
允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。
- wlshow
只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置show=minor|!anon。
- 值(以|或替代物分隔):minor,!minor,bot,!bot,anon,!anon,patrolled,!patrolled,unread,!unread
- wltype
要显示的更改类型:
- edit
- 普通页面编辑。
- new
- 页面创建。
- log
- 日志记录。
- external
- 外部更改。
- categorize
- 分类成员组更改。
- 值(以|或替代物分隔):edit,new,log,external,categorize
- 默认:edit|new|log|categorize
- wlexcludeuser
不要列出此用户的更改。
- 类型:用户名
- 显示监视列表订阅。
- api.php?action=feedwatchlist [在沙盒中打开]
- 显示过去6小时内受监视页面的所有更改。
- api.php?action=feedwatchlist&allrev=&hours=6 [在沙盒中打开]
action=filerevert
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
回退一个文件至某一旧版本。
- filename
目标文件名,不包含前缀“File:”。
- 这个参数是必须的。
- comment
上传评论。
- 默认:(空)
- archivename
恢复到修订版存档名称。
- 这个参数是必须的。
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 回退Wiki.png至2011-03-05T15:27:40Z的版本。
- api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC [在沙盒中打开]
action=help
- 来源:MediaWiki
- 许可协议:GPL-2.0+
显示指定模块的帮助。
- 主模块帮助。
- api.php?action=help [在沙盒中打开]
- 用于action=query及其所有子模块的帮助。
- api.php?action=help&modules=query&submodules=1 [在沙盒中打开]
- 一个页面中的所有帮助。
- api.php?action=help&recursivesubmodules=1 [在沙盒中打开]
- 帮助模块本身的帮助。
- api.php?action=help&modules=help [在沙盒中打开]
- 两个查询子模块的帮助。
- api.php?action=help&modules=query+info|query+categorymembers [在沙盒中打开]
action=imagerotate
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
旋转一幅或多幅图像。
- rotation
顺时针旋转图像的度数。
- 这个参数是必须的。
- 以下值中的一个:90,180,270
- continue
当更多结果可用时,使用这个继续。
- titles
要工作的标题列表。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- pageids
要工作的页面ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- revids
要工作的修订ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- generator
通过执行指定查询模块获得页面列表以工作。
注意:发生器参数名称必须以“g”开头,参见例子。
- 以下值中的一个:allcategories,alldeletedrevisions,allfileusages,allimages,alllinks,allpages,allredirects,allrevisions,alltransclusions,backlinks,categories,categorymembers,deletedrevisions,duplicatefiles,embeddedin,exturlusage,fileusage,images,imageusage,iwbacklinks,langbacklinks,links,linkshere,pageswithprop,prefixsearch,protectedtitles,querypage,random,recentchanges,redirects,revisions,search,templates,transcludedin,watchlist,watchlistraw
- redirects
自动解决在titles、pageids和revids,以及在由generator返回的页面中的重定向。
- 类型:布尔值(详细信息)
- converttitles
如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan,iu,kk,ku,shi,sr,tg,uz,zh。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 90度旋转File:Example.png。
- api.php?action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC [在沙盒中打开]
- 将Category:Flip之中的所有图像旋转180度。
- api.php?action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&rotation=180&token=123ABC [在沙盒中打开]
action=import
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从另一个wiki或从一个XML文件导入页面。
注意当发送一个用于xml参数的文件时,HTTP POST必须作为一次文件上传完成(也就是使用multipart/form-data)。
- summary
日志记录导入摘要。
- xml
上传的XML文件。
- 必须被公布为使用multipart/form-data的一次文件上传。
- interwikisource
用于跨wiki导入:导入的来源wiki。
- 以下值中的一个:
- interwikipage
用于跨wiki导入:导入的页面。
- fullhistory
用于跨wiki导入:完整导入历史,而不只是最新版本。
- 类型:布尔值(详细信息)
- templates
用于跨wiki导入:连带导入所有包含的模板。
- 类型:布尔值(详细信息)
- namespace
导入至此名字空间。不能与rootpage一起使用。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- rootpage
作为此页面的子页面导入。不能与namespace一起使用。
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
action=linkaccount (link)
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
将来自第三方提供商的账户链接至当前用户。
使用此模块的一般程序是:
- 通过amirequestsfor=link取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokens的csrf令牌。
- 向用户显示字段,并获得其提交内容。
- 发送至此模块,提供linkreturnurl及任何相关字段。
- 在响应中检查status。
- 如果您收到了PASS或FAIL,您已经完成。操作要么成功,要么不成功。
- 如果您收到了UI,present the new fields to the user and obtain their submission. Then post to this module with linkcontinue and the relevant fields set, and repeat step 4.
- 如果您收到了REDIRECT,direct the user to the redirecttarget and wait for the return to linkreturnurl. Then post to this module with linkcontinue and any fields passed to the return URL, and repeat step 4.
- 如果您收到了RESTART,that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
- linkrequests
Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=link or from a previous response from this module.
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- linkmessageformat
返回消息使用的格式。
- 以下值中的一个:html,wikitext,raw,none
- 默认:wikitext
- linkmergerequestfields
合并用于所有身份验证请求的字段信息至一个数组中。
- 类型:布尔值(详细信息)
- linkreturnurl
Return URL for third-party authentication flows, must be absolute. Either this or linkcontinue is required.
Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a linkcontinue request to this API module.
- linkcontinue
此请求是在早先的UI或REDIRECT响应之后的附加请求。必需此值或linkreturnurl。
- 类型:布尔值(详细信息)
- linktoken
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- *
- 此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfo与amirequestsfor=link(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。
action=login (lg)
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
登录并获取身份验证Cookie。
此操作只应与Special:BotPasswords一起使用;用于主账户登录的方式已弃用,并可能在没有警告的情况下失败。要安全登录主账户,请使用action=clientlogin。
- lgname
用户名。
- lgpassword
密码。
- lgdomain
域名(可选)。
- lgtoken
从action=query&meta=tokens取回的“login”令牌
action=logout
- 来源:MediaWiki
- 许可协议:GPL-2.0+
退出并清除会话数据。
- 退出当前用户。
- api.php?action=logout [在沙盒中打开]
action=managetags
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
执行有关更改标签的管理任务。
- operation
要执行哪个操作:
- create
- 创建一个新的更改标签供手动使用。
- delete
- 从数据库中移除一个更改标签,包括移除已使用在所有修订版本、最近更改记录和日志记录上的该标签。
- activate
- 激活一个更改标签,允许用户手动应用它。
- deactivate
- 停用一个更改标签,阻止用户手动应用它。
- 这个参数是必须的。
- 以下值中的一个:create,delete,activate,deactivate
- tag
要创建、删除、激活或取消激活的标签。要创建标签,标签必须不存在。要删除标签,标签必须存在。要激活标签,标签必须存在,且不被任何扩展使用。要取消激活标签,标签必须当前处于激活状态,且被手动定义。
- 这个参数是必须的。
- reason
一个创建、删除、激活或停用标签时的原因,可选。
- ignorewarnings
是否忽略操作期间发生的任何警告。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 创建一个名为spam的标签,原因For use in edit patrolling
- api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [在沙盒中打开]
- 删除vandlaism标签,原因Misspelt
- api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC [在沙盒中打开]
- 激活一个名为spam的标签,原因For use in edit patrolling
- api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [在沙盒中打开]
- 停用一个名为spam的标签,原因No longer required
- api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC [在沙盒中打开]
action=mergehistory
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
合并页面历史。
- from
将被合并历史的页面的标题。不能与fromid一起使用。
- fromid
将被合并历史的页面的页面ID。不能与from一起使用。
- 类型:整数
- to
将要合并历史的页面的标题。不能与toid一起使用。
- toid
将要合并历史的页面的页面ID。不能与to一起使用。
- 类型:整数
- timestamp
指定时间戳,决定源页面的哪些修订历史被移动到目标页面的历史中。如果省略,源页面的所有历史记录都将被合并到目标页面。
- 类型:时间戳(允许格式)
- reason
历史合并的原因。
- 默认:(空)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 将Oldpage的完整历史合并至Newpage。
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason [在沙盒中打开]
- 将Oldpage直到2015-12-31T04:37:41Z的页面修订版本合并至Newpage。
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason×tamp=2015-12-31T04%3A37%3A41Z [在沙盒中打开]
action=mobileview
- 此模块需要读取权限。
- 来源:MobileFrontend
- 许可协议:GPL-2.0+
返回移动浏览需要的数据。
- page
待处理的页面标题。
- 这个参数是必须的。
- redirect
是否允许重定向。
- 以下值中的一个:yes,no
- 默认:yes
- sections
用于返回文本的逗号分隔的段数列表。“all”可用于返回所有的。格式范围“1-4”是指获取1、2、3、4段。没有指定第二个数字的范围,例如“1-”意思是获取所有直到末尾。“references”可被用于指定所有包含参考资料的段落应该被返回。
- prop
要获得的信息:
- text
- 选定段落的HTML。
- sections
- 有关页面上所有段落的信息。
- normalizedtitle
- 标准化的页面标题。
- lastmodified
- 页面最近修改时的 ISO 8601 时间戳,例如“2014-04-13T22:42:14Z”。
- lastmodifiedby
- 有关最近修改页面的用户的信息。
- revision
- 返回页面的当前修订版本ID。
- protection
- 有关保护级别的信息。
- editable
- 当前用户是否可以编辑此页面。这包括所有用于登录用户但不会封禁匿名用户的因素。
- languagecount
- 此页面可用的语言数。
- hasvariants
- 此页面在其他语言变体中是否可用。
- displaytitle
- 页面的渲染标题,带{{DISPLAYTITLE}}和这样的代码。
- pageprops
- 页面属性。
- 值(以|或替代物分隔):id,text,sections,normalizedtitle,lastmodified,lastmodifiedby,revision,protection,editable,languagecount,hasvariants,displaytitle,pageprops,description,contentmodel,namespace
- 默认:text|sections|normalizedtitle
- sectionprop
要获取的有关操作的信息。
- 值(以|或替代物分隔):toclevel,level,line,number,index,fromtitle,anchor
- 默认:toclevel|line
- pageprops
返回的页面属性,竖线(“|”)分隔列表或“*”对于所有属性。
- 默认:notoc|noeditsection|wikibase_item
- variant
转换内容至这种语言变体。
- noimages
返回不带图片的HTML。
- 类型:布尔值(详细信息)
- noheadings
输出时不包含标题。
- 类型:布尔值(详细信息)
- notransform
不要改变HTML至移动适配版。
- 类型:布尔值(详细信息)
- onlyrequestedsections
只返回请求的与prop=sections一样的段落。
- 类型:布尔值(详细信息)
- offset
假装所有文本结果是一个字符串,并返回此点位开始的子字符串。
- 值必须不少于0。
- 类型:整数
- 默认:0
- maxlen
假装所有文本结果是一个字符串,并限制结果至此长度。
- 值必须不少于0。
- 类型:整数
- 默认:0
- revision
请求一个特定修订版本。
- 值必须不少于0。
- 类型:整数
- 默认:0
- 获取有关Doom metal的第0章节的信息
- api.php?action=mobileview&page=Doom_metal§ions=0 [在沙盒中打开]
- 获取有关第0节和包含Candlemass的参考资料的段落的信息
- api.php?action=mobileview&page=Candlemass§ions=0|references [在沙盒中打开]
- 获得有关第1节及以后,和包含Candlemass的参考资料的段落的信息
- api.php?action=mobileview&page=Candlemass§ions=1-|references [在沙盒中打开]
action=move
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
移动一个页面。
- from
要重命名的页面标题。不能与fromid一起使用。
- fromid
您希望移动的页面ID。不能与from一起使用。
- 类型:整数
- to
页面重命名的目标标题。
- 这个参数是必须的。
- reason
重命名的原因。
- 默认:(空)
- movetalk
重命名讨论页,如果存在。
- 类型:布尔值(详细信息)
- movesubpages
重命名子页面,如果可以。
- 类型:布尔值(详细信息)
- noredirect
不要创建重定向。
- 类型:布尔值(详细信息)
- watch
- 已弃用。
将页面和重定向加入至当前用户的监视列表中。
- 类型:布尔值(详细信息)
- unwatch
- 已弃用。
从当前用户的监视列表中移除页面及重定向。
- 类型:布尔值(详细信息)
- watchlist
无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。
- 以下值中的一个:watch,unwatch,preferences,nochange
- 默认:preferences
- ignorewarnings
忽略任何警告。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 移动Badtitle到Goodtitle,不保留重定向。
- api.php?action=move&from=Badtitle&to=Goodtitle&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect= [在沙盒中打开]
action=opensearch
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
使用OpenSearch协议搜索wiki。
- search
搜索字符串。
- 这个参数是必须的。
- namespace
搜索的名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:0
- limit
要返回的结果最大数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- suggest
如果$wgEnableOpenSearchSuggest设置为false则不做任何事情。
- 类型:布尔值(详细信息)
- redirects
如何处理重定向:
- return
- 返回重定向本身。
- resolve
- 返回目标页面。可能返回少于limit个结果。
由于历史原因,format=json默认为"return",其他格式默认为"resolve"。
- 以下值中的一个:return,resolve
- format
输出格式。
- 以下值中的一个:json,jsonfm,xml,xmlfm
- 默认:json
- warningsaserror
如果警告通过format=json提升,返回一个API错误而不是忽略它们。
- 类型:布尔值(详细信息)
- 查找以Te开头的页面。
- api.php?action=opensearch&search=Te [在沙盒中打开]
action=options
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
更改当前用户的偏好设置。
只有注册在核心或者已安装扩展中的选项,或者具有userjs-
键值前缀(旨在被用户脚本使用)的选项可被设置。
- reset
将参数设置重置为网站默认值。
- 类型:布尔值(详细信息)
- resetkinds
当reset选项被设置时,要重置的选项类型列表。
- 值(以|或替代物分隔):registered,registered-multiselect,registered-checkmatrix,userjs,special,unused,all
- 默认:all
- change
更改列表,以name=value格式化(例如skin=vector)。值不能包含管道字符。如果没提供值(甚至没有等号),例如optionname|otheroption|...,选项将重置为默认值。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- optionname
应设置为由optionvalue提供值的选项名称。
- optionvalue
用于由optionname指定的选项的值,可以包含管道字符。
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 重置所有用户设置。
- api.php?action=options&reset=&token=123ABC [在沙盒中打开]
- 更改skin和hideminor设置。
- api.php?action=options&change=skin=vector|hideminor=1&token=123ABC [在沙盒中打开]
- 重置所有设置,然后设置skin和nickname。
- api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC [在沙盒中打开]
action=paraminfo
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获得关于API模块的信息。
- modules
模块名称(action和format参数值,或main)的列表。可通过+指定子模块,或通过+*指定所有子模块,或通过+**指定所有递归子模块。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- helpformat
帮助字符串的格式。
- 以下值中的一个:html,wikitext,raw,none
- 默认:none
- querymodules
- 已弃用。
查询模块名称(prop、meta或list参数值)的列表。使用modules=query+foo而不是querymodules=foo。
- 值(以|或替代物分隔):allcategories,alldeletedrevisions,allfileusages,allimages,alllinks,allmessages,allpages,allredirects,allrevisions,alltransclusions,allusers,authmanagerinfo,backlinks,blocks,categories,categoryinfo,categorymembers,contributors,deletedrevisions,deletedrevs,duplicatefiles,embeddedin,extlinks,exturlusage,filearchive,filerepoinfo,fileusage,imageinfo,images,imageusage,info,iwbacklinks,iwlinks,langbacklinks,langlinks,links,linkshere,logevents,mystashedfiles,pagepropnames,pageprops,pageswithprop,prefixsearch,protectedtitles,querypage,random,recentchanges,redirects,references,revisions,search,siteinfo,stashimageinfo,tags,templates,tokens,transcludedin,usercontribs,userinfo,users,watchlist,watchlistraw
- 值的最高数字是50(对于机器人则是500)。
- mainmodule
- 已弃用。
获取有关主要(最高级)模块的信息。也可使用modules=main。
- pagesetmodule
- 已弃用。
获取有关页面设置模块(提供titles=和朋友)的信息。
- formatmodules
- 已弃用。
格式模块名称(format参数的值)的列表。也可使用modules。
- 值(以|或替代物分隔):json,jsonfm,none,php,phpfm,rawfm,xml,xmlfm
action=parse
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
解析内容并返回解析器输出。
参见action=query的各种prop-module以从页面的当前版本获得信息。
这里有几种方法可以指定解析的文本:
- 指定一个页面或修订,使用page、pageid或oldid。
- 明确指定内容,使用text、title和contentmodel。
- 只指定一段摘要解析。prop应提供一个空值。
- title
文本属于的页面标题。如果省略,contentmodel就必须被指定,且API将作为标题使用。
- text
要解析的文本。使用title或contentmodel以控制内容模型。
- summary
要解析的摘要。
- page
解析此页的内容。不能与text和title一起使用。
- pageid
解析此页的内容。覆盖page。
- 类型:整数
- redirects
如果page或pageid被设置为一个重定向,则解析它。
- 类型:布尔值(详细信息)
- oldid
解析该修订版本的内容。覆盖page和pageid。
- 类型:整数
- prop
要获取的信息束:
- text
- 提供wiki文本中的被解析文本。
- langlinks
- 在被解析的wiki文本中提供语言链接。
- categories
- 在被解析的wiki文本中提供分类。
- categorieshtml
- 提供HTML版本分类。
- links
- 在被解析的wiki文本中提供内部链接。
- templates
- 在被解析的wiki文本中提供模板。
- images
- 在被解析的wiki文本中提供图片。
- externallinks
- 在被解析的wiki文本中提供外部链接。
- sections
- 在被解析的wiki文本中提供段落。
- revid
- 添加被解析页面的修订ID。
- displaytitle
- 为被解析的wiki文本添加标题。
- headitems
- 已弃用。提供项目以插入至页面的
<head>
。 - headhtml
- 提供页面的被解析
<head>
。 - modules
- 提供在页面中使用的ResourceLoader模块。要加载,请使用
mw.loader.using()
。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。 - jsconfigvars
- 针对页面提供JavaScript配置变量。要应用,请使用
mw.config.set()
。 - encodedjsconfigvars
- 针对页面提供JavaScript配置变量为一个JSON字符串。
- indicators
- 提供页面上使用的页面状态指示器的HTML。
- iwlinks
- 在被解析的wiki文本中提供跨wiki链接。
- wikitext
- 提供被解析的原始wiki文本。
- properties
- 提供多种定义在被解析的wiki文本中的属性。
- limitreportdata
- 以结构化的方式提供限制报告。如果disablelimitreport被设定则不提供数据。
- limitreporthtml
- 提供限制报告的HTML版本。当disablelimitreport被设置时不会提供数据。
- parsetree
- 修订内容的XML解析树(需要内容模型
wikitext
)
- 值(以|或替代物分隔):text,langlinks,categories,categorieshtml,links,templates,images,externallinks,sections,revid,displaytitle,headitems,headhtml,modules,jsconfigvars,encodedjsconfigvars,indicators,iwlinks,wikitext,properties,limitreportdata,limitreporthtml,parsetree
- 默认:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties
- pst
在解析输入前,对输入做一次保存前变换处理。仅当使用文本时有效。
- 类型:布尔值(详细信息)
- onlypst
在输入内容中执行预保存转换(PST),但不解析它。在PST被应用后返回相同的wiki文本。只当与text一起使用时有效。
- 类型:布尔值(详细信息)
- effectivelanglinks
包含由扩展提供的语言链接(用于与prop=langlinks一起使用)。
- 类型:布尔值(详细信息)
- section
只解析此段数的内容。
当new时,将text和sectiontitle解析为添加新段落至页面。
new段落只当指定text时允许。
- sectiontitle
当section为new时新段落标题。
不像页面编辑,当省略或为空时将不会备选为summary。
- disablepp
- 已弃用。
请改用disablelimitreport。
- 类型:布尔值(详细信息)
- disablelimitreport
从解析器输出中省略限制报告(“NewPP limit report”)。
- 类型:布尔值(详细信息)
- disableeditsection
从解析器输出中省略编辑段落链接。
- 类型:布尔值(详细信息)
- disabletidy
不要在解析器输出中运行HTML清理(例如tidy)。
- 类型:布尔值(详细信息)
- generatexml
- 已弃用。
生成XML解析树(需要内容模型
wikitext
;被prop=parsetree所取代)。- 类型:布尔值(详细信息)
- preview
在预览模式下解析。
- 类型:布尔值(详细信息)
- sectionpreview
在段落预览模式下解析(同时要启用预览模式)。
- 类型:布尔值(详细信息)
- disabletoc
在输出中省略目录。
- 类型:布尔值(详细信息)
- contentformat
用于输入文本的内容序列化格式。只当与text一起使用时有效。
- 以下值中的一个:text/x-wiki,text/javascript,application/json,text/css,text/plain
- contentmodel
输入文本的内容模型。如果省略,title必须指定,并且默认将为指定标题的模型。只当与text一起使用时有效。
- 以下值中的一个:wikitext,javascript,json,css,text
- mobileformat
以适配移动设备的格式返回解析输出。
- 类型:布尔值(详细信息)
- noimages
在移动输出中禁用图片。
- 类型:布尔值(详细信息)
- mainpage
应用移动首页转换。
- 类型:布尔值(详细信息)
action=patrol
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
巡查页面或修订版本。
- rcid
要巡查的最近更改 ID。
- 类型:整数
- revid
要巡查的修订版本ID。
- 类型:整数
- tags
要在巡查日志中应用到实体的更改标签。
- 值(以|或替代物分隔):
- token
从action=query&meta=tokens取回的“patrol”令牌
- 这个参数是必须的。
action=protect
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
更改页面的保护等级。
- title
要(解除)保护的页面标题。不能与pageid一起使用。
- pageid
要(解除)保护的页面ID。不能与title一起使用。
- 类型:整数
- protections
保护等级列表,格式:action=level(例如edit=sysop)。等级all意味着任何人都可以执行操作,也就是说没有限制。
注意:未列出的操作将移除限制。
- 这个参数是必须的。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- expiry
到期时间戳。如果只有一个时间戳被设置,它将被用于所有保护。使用infinite、indefinite、infinity或never用于永不过期的保护。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- 默认:infinite
- reason
(解除)保护的原因。
- 默认:(空)
- tags
要在保护日志中应用到实体的更改标签。
- 值(以|或替代物分隔):
- cascade
启用连锁保护(也就是保护包含于此页面的页面)。如果所有提供的保护等级不支持连锁,就将其忽略。
- 类型:布尔值(详细信息)
- watch
- 已弃用。
如果设置,就加入已开始(解除)保护的页面至当前用户的监视列表。
- 类型:布尔值(详细信息)
- watchlist
无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。
- 以下值中的一个:watch,unwatch,preferences,nochange
- 默认:preferences
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 保护一个页面。
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never [在沙盒中打开]
- 通过设置限制为all解除保护一个页面(就是说任何人都可以执行操作)。
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions [在沙盒中打开]
- 通过设置没有限制解除保护一个页面。
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=&reason=Lifting%20restrictions [在沙盒中打开]
action=purge
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
为指定标题刷新缓存。
如果用户尚未登录的话,就需要POST请求。
- forcelinkupdate
更新链接表。
- 类型:布尔值(详细信息)
- forcerecursivelinkupdate
更新链接表中,并更新任何使用此页作为模板的页面的链接表。
- 类型:布尔值(详细信息)
- continue
当更多结果可用时,使用这个继续。
- titles
要工作的标题列表。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- pageids
要工作的页面ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- revids
要工作的修订ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- generator
通过执行指定查询模块获得页面列表以工作。
注意:发生器参数名称必须以“g”开头,参见例子。
- 以下值中的一个:allcategories,alldeletedrevisions,allfileusages,allimages,alllinks,allpages,allredirects,allrevisions,alltransclusions,backlinks,categories,categorymembers,deletedrevisions,duplicatefiles,embeddedin,exturlusage,fileusage,images,imageusage,iwbacklinks,langbacklinks,links,linkshere,pageswithprop,prefixsearch,protectedtitles,querypage,random,recentchanges,redirects,revisions,search,templates,transcludedin,watchlist,watchlistraw
- redirects
自动解决在titles、pageids和revids,以及在由generator返回的页面中的重定向。
- 类型:布尔值(详细信息)
- converttitles
如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan,iu,kk,ku,shi,sr,tg,uz,zh。
- 类型:布尔值(详细信息)
- 刷新Main Page和API页面。
- api.php?action=purge&titles=Main_Page|API [在沙盒中打开]
- 刷新主名字空间的前10个页面。
- api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10 [在沙盒中打开]
action=query
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取来自和有关MediaWiki的数据。
所有数据修改将首先要使用查询以获得令牌以阻止来自恶意网站的滥用破坏。
- prop
要为已查询页面获取的属性。
- 值(以|或替代物分隔):categories,categoryinfo,contributors,deletedrevisions,duplicatefiles,extlinks,fileusage,imageinfo,images,info,iwlinks,langlinks,links,linkshere,pageprops,redirects,references,revisions,stashimageinfo,templates,transcludedin
- list
要获取的列表。
- 值(以|或替代物分隔):allcategories,alldeletedrevisions,allfileusages,allimages,alllinks,allpages,allredirects,allrevisions,alltransclusions,allusers,backlinks,blocks,categorymembers,deletedrevs,embeddedin,exturlusage,filearchive,imageusage,iwbacklinks,langbacklinks,logevents,mystashedfiles,pagepropnames,pageswithprop,prefixsearch,protectedtitles,querypage,random,recentchanges,search,tags,usercontribs,users,watchlist,watchlistraw
- meta
要获取的元数据。
- 值(以|或替代物分隔):allmessages,authmanagerinfo,filerepoinfo,siteinfo,tokens,userinfo
- indexpageids
包含一个额外的pageid段落,列举所有返回的页面ID。
- 类型:布尔值(详细信息)
- export
导出所有指定或生成页面的当前修订。
- 类型:布尔值(详细信息)
- exportnowrap
返回导出XML,不需要将其包裹在一个XML结果中(与Special:Export格式相同)。只能与export一起使用。
- 类型:布尔值(详细信息)
- iwurl
如果标题是一个跨wiki链接的话,是否获取完整URL。
- 类型:布尔值(详细信息)
- continue
当更多结果可用时,使用这个继续。
- rawcontinue
为继续返回原始query-continue数据。
- 类型:布尔值(详细信息)
- titles
要工作的标题列表。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- pageids
要工作的页面ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- revids
要工作的修订ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- generator
通过执行指定查询模块获得页面列表以工作。
注意:发生器参数名称必须以“g”开头,参见例子。
- 以下值中的一个:allcategories,alldeletedrevisions,allfileusages,allimages,alllinks,allpages,allredirects,allrevisions,alltransclusions,backlinks,categories,categorymembers,deletedrevisions,duplicatefiles,embeddedin,exturlusage,fileusage,images,imageusage,iwbacklinks,langbacklinks,links,linkshere,pageswithprop,prefixsearch,protectedtitles,querypage,random,recentchanges,redirects,revisions,search,templates,transcludedin,watchlist,watchlistraw
- redirects
自动解决在titles、pageids和revids,以及在由generator返回的页面中的重定向。
- 类型:布尔值(详细信息)
- converttitles
如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan,iu,kk,ku,shi,sr,tg,uz,zh。
- 类型:布尔值(详细信息)
prop=categories (cl)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
页面属于的所有分类列表。
- clprop
要为每个分类获取的额外属性:
- sortkey
- 为每个分类添加关键词(十六进制字符串)和关键词前缀(人类可读部分)。
- timestamp
- 添加分类添加时的时间戳。
- hidden
- 标记由
__HIDDENCAT__
隐藏的分类。
- 值(以|或替代物分隔):sortkey,timestamp,hidden
- clshow
显示何种分类。
- 值(以|或替代物分隔):hidden,!hidden
- cllimit
返回多少分类。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- clcontinue
当更多结果可用时,使用这个继续。
- clcategories
只列出这些分类。对于检查某一页面使用某一分类很有用。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- cldir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- 获取属于Albert Einstein的分类列表。
- api.php?action=query&prop=categories&titles=Albert%20Einstein [在沙盒中打开]
- 获得有关用于Albert Einstein的分类的信息。
- api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [在沙盒中打开]
prop=categoryinfo (ci)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回有关给定分类的信息。
- cicontinue
当更多结果可用时,使用这个继续。
- 获取有关Category:Foo和Category:Bar的信息。
- api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [在沙盒中打开]
prop=contributors (pc)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取对一个页面的登录贡献者列表和匿名贡献数。
- pcgroup
只包括指定用户组中的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。
- 值(以|或替代物分隔):bot,sysop,bureaucrat
- pcexcludegroup
排除指定用户组中的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。
- 值(以|或替代物分隔):bot,sysop,bureaucrat
- pcrights
只包括拥有指定权限的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。
- 值(以|或替代物分隔):apihighlimits,applychangetags,autoconfirmed,autocreateaccount,autopatrol,bigdelete,block,blockemail,bot,browsearchive,changetags,createaccount,createpage,createtalk,delete,deletechangetags,deletedhistory,deletedtext,deletelogentry,deleterevision,edit,editcontentmodel,editinterface,editprotected,editmyoptions,editmyprivateinfo,editmyusercss,editmyuserjs,editmywatchlist,editsemiprotected,editusercssjs,editusercss,edituserjs,hideuser,import,importupload,ipblock-exempt,managechangetags,markbotedits,mergehistory,minoredit,move,movefile,move-categorypages,move-rootuserpages,move-subpages,nominornewtalk,noratelimit,override-export-depth,pagelang,passwordreset,patrol,patrolmarks,protect,purge,read,reupload,reupload-own,reupload-shared,rollback,sendemail,siteadmin,suppressionlog,suppressredirect,suppressrevision,unblockself,undelete,unwatchedpages,upload,upload_by_url,userrights,userrights-interwiki,viewmyprivateinfo,viewmywatchlist,viewsuppressed,writeapi,skipcaptcha,mf-uploadbutton
- 值的最高数字是50(对于机器人则是500)。
- pcexcluderights
排除拥有指定权限的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。
- 值(以|或替代物分隔):apihighlimits,applychangetags,autoconfirmed,autocreateaccount,autopatrol,bigdelete,block,blockemail,bot,browsearchive,changetags,createaccount,createpage,createtalk,delete,deletechangetags,deletedhistory,deletedtext,deletelogentry,deleterevision,edit,editcontentmodel,editinterface,editprotected,editmyoptions,editmyprivateinfo,editmyusercss,editmyuserjs,editmywatchlist,editsemiprotected,editusercssjs,editusercss,edituserjs,hideuser,import,importupload,ipblock-exempt,managechangetags,markbotedits,mergehistory,minoredit,move,movefile,move-categorypages,move-rootuserpages,move-subpages,nominornewtalk,noratelimit,override-export-depth,pagelang,passwordreset,patrol,patrolmarks,protect,purge,read,reupload,reupload-own,reupload-shared,rollback,sendemail,siteadmin,suppressionlog,suppressredirect,suppressrevision,unblockself,undelete,unwatchedpages,upload,upload_by_url,userrights,userrights-interwiki,viewmyprivateinfo,viewmywatchlist,viewsuppressed,writeapi,skipcaptcha,mf-uploadbutton
- 值的最高数字是50(对于机器人则是500)。
- pclimit
返回的贡献数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- pccontinue
当更多结果可用时,使用这个继续。
- 显示Main Page的贡献。
- api.php?action=query&prop=contributors&titles=Main_Page [在沙盒中打开]
prop=deletedrevisions (drv)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获得删除修订版本信息。
可在很多途径中使用:
- 获得一组页面的已删除修订,通过设置标题或页面ID。以标题和时间戳排序。
- 通过设置它们的ID与修订ID获得关于一组已删除修订。以修订ID排序。
- drvprop
要为每个修订获取的属性:
- ids
- 修订ID。
- flags
- 修订标记(小编辑)。
- timestamp
- 修订的时间戳。
- user
- 做出修订的用户。
- userid
- 修订创建者的用户ID。
- size
- 修订的长度(字节)。
- sha1
- 修订的SHA-1(base 16)。
- contentmodel
- 修订的内容模型ID。
- comment
- 由用户对修订做出的摘要。
- parsedcomment
- 由用户对修订做出的被解析的摘要。
- content
- 修订文本。
- tags
- 修订标签。
- parsetree
- 修订内容的XML解析树(需要内容模型
wikitext
)。
- 值(以|或替代物分隔):ids,flags,timestamp,user,userid,size,sha1,contentmodel,comment,parsedcomment,content,tags,parsetree
- 默认:ids|timestamp|flags|comment|user
- drvlimit
限制返回多少修订。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- drvexpandtemplates
展开修订内容中的模板(需要drvprop=content)。
- 类型:布尔值(详细信息)
- drvgeneratexml
- 已弃用。
生成用于修订内容的XML解析树(需要drvprop=content;被drvprop=parsetree所取代)。
- 类型:布尔值(详细信息)
- drvparse
解析修订内容(需要drvprop=content)。由于性能原因,如果此选项被使用,drvlimit会被强制为1。
- 类型:布尔值(详细信息)
- drvsection
只检索此段落数的内容。
- drvdiffto
要比较修订差异的修订ID。使用prev、next和cur分别用于上个、下个和当前修订。
- drvdifftotext
要比较修订差异的文本。只有修订的有限数字内的差异。覆盖drvdiffto。如果drvsection被设置,只有那个段落将与此文本之间比较差异
- drvdifftotextpst
在编辑文本前对其执行预保存转换。只当与drvdifftotext一起使用时有效。
- 类型:布尔值(详细信息)
- drvcontentformat
序列化用于drvdifftotext的格式并预估内容输出。
- 以下值中的一个:text/x-wiki,text/javascript,application/json,text/css,text/plain
- drvstart
要开始枚举的时间戳。当处理修订ID列表时会被忽略。
- 类型:时间戳(允许格式)
- drvend
要停止枚举的时间戳。当处理修订ID列表时会被忽略。
- 类型:时间戳(允许格式)
- drvdir
列举的方向:
- newer
- 最早的优先。注意:drvstart应早于drvend。
- older
- 最新的优先(默认)。注意:drvstart应晚于drvend。
- 以下值中的一个:newer,older
- 默认:older
- drvtag
只列出被此标签标记的修订。
- drvuser
只列出此用户做出的修订。
- 类型:用户名
- drvexcludeuser
不要列出此用户做出的修订。
- 类型:用户名
- drvcontinue
当更多结果可用时,使用这个继续。
- 列出页面Main Page和Talk:Main Page的已删除修订,包含内容。
- api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content [在沙盒中打开]
- 列出已删除修订123456的信息。
- api.php?action=query&prop=deletedrevisions&revids=123456 [在沙盒中打开]
prop=duplicatefiles (df)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
根据哈希值列出此给定文件的所有副本。
- dflimit
返回多少重复文件。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- dfcontinue
当更多结果可用时,使用这个继续。
- dfdir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- dflocalonly
只看本地存储库的文件。
- 类型:布尔值(详细信息)
prop=extlinks (el)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从指定页面返回所有外部URL(非跨wiki链接)。
- ellimit
返回多少链接。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- eloffset
当更多结果可用时,使用这个继续。
- 类型:整数
- elprotocol
URL协议。如果为空并且elquery被设置,协议为http。将此和elquery都留空以列举所有外部链接。
- 以下值中的一个:可以为空,或bitcoin,ftp,ftps,geo,git,gopher,http,https,irc,ircs,magnet,mailto,mms,news,nntp,redis,sftp,sip,sips,sms,ssh,svn,tel,telnet,urn,worldwind,xmpp
- 默认:(空)
- elquery
不使用协议搜索字符串。对于检查某一页面是否包含某一外部URL很有用。
- elexpandurl
扩展协议相对URL与规范协议。
- 类型:布尔值(详细信息)
- 获取Main Page的外部链接列表。
- api.php?action=query&prop=extlinks&titles=Main%20Page [在沙盒中打开]
prop=fileusage (fu)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
查找所有使用指定文件的页面。
- fuprop
要获取的属性:
- pageid
- 每个页面的页面ID。
- title
- 每个页面的标题。
- redirect
- 标记作为重定向的页面。
- 值(以|或替代物分隔):pageid,title,redirect
- 默认:pageid|title|redirect
- funamespace
只包括这些名字空间的页面。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- fushow
只显示符合以下标准的项:
- redirect
- 只显示重定向。
- !redirect
- 只显示非重定向。
- 值(以|或替代物分隔):redirect,!redirect
- fulimit
返回多少。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- fucontinue
当更多结果可用时,使用这个继续。
prop=imageinfo (ii)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回文件信息和上传历史。
- iiprop
要获取的文件信息:
- timestamp
- 添加时间戳至上传的版本。
- user
- 添加上传了每个文件版本的用户。
- userid
- 添加上传了每个文件版本的用户ID。
- comment
- 此版本的摘要。
- parsedcomment
- 解析版本上的注释。
- canonicaltitle
- 添加文件的规范标题。
- url
- 为文件及其描述页面提供URL。
- size
- 添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
- dimensions
- 用于大小的别名。
- sha1
- 为文件加入SHA-1哈希值。
- mime
- 添加文件的MIME类型。
- thumbmime
- 添加图片缩略图的MIME类型(需要url和参数iiurlwidth)。
- mediatype
- 添加文件媒体类型。
- metadata
- 列出这个版本的文件的EXIF元数据。
- commonmetadata
- 为文件的修订版本列出文件格式相关元数据。
- extmetadata
- 列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
- archivename
- 添加用于非最新修订的存档修订的文件名。
- bitdepth
- 添加修订的字节深度。
- uploadwarning
- 由Special:Upload所使用,以获取关于现有文件的信息。不适用于MediaWiki核心以外代码。
- 值(以|或替代物分隔):timestamp,user,userid,comment,parsedcomment,canonicaltitle,url,size,dimensions,sha1,mime,thumbmime,mediatype,metadata,commonmetadata,extmetadata,archivename,bitdepth,uploadwarning
- 默认:timestamp|user
- iilimit
每个文件返回多少文件修订。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:1
- iistart
开始列举的时间戳。
- 类型:时间戳(允许格式)
- iiend
列举的结束时间戳。
- 类型:时间戳(允许格式)
- iiurlwidth
如果iiprop=url被设定,将返回至缩放到此宽度的一张图片的URL。 由于性能原因,如果此消息被使用,将不会返回超过50张被缩放的图片。
- 类型:整数
- 默认:-1
- iiurlheight
与iiurlwidth类似。
- 类型:整数
- 默认:-1
- iimetadataversion
要使用的元数据版本。如果latest被指定,则使用最新版本。默认为1以便向下兼容。
- 默认:1
- iiextmetadatalanguage
要取得extmetadata的语言。这会影响到抓取翻译的选择,如果有多个可用的话,还会影响到数字等数值的格式。
- 默认:zh-cn
- iiextmetadatamultilang
如果用于extmetadata属性的翻译可用,则全部取得。
- 类型:布尔值(详细信息)
- iiextmetadatafilter
如果指定且非空,则只为iiprop=extmetadata返回这些键。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- iiurlparam
处理器特定的参数字符串。例如PDF可能使用page15-100px。iiurlwidth必须被使用,并与iiurlparam一致。
- 默认:(空)
- iicontinue
当更多结果可用时,使用这个继续。
- iilocalonly
只看本地存储库的文件。
- 类型:布尔值(详细信息)
prop=images (im)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回指定页面上包含的所有文件。
- imlimit
返回多少文件。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- imcontinue
当更多结果可用时,使用这个继续。
- imimages
只列出这些文件。对于检查某一页面是否使用某一文件很有用。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- imdir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
prop=info (in)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取基本页面信息。
- inprop
要获取的额外属性:
- protection
- 列出每个页面的保护等级。
- talkid
- 每个非讨论页面的讨论页的页面ID。
- watched
- 列出每个页面的被监视状态。
- watchers
- 监视人员数,如果允许。
- visitingwatchers
- 访问了每个页面的最近编辑的监视者数量,如果允许。
- notificationtimestamp
- 每个页面的监视列表通知时间戳。
- subjectid
- 每个讨论页的母页面的页面ID。
- url
- 为每个页面提供一个完整URL、一个编辑URL和规范URL。
- readable
- 用户是否可以阅读此页面。
- preload
- 提供由EditFormPreloadText返回的文本。
- displaytitle
- 在页面标题实际显示的地方提供方式。
- 值(以|或替代物分隔):protection,talkid,watched,watchers,visitingwatchers,notificationtimestamp,subjectid,url,readable,preload,displaytitle
- intestactions
测试当前用户是否可以在页面上执行某种操作。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- intoken
- 已弃用。
- 值(以|或替代物分隔):edit,delete,protect,move,block,unblock,email,import,watch
- incontinue
当更多结果可用时,使用这个继续。
- 获取有关页面Main Page的信息。
- api.php?action=query&prop=info&titles=Main%20Page [在沙盒中打开]
- 获取Main Page相关的常规和保护信息。
- api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [在沙盒中打开]
prop=iwlinks (iw)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从指定页面返回所有跨wiki链接。
- iwprop
要为每个跨语言链接获取的额外属性:
- url
- 添加完整URL。
- 值(以|或替代物分隔):url
- iwprefix
只返回此前缀的跨wiki链接。
- iwtitle
用于搜索的跨wiki链接。必须与iwprefix一起使用。
- iwdir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- iwlimit
返回多少跨wiki链接。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- iwcontinue
当更多结果可用时,使用这个继续。
- iwurl
- 已弃用。
是否获取完整URL(不能与iwprop一起使用)。
- 类型:布尔值(详细信息)
- 从页面Main Page获得跨wiki链接。
- api.php?action=query&prop=iwlinks&titles=Main%20Page [在沙盒中打开]
prop=langlinks (ll)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从指定页面返回所有跨语言链接。
- llprop
要为每个跨语言链接获取的额外属性:
- url
- 添加完整URL。
- langname
- 添加本地化语言名(尽可能)。使用llinlanguagecode以控制语言。
- autonym
- 添加本地语言名。
- 值(以|或替代物分隔):url,langname,autonym
- lllang
只返回带此语言代码的语言链接。
- lltitle
要搜索的链接。必须与lllang一起使用。
- lldir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- llinlanguagecode
本地化语言名称的语言代码。
- 默认:zh-cn
- lllimit
返回多少语言链接。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- llcontinue
当更多结果可用时,使用这个继续。
- llurl
- 已弃用。
是否获取完整URL(不能与llprop一起使用)。
- 类型:布尔值(详细信息)
- 从页面Main Page获取跨语言链接。
- api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= [在沙盒中打开]
prop=links (pl)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从指定页面返回所有链接。
- 从页面Main Page获取链接。
- api.php?action=query&prop=links&titles=Main%20Page [在沙盒中打开]
- 获取有关在页面Main Page中连接的页面的信息。
- api.php?action=query&generator=links&titles=Main%20Page&prop=info [在沙盒中打开]
- 获取在用户和模板名字空间中来自页面Main Page的链接。
- api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [在沙盒中打开]
prop=linkshere (lh)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
查找所有链接至指定页面的页面。
- lhprop
要获取的属性:
- pageid
- 每个页面的页面ID。
- title
- 每个页面的标题。
- redirect
- 如果页面是一个重定向就标记。
- 值(以|或替代物分隔):pageid,title,redirect
- 默认:pageid|title|redirect
- lhnamespace
只包括这些名字空间的页面。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- lhshow
只显示符合以下标准的项:
- redirect
- 只显示重定向。
- !redirect
- 只显示非重定向。
- 值(以|或替代物分隔):redirect,!redirect
- lhlimit
返回多少。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- lhcontinue
当更多结果可用时,使用这个继续。
prop=pageprops (pp)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取页面内容中定义的各种页面属性。
- ppcontinue
当更多结果可用时,使用这个继续。
- ppprop
只列出这些页面属性(action=query&list=pagepropnames返回使用中的页面属性名称)。在检查页面是否使用某一页面属性时有用。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- 获取用于页面Main Page和MediaWiki的属性。
- api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [在沙盒中打开]
prop=redirects (rd)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回至指定页面的所有重定向。
- rdprop
要获取的属性:
- pageid
- 每个重定向的页面ID。
- title
- 每个重定向的标题。
- fragment
- 每个重定向的碎片,如果有。
- 值(以|或替代物分隔):pageid,title,fragment
- 默认:pageid|title
- rdnamespace
只包含这些名字空间的页面。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- rdshow
只显示符合这些标准的项目:
- fragment
- 只显示带碎片的重定向。
- !fragment
- 只显示不带碎片的重定向。
- 值(以|或替代物分隔):fragment,!fragment
- rdlimit
返回多少重定向。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- rdcontinue
当更多结果可用时,使用这个继续。
prop=references (rf)
- 此模块需要读取权限。
- 来源:Cite
- 许可协议:GPL-2.0+
返回与指定页面相关联的参考文献的数据表示法。
- rfcontinue
当更多结果可用时,使用这个继续。
- 与Albert Einstein相关联的参考文献。
- api.php?action=query&prop=references&titles=Albert%20Einstein [在沙盒中打开]
prop=revisions (rv)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取修订版本信息。
可用于以下几个方面:
- 通过设置标题或页面ID获取一批页面(最新修订)的数据。
- 通过使用带start、end或limit的标题或页面ID获取给定页面的多个修订。
- 通过revid设置一批修订的ID获取它们的数据。
- rvprop
要为每个修订获取的属性:
- ids
- 修订ID。
- flags
- 修订标记(小编辑)。
- timestamp
- 修订的时间戳。
- user
- 做出修订的用户。
- userid
- 修订创建者的用户ID。
- size
- 修订的长度(字节)。
- sha1
- 修订的SHA-1(base 16)。
- contentmodel
- 修订的内容模型ID。
- comment
- 由用户对修订做出的摘要。
- parsedcomment
- 由用户对修订做出的被解析的摘要。
- content
- 修订文本。
- tags
- 修订标签。
- parsetree
- 修订内容的XML解析树(需要内容模型
wikitext
)。
- 值(以|或替代物分隔):ids,flags,timestamp,user,userid,size,sha1,contentmodel,comment,parsedcomment,content,tags,parsetree
- 默认:ids|timestamp|flags|comment|user
- rvlimit
限制返回多少修订。
- 可能只能与单一页面使用(模式#2)。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- rvexpandtemplates
展开修订内容中的模板(需要rvprop=content)。
- 类型:布尔值(详细信息)
- rvgeneratexml
- 已弃用。
生成用于修订内容的XML解析树(需要rvprop=content;被rvprop=parsetree所取代)。
- 类型:布尔值(详细信息)
- rvparse
解析修订内容(需要rvprop=content)。由于性能原因,如果此选项被使用,rvlimit会被强制为1。
- 类型:布尔值(详细信息)
- rvsection
只检索此段落数的内容。
- rvdiffto
要比较修订差异的修订ID。使用prev、next和cur分别用于上个、下个和当前修订。
- rvdifftotext
要比较修订差异的文本。只有修订的有限数字内的差异。覆盖rvdiffto。如果rvsection被设置,只有那个段落将与此文本之间比较差异
- rvdifftotextpst
在编辑文本前对其执行预保存转换。只当与rvdifftotext一起使用时有效。
- 类型:布尔值(详细信息)
- rvcontentformat
序列化用于rvdifftotext的格式并预估内容输出。
- 以下值中的一个:text/x-wiki,text/javascript,application/json,text/css,text/plain
- rvstartid
从哪个修订版本ID开始列举。
- 可能只能与单一页面使用(模式#2)。
- 类型:整数
- rvendid
在此修订版本ID停止修订列举。
- 可能只能与单一页面使用(模式#2)。
- 类型:整数
- rvstart
从哪个修订版本时间戳开始列举。
- 可能只能与单一页面使用(模式#2)。
- 类型:时间戳(允许格式)
- rvend
列举直至此时间戳。
- 可能只能与单一页面使用(模式#2)。
- 类型:时间戳(允许格式)
- rvdir
列举的方向:
- newer
- 最早的优先。注意:rvstart应早于rvend。
- older
- 最新的优先(默认)。注意:rvstart应晚于rvend。
- 可能只能与单一页面使用(模式#2)。
- 以下值中的一个:newer,older
- 默认:older
- rvuser
只包含由用户做出的修订。
- 可能只能与单一页面使用(模式#2)。
- 类型:用户名
- rvexcludeuser
不包括由用户做出的修订。
- 可能只能与单一页面使用(模式#2)。
- 类型:用户名
- rvtag
只列出被此标签标记的修订。
- rvtoken
- 已弃用。
要为每个修订版本获得的令牌。
- 值(以|或替代物分隔):rollback
- rvcontinue
当更多结果可用时,使用这个继续。
- 获取带内容的数据,用于标题API和Main Page的最近修订。
- api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content [在沙盒中打开]
- 获取Main Page的最近5次修订。
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment [在沙盒中打开]
- 获取Main Page的前5次修订。
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer [在沙盒中打开]
- 获取Main Page于2006年05月01日之后做出的前5次修订版本。
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z [在沙盒中打开]
- 获取Main Page的前5次不是由匿名用户127.0.0.1做出的修订。
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1 [在沙盒中打开]
- 获取Main Page的前5次由用户MediaWiki default做出的修订。
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default [在沙盒中打开]
prop=stashimageinfo (sii)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回用于藏匿文件的文件信息。
- siifilekey
用于识别一次临时藏匿的早前上传的关键字。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- siisessionkey
- 已弃用。
siifilekey的别名,用于向后兼容。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- siiprop
要获取的文件信息:
- timestamp
- 添加时间戳至上传的版本。
- canonicaltitle
- 添加文件的规范标题。
- url
- 为文件及其描述页面提供URL。
- size
- 添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
- dimensions
- 用于大小的别名。
- sha1
- 为文件加入SHA-1哈希值。
- mime
- 添加文件的MIME类型。
- thumbmime
- 添加图片缩略图的MIME类型(需要url和参数siiurlwidth)。
- metadata
- 列出这个版本的文件的EXIF元数据。
- commonmetadata
- 为文件的修订版本列出文件格式相关元数据。
- extmetadata
- 列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
- bitdepth
- 添加修订的字节深度。
- 值(以|或替代物分隔):timestamp,canonicaltitle,url,size,dimensions,sha1,mime,thumbmime,metadata,commonmetadata,extmetadata,bitdepth
- 默认:timestamp|url
- siiurlwidth
如果siiprop=url被设定,将返回至缩放到此宽度的一张图片的URL。 由于性能原因,如果此消息被使用,将不会返回超过50张被缩放的图片。
- 类型:整数
- 默认:-1
- siiurlheight
与siiurlwidth类似。
- 类型:整数
- 默认:-1
- siiurlparam
处理器特定的参数字符串。例如PDF可能使用page15-100px。siiurlwidth必须被使用,并与siiurlparam一致。
- 默认:(空)
prop=templates (tl)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回指定页面上所有被嵌入的页面。
- 获取在页面Main Page使用的模板。
- api.php?action=query&prop=templates&titles=Main%20Page [在沙盒中打开]
- 获取有关Main Page中使用的模板页面的信息。
- api.php?action=query&generator=templates&titles=Main%20Page&prop=info [在沙盒中打开]
- 获取在用户和模板名字空间中,嵌入在Main Page页面的页面。
- api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [在沙盒中打开]
prop=transcludedin (ti)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
查找所有嵌入指定页面的页面。
- tiprop
要获取的属性:
- pageid
- 每个页面的页面ID。
- title
- 每个页面的标题。
- redirect
- 标记作为重定向的页面。
- 值(以|或替代物分隔):pageid,title,redirect
- 默认:pageid|title|redirect
- tinamespace
至包含这些名字空间的页面。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- tishow
只显示符合以下标准的项:
- redirect
- 只显示重定向。
- !redirect
- 只显示非重定向。
- 值(以|或替代物分隔):redirect,!redirect
- tilimit
返回多少。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- ticontinue
当更多结果可用时,使用这个继续。
- 获取嵌入Main Page的页面列表。
- api.php?action=query&prop=transcludedin&titles=Main%20Page [在沙盒中打开]
- 获取有关嵌入Main Page的页面的信息。
- api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info [在沙盒中打开]
list=allcategories (ac)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列举所有分类。
- acfrom
要作为枚举起始点的类别。
- accontinue
当更多结果可用时,使用这个继续。
- acto
要作为枚举终止点的类别。
- acprefix
搜索所有以此值开头的分类标题。
- acdir
排序方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- acmin
只返回至少带这么多成员的分类。
- 类型:整数
- acmax
只返回最多带这么多成员的分类。
- 类型:整数
- aclimit
要返回多少个类别。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- acprop
要获取的属性:
- size
- 在分类中添加页面数。
- hidden
- 标记由
__HIDDENCAT__
隐藏的分类。
- 值(以|或替代物分隔):size,hidden
- 默认:(空)
- 列出分类及其含有多少页面的信息。
- api.php?action=query&list=allcategories&acprop=size [在沙盒中打开]
- 为以List的分类检索有关分类页面本身的信息。
- api.php?action=query&generator=allcategories&gacprefix=List&prop=info [在沙盒中打开]
list=alldeletedrevisions (adr)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列举由一位用户或在一个名字空间中所有已删除的修订。
- adrprop
要为每个修订获取的属性:
- ids
- 修订ID。
- flags
- 修订标记(小编辑)。
- timestamp
- 修订的时间戳。
- user
- 做出修订的用户。
- userid
- 修订创建者的用户ID。
- size
- 修订的长度(字节)。
- sha1
- 修订的SHA-1(base 16)。
- contentmodel
- 修订的内容模型ID。
- comment
- 由用户对修订做出的摘要。
- parsedcomment
- 由用户对修订做出的被解析的摘要。
- content
- 修订文本。
- tags
- 修订标签。
- parsetree
- 修订内容的XML解析树(需要内容模型
wikitext
)。
- 值(以|或替代物分隔):ids,flags,timestamp,user,userid,size,sha1,contentmodel,comment,parsedcomment,content,tags,parsetree
- 默认:ids|timestamp|flags|comment|user
- adrlimit
限制返回多少修订。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- adrexpandtemplates
展开修订内容中的模板(需要adrprop=content)。
- 类型:布尔值(详细信息)
- adrgeneratexml
- 已弃用。
生成用于修订内容的XML解析树(需要adrprop=content;被adrprop=parsetree所取代)。
- 类型:布尔值(详细信息)
- adrparse
解析修订内容(需要adrprop=content)。由于性能原因,如果此选项被使用,adrlimit会被强制为1。
- 类型:布尔值(详细信息)
- adrsection
只检索此段落数的内容。
- adrdiffto
要比较修订差异的修订ID。使用prev、next和cur分别用于上个、下个和当前修订。
- adrdifftotext
要比较修订差异的文本。只有修订的有限数字内的差异。覆盖adrdiffto。如果adrsection被设置,只有那个段落将与此文本之间比较差异
- adrdifftotextpst
在编辑文本前对其执行预保存转换。只当与adrdifftotext一起使用时有效。
- 类型:布尔值(详细信息)
- adrcontentformat
序列化用于adrdifftotext的格式并预估内容输出。
- 以下值中的一个:text/x-wiki,text/javascript,application/json,text/css,text/plain
- adruser
只列出此用户做出的修订。
- 类型:用户名
- adrnamespace
只列出此名字空间的页面。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- adrstart
枚举的起始时间戳。
- 只可以与adruser一起使用。
- 类型:时间戳(允许格式)
- adrend
枚举的结束时间戳。
- 只可以与adruser一起使用。
- 类型:时间戳(允许格式)
- adrdir
列举的方向:
- newer
- 最早的优先。注意:adrstart应早于adrend。
- older
- 最新的优先(默认)。注意:adrstart应晚于adrend。
- 以下值中的一个:newer,older
- 默认:older
- adrfrom
从此标题开始列出。
- 不能与adruser一起使用。
- adrto
列出至此标题为止。
- 不能与adruser一起使用。
- adrprefix
搜索所有以此值开头的页面标题。
- 不能与adruser一起使用。
- adrexcludeuser
不要列出此用户做出的修订。
- 不能与adruser一起使用。
- 类型:用户名
- adrtag
只列出被此标签标记的修订。
- adrcontinue
当更多结果可用时,使用这个继续。
- adrgeneratetitles
当作为生成器使用时,生成标题而不是修订ID。
- 类型:布尔值(详细信息)
- 列出由Example作出的最近50次已删除贡献。
- api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50 [在沙盒中打开]
- 列出前50次已删除的主名字空间修订。
- api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50 [在沙盒中打开]
list=allfileusages (af)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出所有文件用途,包括不存在的。
- afcontinue
当更多结果可用时,使用这个继续。
- affrom
要列举的起始文件标题。
- afto
要列举的最终文件标题。
- afprefix
搜索所有以此值开头的文件标题。
- afunique
只显示明显的文件标题。不能与afprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。
- 类型:布尔值(详细信息)
- afprop
要包含的信息束:
- ids
- 添加使用中的页面的页面ID(不能与afunique一起使用)。
- title
- 添加文件的标题。
- 值(以|或替代物分隔):ids,title
- 默认:title
- aflimit
要返回的总计项目。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- afdir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- 列举文件标题,包含丢失的文件、它们来自的页面ID,以B开头。
- api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title [在沙盒中打开]
- 列出唯一文件标题。
- api.php?action=query&list=allfileusages&afunique=&affrom=B [在沙盒中打开]
- 获取所有文件标题,并标记出缺失者。
- api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B [在沙盒中打开]
- 获取包含这些文件的页面。
- api.php?action=query&generator=allfileusages&gaffrom=B [在沙盒中打开]
list=allimages (ai)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
按顺序枚举所有图像。
- aisort
要作为排序方式的属性。
- 以下值中的一个:name,timestamp
- 默认:name
- aidir
罗列所采用的方向。
- 以下值中的一个:ascending,descending,newer,older
- 默认:ascending
- aifrom
要列举的起始图片标题。只能与aisort=name一起使用。
- aito
要列举的最终图片标题。只能与aisort=name一起使用。
- aicontinue
当更多结果可用时,使用这个继续。
- aistart
要列举的起始时间戳。只能与aisort=timestamp一起使用。
- 类型:时间戳(允许格式)
- aiend
要列举的最终时间戳。只能与aisort=timestamp一起使用。
- 类型:时间戳(允许格式)
- aiprop
要获取的文件信息:
- timestamp
- 添加时间戳至上传的版本。
- user
- 添加上传了每个文件版本的用户。
- userid
- 添加上传了每个文件版本的用户ID。
- comment
- 此版本的摘要。
- parsedcomment
- 解析版本上的注释。
- canonicaltitle
- 添加文件的规范标题。
- url
- 为文件及其描述页面提供URL。
- size
- 添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
- dimensions
- 用于大小的别名。
- sha1
- 为文件加入SHA-1哈希值。
- mime
- 添加文件的MIME类型。
- mediatype
- 添加文件媒体类型。
- metadata
- 列出这个版本的文件的EXIF元数据。
- commonmetadata
- 为文件的修订版本列出文件格式相关元数据。
- extmetadata
- 列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
- bitdepth
- 添加修订的字节深度。
- 值(以|或替代物分隔):timestamp,user,userid,comment,parsedcomment,canonicaltitle,url,size,dimensions,sha1,mime,mediatype,metadata,commonmetadata,extmetadata,bitdepth
- 默认:timestamp|url
- aiprefix
搜索所有以此值开头的图像标题。只能与aisort=name一起使用。
- aiminsize
限于至少这么多字节的图像。
- 类型:整数
- aimaxsize
限于顶多这么多字节的图像。
- 类型:整数
- aisha1
图像的 SHA1 哈希。覆盖aisha1base36。
- aisha1base36
基于base 36的图片的SHA1哈希值(用于MediaWiki)。
- aiuser
只返回此用户上传的文件。只能与aisort=timestamp一起使用。不能与aifilterbots一起使用。
- 类型:用户名
- aifilterbots
如何过滤由机器人上传的文件。只能与aisort=timestamp一起使用。不能与aiuser一起使用。
- 以下值中的一个:all,bots,nobots
- 默认:all
- aimime
要搜索的MIME类型,例如image/jpeg。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- ailimit
共计要返回多少图像。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- 显示以字母B开始的文件列表。
- api.php?action=query&list=allimages&aifrom=B [在沙盒中打开]
- 显示一个最近上传文件的列表,类似Special:NewFiles。
- api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older [在沙盒中打开]
- 显示带MIME类型image/png或image/gif的文件列表
- api.php?action=query&list=allimages&aimime=image/png|image/gif [在沙盒中打开]
- 显示有关4个以T开头的文件的信息。
- api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo [在沙盒中打开]
list=alllinks (al)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列举所有指向至指定名字空间的链接。
- alcontinue
当更多结果可用时,使用这个继续。
- alfrom
要列举的起始标题链接。
- alto
要列举的最终标题链接。
- alprefix
搜索所有以此值开头的已链接标题。
- alunique
只显示明显的链接标题。不能与alprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。
- 类型:布尔值(详细信息)
- alprop
要包含的信息束:
- ids
- 添加链接中的页面的页面ID(不能与alunique一起使用)。
- title
- 添加链接的标题。
- 值(以|或替代物分隔):ids,title
- 默认:title
- alnamespace
要列举的名字空间。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:0
- allimit
总共要返回多少个项目。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- aldir
列出方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- 列出链接的标题,包括丢失的,带它们来自的页面ID,以B开头。
- api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [在沙盒中打开]
- 列出唯一的链接标题。
- api.php?action=query&list=alllinks&alunique=&alfrom=B [在沙盒中打开]
- 获取所有已链接的标题,标记缺少的。
- api.php?action=query&generator=alllinks&galunique=&galfrom=B [在沙盒中打开]
- 获取包含这些链接的页面。
- api.php?action=query&generator=alllinks&galfrom=B [在沙盒中打开]
list=allpages (ap)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
循序列举在指定名字空间中的所有页面。
- apfrom
枚举的起始页面标题。
- apcontinue
当更多结果可用时,使用这个继续。
- apto
枚举的结束页面标题。
- apprefix
搜索所有以此值开头的页面标题。
- apnamespace
要列举的名字空间。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:0
- apfilterredir
要列出哪些页面。
- 以下值中的一个:all,redirects,nonredirects
- 默认:all
- apminsize
限于至少这么多字节的页面。
- 类型:整数
- apmaxsize
限于至多这么多字节的页面。
- 类型:整数
- apprtype
仅限于受保护页面。
- 值(以|或替代物分隔):edit,move,upload
- apprlevel
过滤基于保护等级的保护(必须与apprtype=参数一起使用)。
- 值(以|或替代物分隔):可以为空,或autoconfirmed,sysop
- apprfiltercascade
过滤基于cascadingness的保护(当apprtype未设置时忽略)。
- 以下值中的一个:cascading,noncascading,all
- 默认:all
- aplimit
返回的总计页面数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- apdir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- apfilterlanglinks
过滤基于页面是否有语言链接。注意这可能不考虑由扩展添加的语言链接。
- 以下值中的一个:withlanglinks,withoutlanglinks,all
- 默认:all
- apprexpiry
要在页面上过滤的保护期限:
- indefinite
- 只获取带无限期保护的页面。
- definite
- 只获取带指定保护期限的页面。
- all
- 获取任意保护期限的页面。
- 以下值中的一个:indefinite,definite,all
- 默认:all
- 显示以字母B开头的页面的列表。
- api.php?action=query&list=allpages&apfrom=B [在沙盒中打开]
- 显示有关4个以字母T开头的页面的信息。
- api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info [在沙盒中打开]
- 显示前2个以Re开头的非重定向页面的内容。
- api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content [在沙盒中打开]
list=allredirects (ar)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出至一个名字空间的重定向。
- arcontinue
当更多结果可用时,使用这个继续。
- arfrom
要列举的起始重定向标题。
- arto
要列举的最终重定向标题。
- arprefix
搜索所有以此值开头的目标页面。
- arunique
只显示明显的目标页面。不能与arprop=ids|fragment|interwiki一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。
- 类型:布尔值(详细信息)
- arprop
要包含的信息束:
- ids
- 添加重定向页面的页面ID(不能与arunique一起使用)。
- title
- 添加重定向的标题。
- fragment
- 添加来自重定向的碎片,如果有(不能与arunique一起使用)。
- interwiki
- 添加来自重定向的跨wiki前缀,如果有(不能与arunique一起使用)。
- 值(以|或替代物分隔):ids,title,fragment,interwiki
- 默认:title
- arnamespace
要列举的名字空间。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:0
- arlimit
返回的总计项目数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- ardir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- 列举目标页面,包含丢失的页面、它们来自的页面ID,以B开头。
- api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [在沙盒中打开]
- 列出孤立目标页面。
- api.php?action=query&list=allredirects&arunique=&arfrom=B [在沙盒中打开]
- 获取所有目标页面,标记丢失的。
- api.php?action=query&generator=allredirects&garunique=&garfrom=B [在沙盒中打开]
- 获取包含重定向的页面。
- api.php?action=query&generator=allredirects&garfrom=B [在沙盒中打开]
list=allrevisions (arv)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列举所有修订。
- arvprop
要为每个修订获取的属性:
- ids
- 修订ID。
- flags
- 修订标记(小编辑)。
- timestamp
- 修订的时间戳。
- user
- 做出修订的用户。
- userid
- 修订创建者的用户ID。
- size
- 修订的长度(字节)。
- sha1
- 修订的SHA-1(base 16)。
- contentmodel
- 修订的内容模型ID。
- comment
- 由用户对修订做出的摘要。
- parsedcomment
- 由用户对修订做出的被解析的摘要。
- content
- 修订文本。
- tags
- 修订标签。
- parsetree
- 修订内容的XML解析树(需要内容模型
wikitext
)。
- 值(以|或替代物分隔):ids,flags,timestamp,user,userid,size,sha1,contentmodel,comment,parsedcomment,content,tags,parsetree
- 默认:ids|timestamp|flags|comment|user
- arvlimit
限制返回多少修订。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- arvexpandtemplates
展开修订内容中的模板(需要arvprop=content)。
- 类型:布尔值(详细信息)
- arvgeneratexml
- 已弃用。
生成用于修订内容的XML解析树(需要arvprop=content;被arvprop=parsetree所取代)。
- 类型:布尔值(详细信息)
- arvparse
解析修订内容(需要arvprop=content)。由于性能原因,如果此选项被使用,arvlimit会被强制为1。
- 类型:布尔值(详细信息)
- arvsection
只检索此段落数的内容。
- arvdiffto
要比较修订差异的修订ID。使用prev、next和cur分别用于上个、下个和当前修订。
- arvdifftotext
要比较修订差异的文本。只有修订的有限数字内的差异。覆盖arvdiffto。如果arvsection被设置,只有那个段落将与此文本之间比较差异
- arvdifftotextpst
在编辑文本前对其执行预保存转换。只当与arvdifftotext一起使用时有效。
- 类型:布尔值(详细信息)
- arvcontentformat
序列化用于arvdifftotext的格式并预估内容输出。
- 以下值中的一个:text/x-wiki,text/javascript,application/json,text/css,text/plain
- arvuser
只列出此用户做出的修订。
- 类型:用户名
- arvnamespace
只列出此名字空间的页面。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- arvstart
枚举的起始时间戳。
- 类型:时间戳(允许格式)
- arvend
枚举的结束时间戳。
- 类型:时间戳(允许格式)
- arvdir
列举的方向:
- newer
- 最早的优先。注意:arvstart应早于arvend。
- older
- 最新的优先(默认)。注意:arvstart应晚于arvend。
- 以下值中的一个:newer,older
- 默认:older
- arvexcludeuser
不要列出此用户做出的修订。
- 类型:用户名
- arvcontinue
当更多结果可用时,使用这个继续。
- arvgeneratetitles
当作为生成器使用时,生成标题而不是修订ID。
- 类型:布尔值(详细信息)
- 列出由用户Example作出的最近50次贡献。
- api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [在沙盒中打开]
- 列举主名字空间中的前50次修订。
- api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [在沙盒中打开]
list=alltransclusions (at)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
- atcontinue
当更多结果可用时,使用这个继续。
- atfrom
要列举的起始嵌入标题。
- atto
要列举的最终嵌入标题。
- atprefix
搜索所有以此值开头的嵌入的标题。
- atunique
只显示明显的被嵌入标题。不能与atprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。
- 类型:布尔值(详细信息)
- atprop
要包含的信息束:
- ids
- 添加嵌入中的页面的页面ID(不能与atunique一起使用)。
- title
- 添加嵌入的标题。
- 值(以|或替代物分隔):ids,title
- 默认:title
- atnamespace
要列举的名字空间。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:10
- atlimit
要返回的总计项目。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- atdir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- 列出嵌入的标题,包括丢失的,带有来自的页面ID,从B开始。
- api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [在沙盒中打开]
- 列出孤立嵌入标题
- api.php?action=query&list=alltransclusions&atunique=&atfrom=B [在沙盒中打开]
- 获取所有嵌入的标题,并标记缺失的。
- api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [在沙盒中打开]
- 获得包含嵌入内容的页面。
- api.php?action=query&generator=alltransclusions&gatfrom=B [在沙盒中打开]
list=allusers (au)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列举所有注册用户。
- aufrom
枚举的起始用户名。
- auto
枚举的结束用户名。
- auprefix
搜索所有以此值开头的用户。
- audir
排序方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- augroup
只包含指定组中的用户。
- 值(以|或替代物分隔):bot,sysop,bureaucrat
- auexcludegroup
排除指定组中的用户。
- 值(以|或替代物分隔):bot,sysop,bureaucrat
- aurights
仅列出有所选权限的用户。不包括隐性的或自动加入的用户组别(如*、用户或自动确认用户)所授予的权限。
- 值(以|或替代物分隔):apihighlimits,applychangetags,autoconfirmed,autocreateaccount,autopatrol,bigdelete,block,blockemail,bot,browsearchive,changetags,createaccount,createpage,createtalk,delete,deletechangetags,deletedhistory,deletedtext,deletelogentry,deleterevision,edit,editcontentmodel,editinterface,editprotected,editmyoptions,editmyprivateinfo,editmyusercss,editmyuserjs,editmywatchlist,editsemiprotected,editusercssjs,editusercss,edituserjs,hideuser,import,importupload,ipblock-exempt,managechangetags,markbotedits,mergehistory,minoredit,move,movefile,move-categorypages,move-rootuserpages,move-subpages,nominornewtalk,noratelimit,override-export-depth,pagelang,passwordreset,patrol,patrolmarks,protect,purge,read,reupload,reupload-own,reupload-shared,rollback,sendemail,siteadmin,suppressionlog,suppressredirect,suppressrevision,unblockself,undelete,unwatchedpages,upload,upload_by_url,userrights,userrights-interwiki,viewmyprivateinfo,viewmywatchlist,viewsuppressed,writeapi,skipcaptcha,mf-uploadbutton
- 值的最高数字是50(对于机器人则是500)。
- auprop
要包含的信息束:
- blockinfo
- 添加有关用户当前封禁的信息。
- groups
- 列举用户所在的组。这使用更多服务器资源,并可能返回少于限制的结果。
- implicitgroups
- 列出用户自动属于的所有组。
- rights
- 用户拥有的权限列表。
- editcount
- 添加用户的编辑计数。
- registration
- 如果可能,添加用户注册时的时间戳(可能为空白)。
- centralids
- 添加中心ID并为用户附加状态。
- 值(以|或替代物分隔):blockinfo,groups,implicitgroups,rights,editcount,registration,centralids
- aulimit
返回的总计用户数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- auwitheditsonly
只列出有编辑的用户。
- 类型:布尔值(详细信息)
- auactiveusers
只列出最近30天内活跃的用户。
- 类型:布尔值(详细信息)
- auattachedwiki
与auprop=centralids一起使用,也表明用户是否附加于此ID定义的wiki。
list=backlinks (bl)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
查找所有链接至指定页面的页面。
- bltitle
要搜索的标题。不能与blpageid一起使用。
- blpageid
要搜索的页面ID。不能与bltitle一起使用。
- 类型:整数
- blcontinue
当更多结果可用时,使用这个继续。
- blnamespace
要列举的名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- bldir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- blfilterredir
如何过滤重定向。当blredirect被启用时如果设置为nonredirects,这只会应用到第二级。
- 以下值中的一个:all,redirects,nonredirects
- 默认:all
- bllimit
返回总计页面数。如果blredirect被启用,则限定分别适用于每一等级(这意味着将返回多达2 * bllimit个结果)。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- blredirect
如果链入页面是一个重定向,则寻找所有链接至此重定向的页面。最大限制减半。
- 类型:布尔值(详细信息)
- 显示至Main page的链接。
- api.php?action=query&list=backlinks&bltitle=Main%20Page [在沙盒中打开]
- 获取关于链接至Main page的页面的信息。
- api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info [在沙盒中打开]
list=blocks (bk)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出所有被封禁的用户和IP地址。
- bkstart
枚举的起始时间戳。
- 类型:时间戳(允许格式)
- bkend
枚举的结束时间戳。
- 类型:时间戳(允许格式)
- bkdir
列举的方向:
- newer
- 最早的优先。注意:bkstart应早于bkend。
- older
- 最新的优先(默认)。注意:bkstart应晚于bkend。
- 以下值中的一个:newer,older
- 默认:older
- bkids
要列出的封禁ID列表(可选)。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- bkusers
要搜索的用户列表(可选)。
- 类型:用户名列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- bkip
获取应用到此IP地址或者CIDR范围的所有封禁,包括范围封禁。不能与bkusers一起使用。CIDR范围不允许比IPv4/16或IPv6/19更宽。
- bklimit
封禁列表的最大数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- bkprop
要获取的属性:
- id
- 添加封禁ID。
- user
- 添加被封禁用户的用户名。
- userid
- 添加被封禁用户的用户ID。
- by
- 添加执行封禁的用户的用户名。
- byid
- 添加执行封禁的用户的用户ID。
- timestamp
- 添加封禁生效时的时间戳。
- expiry
- 添加封禁截止时的时间戳。
- reason
- 添加封禁原因。
- range
- 添加受封禁影响的IP地址段。
- flags
- 标记编辑禁止(自动封禁、仅限匿名用户等)。
- 值(以|或替代物分隔):id,user,userid,by,byid,timestamp,expiry,reason,range,flags
- 默认:id|user|by|timestamp|expiry|reason|flags
- bkshow
只显示符合这些标准的项目。 例如,要只查看IP地址的无限期封禁,设置bkshow=ip|!temp。
- 值(以|或替代物分隔):account,!account,temp,!temp,ip,!ip,range,!range
- bkcontinue
当更多结果可用时,使用这个继续。
list=categorymembers (cm)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
在指定的分类中列出所有页面。
- cmtitle
要列举的分类(必需)。必须包括分类:前缀。不能与cmpageid一起使用。
- cmpageid
要枚举的分类的页面 ID。不能与cmtitle一起使用。
- 类型:整数
- cmprop
要包含的信息束:
- ids
- 添加页面ID。
- title
- 添加页面标题和名字空间ID。
- sortkey
- 添加用于分类中排序的关键字(十六进制字符串)。
- sortkeyprefix
- 添加用于分类中排序的关键字前缀(关键字的人类可读部分)。
- type
- 添加页面被分类的类型(page、subcat或file)。
- timestamp
- 添加页面被包括时的时间戳。
- 值(以|或替代物分隔):ids,title,sortkey,sortkeyprefix,type,timestamp
- 默认:ids|title
- cmnamespace
仅包含这些名字空间的页面。注意cmtype=subcat或cmtype=file可能被使用,而不是cmnamespace=14或6。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- cmtype
包含的分类成员类型。当cmsort=timestamp被设置时会忽略。
- 值(以|或替代物分隔):page,subcat,file
- 默认:page|subcat|file
- cmcontinue
当更多结果可用时,使用这个继续。
- cmlimit
返回页面的最大数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- cmsort
要作为排序方式的属性。
- 以下值中的一个:sortkey,timestamp
- 默认:sortkey
- cmdir
排序的方向。
- 以下值中的一个:asc,desc,ascending,descending,newer,older
- 默认:ascending
- cmstart
开始列举的时间戳。只能与cmsort=timestamp一起使用。
- 类型:时间戳(允许格式)
- cmend
列举的结尾时间戳。只能与cmsort=timestamp一起使用。
- 类型:时间戳(允许格式)
- cmstarthexsortkey
开始列举的关键词,由cmprop=sortkey返回。不能与cmsort=sortkey一起使用。
- cmendhexsortkey
结束列举的关键字,由cmprop=sortkey返回。只能与cmsort=sortkey一起使用。
- cmstartsortkeyprefix
要开始列举的排序关键词前缀。只能与cmsort=sortkey一起使用。覆盖cmstarthexsortkey。
- cmendsortkeyprefix
要结束列举before的关键字前缀(而不是at;如果此值出现,它将不被包括!)只能与cmsort=sortkey一起使用。覆盖cmendhexsortkey。
- cmstartsortkey
- 已弃用。
请改用cmstarthexsortkey。
- cmendsortkey
- 已弃用。
请改用cmendhexsortkey。
- 获取Category:Physics中的前10个页面。
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics [在沙盒中打开]
- 获取有关Category:Physics中的前10个页面的页面信息。
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [在沙盒中打开]
list=deletedrevs (dr)
- 此模块已弃用。
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出被删除修订。
操作于三种模式中:
- 为指定标题列举已删除修订,按时间戳排列。
- 为指定用户列举已删除贡献,按时间戳排列(未指定标题)。
- 在指定名字空间中列举所有已删除修订,按标题和时间戳排列(无指定标题,未设置druser)。
任一参数只应用于一些模式,并忽略其他参数。
- drstart
枚举的起始时间戳。
- 模式:1,2
- 类型:时间戳(允许格式)
- drend
枚举的结束时间戳。
- 模式:1,2
- 类型:时间戳(允许格式)
- drdir
列举的方向:
- newer
- 最早的优先。注意:drstart应早于drend。
- older
- 最新的优先(默认)。注意:drstart应晚于drend。
- 模式:1,3
- 以下值中的一个:newer,older
- 默认:older
- drfrom
从此标题开始列出。
- 模式:3
- drto
列出至此标题为止。
- 模式:3
- drprefix
搜索所有以此值开头的页面标题。
- 模式:3
- drunique
每个页面只列出一个修订。
- 模式:3
- 类型:布尔值(详细信息)
- drnamespace
只列出此名字空间的页面。
- 模式:3
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:0
- drtag
只列出被此标签标记的修订。
- druser
只列出此用户做出的修订。
- 类型:用户名
- drexcludeuser
不要列出此用户做出的修订。
- 类型:用户名
- drprop
要获取的属性:
- revid
- 添加被删除修订的修订ID。
- parentid
- 添加上一修订的修订ID至页面。
- user
- 添加做出修订的用户。
- userid
- 添加做出修订的用户ID。
- comment
- 添加修订摘要。
- parsedcomment
- 添加解析过的修订摘要。
- minor
- 如果修订是小编辑则加标签。
- len
- 添加修订长度(字节)。
- sha1
- 添加修订的SHA-1(base 16)。
- content
- 添加修订内容。
- token
- 已弃用。提供编辑令牌。
- tags
- 修订标签。
- 值(以|或替代物分隔):revid,parentid,user,userid,comment,parsedcomment,minor,len,sha1,content,token,tags
- 默认:user|comment
- drlimit
要列出的最大修订数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- drcontinue
当更多结果可用时,使用这个继续。
- 列出最近已删除的对页面Main Page和Talk:Main Page的贡献,带内容(模式1)。
- api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [在沙盒中打开]
- 列出由Bob作出的最近50次已删除贡献(模式2)。
- api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [在沙盒中打开]
- 列出前50次主名字空间已删除贡献(模式3)。
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [在沙盒中打开]
- 列出前50次讨论名字空间已删除页面(模式3)。
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [在沙盒中打开]
list=embeddedin (ei)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
查找所有嵌入指定标题的页面。
- eititle
要搜索的标题。不能与eipageid一起使用。
- eipageid
要搜索的页面ID。不能与eititle一起使用。
- 类型:整数
- eicontinue
当更多结果可用时,使用这个继续。
- einamespace
列举的名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- eidir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- eifilterredir
如何过滤重定向。
- 以下值中的一个:all,redirects,nonredirects
- 默认:all
- eilimit
返回的总计页面数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- 显示嵌入Template:Stub的页面。
- api.php?action=query&list=embeddedin&eititle=Template:Stub [在沙盒中打开]
- 获取有关显示嵌入Template:Stub的页面的信息。
- api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info [在沙盒中打开]
list=exturlusage (eu)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列举包含一个指定URL的页面。
- euprop
要包含的信息束:
- ids
- 添加页面ID。
- title
- 添加页面的标题和名字空间ID。
- url
- 添加页面中使用的URL。
- 值(以|或替代物分隔):ids,title,url
- 默认:ids|title|url
- euoffset
当更多结果可用时,使用这个继续。
- 类型:整数
- euprotocol
URL协议。如果为空并且euquery被设置,协议为http。将此和euquery都留空以列举所有外部链接。
- 以下值中的一个:可以为空,或bitcoin,ftp,ftps,geo,git,gopher,http,https,irc,ircs,magnet,mailto,mms,news,nntp,redis,sftp,sip,sips,sms,ssh,svn,tel,telnet,urn,worldwind,xmpp
- 默认:(空)
- euquery
不包括协议的搜索字符串。参见Special:LinkSearch。留空以列出所有外部链接。
- eunamespace
要列举的页面名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- eulimit
返回多少页面。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- euexpandurl
用标准协议展开协议相关URL。
- 类型:布尔值(详细信息)
list=filearchive (fa)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
循序列举所有被删除的文件。
- fafrom
枚举的起始图片标题。
- fato
枚举的结束图片标题。
- faprefix
搜索所有以此值开头的图像标题。
- fadir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- fasha1
图片的SHA1哈希值。覆盖fasha1base36。
- fasha1base36
基于base 36的图片的SHA1哈希值(用于MediaWiki)。
- faprop
要获取的图片信息:
- sha1
- 为文件加入SHA-1哈希值。
- timestamp
- 为已上传版本添加时间戳。
- user
- 添加上传了图片版本的用户。
- size
- 添加图片大小(字节)及其高度、宽度和页面计数(如果可以)。
- dimensions
- 用于大小的别名。
- description
- 添加图片版本的说明。
- parseddescription
- 解析版本的描述。
- mime
- 添加图片的MIME。
- mediatype
- 添加图片的媒体类型。
- metadata
- 为图片版本列出Exif元数据。
- bitdepth
- 添加版本的字节深度。
- archivename
- 添加用于非最新版本的存档版本的文件名。
- 值(以|或替代物分隔):sha1,timestamp,user,size,dimensions,description,parseddescription,mime,mediatype,metadata,bitdepth,archivename
- 默认:timestamp
- falimit
返回图像的总数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- facontinue
当更多结果可用时,使用这个继续。
list=imageusage (iu)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
查找所有使用指定图片标题的页面。
- iutitle
要搜索的标题。不能与iupageid一起使用。
- iupageid
要搜索的页面ID。不能与iutitle一起使用。
- 类型:整数
- iucontinue
当更多结果可用时,使用这个继续。
- iunamespace
要列举的名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- iudir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- iufilterredir
如何过滤重定向。当iuredirect被启用时如果设置为nonredirects,这只会应用到第二级。
- 以下值中的一个:all,redirects,nonredirects
- 默认:all
- iulimit
返回总计页面数。如果iuredirect被启用,则限定分别适用于每一等级(这意味着将返回多达2 * iulimit个结果)。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- iuredirect
如果链接页面是重定向,则查找所有链接至该重定向的页面。最大限制减半。
- 类型:布尔值(详细信息)
list=iwbacklinks (iwbl)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
查找所有链接至指定跨wiki链接的页面。
可被用于查找带某一前缀的所有链接,或所有至某一标题的链接(带指定前缀)。两参数都不使用就意味着“所有跨wiki链接”。
- iwblprefix
跨维基前缀。
- iwbltitle
要搜索的跨wiki链接。必须与iwblblprefix一起使用。
- iwblcontinue
当更多结果可用时,使用这个继续。
- iwbllimit
返回的总计页面数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- iwblprop
要获取的属性:
- iwprefix
- 加入跨wiki前缀。
- iwtitle
- 加入跨wiki标题。
- 值(以|或替代物分隔):iwprefix,iwtitle
- 默认:(空)
- iwbldir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
list=langbacklinks (lbl)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
发现所有链接至指定语言链接的页面。
可被用于查找所有带某一语言代码的链接,或所有至某一标题的链接(带指定语言)。不使用任何参数就意味着“所有语言链接”。
注意这可能不考虑由扩展添加的语言链接。
- lbllang
用于语言链接的语言。
- lbltitle
要搜索的语言链接。必须与lbllang一起使用。
- lblcontinue
当更多结果可用时,使用这个继续。
- lbllimit
返回的总计页面数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- lblprop
要获得的属性:
- lllang
- 添加语言链接的语言代码。
- lltitle
- 添加语言链接的标题。
- 值(以|或替代物分隔):lllang,lltitle
- 默认:(空)
- lbldir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
list=logevents (le)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从日志获取事件。
- leprop
要获取的属性:
- ids
- 添加日志活动的ID。
- title
- 为日志事件添加页面标题。
- type
- 添加日志活动的类型。
- user
- 添加对此日志事件负责的用户。
- userid
- 添加对此日志事件负责的用户的ID。
- timestamp
- 为日志活动添加时间戳。
- comment
- 添加日志活动的摘要。
- parsedcomment
- 添加被解析的日志活动的摘要。
- details
- 列举有关日志事件的额外详细信息。
- tags
- 列举用于日志活动的标签。
- 值(以|或替代物分隔):ids,title,type,user,userid,timestamp,comment,parsedcomment,details,tags
- 默认:ids|title|type|user|timestamp|comment|details
- letype
过滤日志记录至仅限此类型。
- 以下值中的一个:可以为空,或block,protect,rights,delete,upload,move,import,patrol,merge,suppress,tag,managetags,contentmodel,newusers
- leaction
过滤日志操作为仅限此操作。覆盖letype。在可用值列表中,带星号通配符的值例如action/*可在斜线(/)后拥有不同字符串。
- 以下值中的一个:block/block,block/reblock,block/unblock,contentmodel/change,contentmodel/new,delete/delete,delete/delete_redir,delete/event,delete/restore,delete/revision,import/interwiki,import/upload,managetags/activate,managetags/create,managetags/deactivate,managetags/delete,merge/merge,move/move,move/move_redir,patrol/patrol,patrol/autopatrol,protect/modify,protect/move_prot,protect/protect,protect/unprotect,rights/autopromote,rights/rights,suppress/block,suppress/delete,suppress/event,suppress/reblock,suppress/revision,tag/update,upload/overwrite,upload/revert,upload/upload,newusers/newusers,newusers/create,newusers/create2,newusers/byemail,newusers/autocreate
- lestart
枚举的起始时间戳。
- 类型:时间戳(允许格式)
- leend
枚举的结束时间戳。
- 类型:时间戳(允许格式)
- ledir
列举的方向:
- newer
- 最早的优先。注意:lestart应早于leend。
- older
- 最新的优先(默认)。注意:lestart应晚于leend。
- 以下值中的一个:newer,older
- 默认:older
- leuser
过滤记录为这些由指定用户做出的。
- 类型:用户名
- letitle
过滤记录至这些与页面相关的。
- lenamespace
过滤事件为在这些指定的名字空间中。
- 以下值中的一个:0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- leprefix
过滤以此前缀开头的记录。
- letag
只列举带此标签的事件日志记录。
- lelimit
返回的事件日志记录总数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- lecontinue
当更多结果可用时,使用这个继续。
list=mystashedfiles (msf)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取当前用户上传暂存库中的文件列表。
- msfprop
要检索文件的属性。
- size
- 检索文件大小和图片尺寸。
- type
- 检索文件的MIME类型和媒体类型。
- 值(以|或替代物分隔):size,type
- 默认:(空)
- msflimit
要获取文件的数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- msfcontinue
当更多结果可用时,使用这个继续。
- 获取当前用户上传暂存库中的文件的filekey、大小和像素尺寸。
- api.php?action=query&list=mystashedfiles&msfprop=size [在沙盒中打开]
list=pagepropnames (ppn)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出wiki中所有使用中的页面属性名称。
- ppncontinue
当更多结果可用时,使用这个继续。
- ppnlimit
返回名称的最大数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- 获取前10个属性名称。
- api.php?action=query&list=pagepropnames [在沙盒中打开]
list=pageswithprop (pwp)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出所有使用指定页面属性的页面。
- pwppropname
要用于列举页面的页面属性(action=query&list=pagepropnames返回正在使用中的页面属性名称)。
- 这个参数是必须的。
- pwpprop
要包含的信息束:
- ids
- 添加页面ID。
- title
- 添加页面的标题和名字空间ID。
- value
- 添加页面属性值。
- 值(以|或替代物分隔):ids,title,value
- 默认:ids|title
- pwpcontinue
当更多结果可用时,使用这个继续。
- pwplimit
返回页面的最大数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- pwpdir
排序的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- 列出前10个使用
{{DISPLAYTITLE:}}
的页面。 - api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [在沙盒中打开]
- 获取有关前10个使用
__NOTOC__
的页面的额外信息。 - api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [在沙盒中打开]
list=prefixsearch (ps)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
执行页面标题的带前缀搜索。
尽管名称类似,但此模块不等于Special:PrefixIndex;详见action=query&list=allpages中的apprefix参数。此模块的目的类似action=opensearch:基于用户的输入提供最佳匹配的标题。取决于搜索引擎后端,这可能包括错拼纠正、避免重定向和其他启发性行为。
- pssearch
搜索字符串。
- 这个参数是必须的。
- psnamespace
搜索的名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:0
- pslimit
要返回的结果最大数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- psoffset
当更多结果可用时,使用这个继续。
- 类型:整数
- 默认:0
- 搜索以meaning开头的页面标题。
- api.php?action=query&list=prefixsearch&pssearch=meaning [在沙盒中打开]
list=protectedtitles (pt)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出所有被限制创建的标题。
- ptnamespace
只列出这些名字空间的标题。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- ptlevel
只列出带这些保护级别的标题。
- 值(以|或替代物分隔):autoconfirmed,sysop
- ptlimit
返回的总计页面数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- ptdir
列举的方向:
- newer
- 最早的优先。注意:ptstart应早于ptend。
- older
- 最新的优先(默认)。注意:ptstart应晚于ptend。
- 以下值中的一个:newer,older
- 默认:older
- ptstart
从此保护时间戳开始列举。
- 类型:时间戳(允许格式)
- ptend
列举至此保护时间戳为止。
- 类型:时间戳(允许格式)
- ptprop
要获取的属性:
- timestamp
- 添加保护被添加时的时间戳。
- user
- 添加对页面添加保护的用户。
- userid
- 添加对页面添加保护的用户ID。
- comment
- 为保护添加摘要。
- parsedcomment
- 为保护添加解析的摘要。
- expiry
- 添加保护将被提升时的时间戳。
- level
- 添加保护级别。
- 值(以|或替代物分隔):timestamp,user,userid,comment,parsedcomment,expiry,level
- 默认:timestamp|level
- ptcontinue
当更多结果可用时,使用这个继续。
list=querypage (qp)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取由基于QueryPage的特殊页面提供的列表。
- qppage
特殊页面的名称。注意其区分大小写。
- 这个参数是必须的。
- 以下值中的一个:Ancientpages,BrokenRedirects,Deadendpages,DoubleRedirects,ListDuplicatedFiles,Listredirects,Lonelypages,Longpages,MediaStatistics,Mostcategories,Mostimages,Mostinterwikis,Mostlinkedcategories,Mostlinkedtemplates,Mostlinked,Mostrevisions,Fewestrevisions,Shortpages,Uncategorizedcategories,Uncategorizedpages,Uncategorizedimages,Uncategorizedtemplates,Unusedcategories,Unusedimages,Wantedcategories,Wantedfiles,Wantedpages,Wantedtemplates,Unwatchedpages,Unusedtemplates,Withoutinterwiki
- qpoffset
当更多结果可用时,使用这个继续。
- 类型:整数
- 默认:0
- qplimit
返回的结果数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
list=random (rn)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取一组随机页面。
页面列举在一个固定序列中,只有起始点是随机的。这意味着如果Main Page是列表中第一个随机页面的话,List of fictional monkeys将总是第二个,List of people on stamps of Vanuatu是第三个等。
- 从主名字空间返回两个随机页面。
- api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [在沙盒中打开]
- 返回有关来自主名字空间的两个随机页面的页面信息。
- api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [在沙盒中打开]
list=recentchanges (rc)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列举最近更改。
- rcstart
枚举的起始时间戳。
- 类型:时间戳(允许格式)
- rcend
枚举的结束时间戳。
- 类型:时间戳(允许格式)
- rcdir
列举的方向:
- newer
- 最早的优先。注意:rcstart应早于rcend。
- older
- 最新的优先(默认)。注意:rcstart应晚于rcend。
- 以下值中的一个:newer,older
- 默认:older
- rcnamespace
过滤更改为仅限这些名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- rcuser
只列出此用户的更改。
- 类型:用户名
- rcexcludeuser
不要列出此用户的更改。
- 类型:用户名
- rctag
只列出带此标签的更改。
- rcprop
包含的额外信息束:
- user
- 添加造成编辑的用户,并标出它们是否是IP。
- userid
- 为编辑添加用户ID责任。
- comment
- 为编辑添加摘要。
- parsedcomment
- 为编辑添加解析的摘要。
- flags
- 为编辑添加标记。
- timestamp
- 添加编辑的时间戳。
- title
- 添加编辑的页面标题。
- ids
- 添加页面ID、最近更改ID和新旧修订的ID。
- sizes
- 添加新旧页面长度(字节)。
- redirect
- 如果页面是重定向的话,标记编辑。
- patrolled
- 将可巡查编辑标记为已巡查或未巡查。
- loginfo
- 添加日志信息(日志ID、日志类型等)至日志记录。
- tags
- 列举条目的标签。
- sha1
- Adds the content checksum for entries associated with a revision.
- 值(以|或替代物分隔):user,userid,comment,parsedcomment,flags,timestamp,title,ids,sizes,redirect,patrolled,loginfo,tags,sha1
- 默认:title|timestamp|ids
- rctoken
- 已弃用。
- 值(以|或替代物分隔):patrol
- rcshow
只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置rcshow=minor|!anon。
- 值(以|或替代物分隔):minor,!minor,bot,!bot,anon,!anon,redirect,!redirect,patrolled,!patrolled,unpatrolled
- rclimit
返回总计更新数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- rctype
显示的更改类型。
- 值(以|或替代物分隔):edit,new,log,external,categorize
- 默认:edit|new|log|categorize
- rctoponly
只列举作为最新修订的更改。
- 类型:布尔值(详细信息)
- rccontinue
当更多结果可用时,使用这个继续。
- rcgeneraterevisions
当作为生成器使用时,生成修订ID而不是标题。不带关联修订ID的最近更改记录(例如大多数日志记录)将不会生成任何东西。
- 类型:布尔值(详细信息)
list=search (sr)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
执行一次全文本搜索。
- srsearch
搜索所有匹配此值的页面标题或内容。根据wiki的搜索后端工具,您可以使用搜索字符串以调用特殊搜索功能。
- 这个参数是必须的。
- srnamespace
只在这些名字空间搜索。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- 默认:0
- srlimit
返回的总计页面数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- sroffset
当更多结果可用时,使用这个继续。
- 类型:整数
- 默认:0
- srwhat
要执行的搜索类型。
- 以下值中的一个:title,text,nearmatch
- srinfo
要返回的元数据。
- 值(以|或替代物分隔):totalhits,suggestion,rewrittenquery
- 默认:totalhits|suggestion|rewrittenquery
- srprop
要返回的属性:
- size
- 添加页面大小,单位为字节。
- wordcount
- 添加页面的字数。
- timestamp
- 添加页面上次编辑时的时间戳。
- snippet
- Adds a parsed snippet of the page.
- titlesnippet
- Adds a parsed snippet of the page title.
- redirecttitle
- 添加匹配的重定向的标题。
- redirectsnippet
- 添加被解析的重定向标题的片段。
- sectiontitle
- Adds the title of the matching section.
- sectionsnippet
- Adds a parsed snippet of the matching section title.
- isfilematch
- 添加布尔值,表明搜索是否匹配文件内容。
- categorysnippet
- Adds a parsed snippet of the matching category.
- score
- 已弃用并已忽略。
- hasrelated
- 已弃用并已忽略。
- 值(以|或替代物分隔):size,wordcount,timestamp,snippet,titlesnippet,redirecttitle,redirectsnippet,sectiontitle,sectionsnippet,isfilematch,categorysnippet,score,hasrelated
- 默认:size|wordcount|timestamp|snippet
- srinterwiki
搜索结果中包含跨wiki结果,如果可用。
- 类型:布尔值(详细信息)
- srenablerewrites
启用内部查询重写。一些搜索后端可以重写查询到它认为会给出更好结果的地方,例如纠正拼写错误。
- 类型:布尔值(详细信息)
list=tags (tg)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
列出更改标签。
- tgcontinue
当更多结果可用时,使用这个继续。
- tglimit
列出标签的最大数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- tgprop
要获取哪个属性:
- name
- 添加标签名称。
- displayname
- 为标签添加系统消息。
- description
- 为标签添加描述。
- hitcount
- 已添加此标签的修订版本与日志数量。
- defined
- 标识标签是否已定义。
- source
- 获得标签来源,它可能包括用于扩展定义的标签的extension,以及用于可被用户手动应用的标签的manual。
- active
- 标签是否仍可被应用。
- 值(以|或替代物分隔):name,displayname,description,hitcount,defined,source,active
- 默认:name
list=usercontribs (uc)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取一位用户的所有编辑。
- uclimit
返回贡献的最大数量。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- ucstart
返回的起始时间戳。
- 类型:时间戳(允许格式)
- ucend
返回的最终时间戳。
- 类型:时间戳(允许格式)
- uccontinue
当更多结果可用时,使用这个继续。
- ucuser
要检索贡献的用户。
- 类型:用户名列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- ucuserprefix
取得所有用户名以这个值开头的用户的贡献。覆盖ucuser。
- ucdir
列举的方向:
- newer
- 最早的优先。注意:ucstart应早于ucend。
- older
- 最新的优先(默认)。注意:ucstart应晚于ucend。
- 以下值中的一个:newer,older
- 默认:older
- ucnamespace
只列出这些名字空间的贡献。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- ucprop
包含额外的信息束:
- ids
- 添加页面ID和修订ID。
- title
- 添加页面标题及其名字空间ID。
- timestamp
- 添加编辑的时间戳。
- comment
- 添加编辑摘要。
- parsedcomment
- 添加被解析的编辑摘要。
- size
- 添加编辑的新大小。
- sizediff
- 添加与父编辑相比该编辑的大小变化。
- flags
- 添加编辑标记。
- patrolled
- 标记已巡查编辑。
- tags
- 列举用于编辑的标签。
- 值(以|或替代物分隔):ids,title,timestamp,comment,parsedcomment,size,sizediff,flags,patrolled,tags
- 默认:ids|title|timestamp|comment|size|flags
- ucshow
只显示符合这些标准的项目,例如只显示不是小编辑的编辑:ucshow=!minor。
如果ucshow=patrolled或ucshow=!patrolled被设定,早于$wgRCMaxAge(7776000秒)的修订不会被显示。
- 值(以|或替代物分隔):minor,!minor,patrolled,!patrolled,top,!top,new,!new
- uctag
只列出被此标签标记的修订。
- uctoponly
- 已弃用。
只列举作为最新修订的更改。
- 类型:布尔值(详细信息)
- 显示用户Example的贡献。
- api.php?action=query&list=usercontribs&ucuser=Example [在沙盒中打开]
- 显示来自192.0.2.前缀所有 IP 地址的贡献。
- api.php?action=query&list=usercontribs&ucuserprefix=192.0.2. [在沙盒中打开]
list=users (us)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取有关列出用户的信息。
- usprop
要包含的信息束:
- blockinfo
- 如果用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
- groups
- 列举每位用户属于的所有组。
- implicitgroups
- Lists all the groups a user is automatically a member of.
- rights
- 列举每位用户拥有的所有权限。
- editcount
- 添加用户的编辑计数。
- registration
- 添加用户的注册时间戳。
- emailable
- Tags if the user can and wants to receive email through Special:Emailuser.
- gender
- 标记用户性别。返回“male”、“female”或“unknown”。
- centralids
- 添加中心ID并为用户附加状态。
- cancreate
- 表明是否可以为有效但尚未注册的用户名创建一个账户。
- 值(以|或替代物分隔):blockinfo,groups,implicitgroups,rights,editcount,registration,emailable,gender,centralids,cancreate
- usattachedwiki
与usprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。
- ususers
要获取信息的用户列表。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- ustoken
- 已弃用。
- 值(以|或替代物分隔):userrights
list=watchlist (wl)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
在当前用户的监视列表中获取对页面的最近更改。
- wlallrev
将同一页面的多个修订包含于指定的时间表内。
- 类型:布尔值(详细信息)
- wlstart
枚举的起始时间戳。
- 类型:时间戳(允许格式)
- wlend
枚举的结束时间戳。
- 类型:时间戳(允许格式)
- wlnamespace
过滤更改为仅限指定的名字空间。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- wluser
只列出此用户的更改。
- 类型:用户名
- wlexcludeuser
不要列出此用户的更改。
- 类型:用户名
- wldir
列举的方向:
- newer
- 最早的优先。注意:wlstart应早于wlend。
- older
- 最新的优先(默认)。注意:wlstart应晚于wlend。
- 以下值中的一个:newer,older
- 默认:older
- wllimit
根据结果返回的结果总数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- wlprop
要获取的额外属性:
- ids
- 添加修订ID和页面ID。
- title
- 添加页面标题。
- flags
- 为编辑添加标记。
- user
- 添加做出编辑的用户。
- userid
- 添加做出编辑的用户的ID。
- comment
- 添加编辑摘要。
- parsedcomment
- 添加解析过的编辑摘要。
- timestamp
- 添加编辑时间戳。
- patrol
- 将编辑标记为已巡查。
- sizes
- 添加页面的旧有长度和新长度。
- notificationtimestamp
- 添加最近被通知有关编辑的用户的时间戳。
- loginfo
- 在适当位置添加日志信息。
- 值(以|或替代物分隔):ids,title,flags,user,userid,comment,parsedcomment,timestamp,patrol,sizes,notificationtimestamp,loginfo
- 默认:ids|title|flags
- wlshow
只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置wlshow=minor|!anon。
- 值(以|或替代物分隔):minor,!minor,bot,!bot,anon,!anon,patrolled,!patrolled,unread,!unread
- wltype
要显示的更改类型:
- edit
- 普通页面编辑。
- new
- 页面创建。
- log
- 日志记录。
- external
- 外部更改。
- categorize
- 分类成员组更改。
- 值(以|或替代物分隔):edit,new,log,external,categorize
- 默认:edit|new|log|categorize
- wlowner
与wltoken一起使用以访问不同用户的监视列表。
- 类型:用户名
- wltoken
允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。
- wlcontinue
当更多结果可用时,使用这个继续。
- 在当前用户的监视列表中列出用于最近更改页面的最新修订。
- api.php?action=query&list=watchlist [在沙盒中打开]
- 在当前用户的监视列表中检索有关用于最近更改页面的最新修订的额外信息。
- api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [在沙盒中打开]
- 在当前用户的监视列表中检索有关所有最近对页面的更改的信息。
- api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [在沙盒中打开]
- 在当前用户的监视列表中检索用于最近更改页面的页面信息。
- api.php?action=query&generator=watchlist&prop=info [在沙盒中打开]
- 在当前用户的监视列表中检索用于对页面最近更改的修订信息。
- api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [在沙盒中打开]
- 在用户Example的监视列表中列出用于最近更改页面的最新修订。
- api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [在沙盒中打开]
list=watchlistraw (wr)
- 此模块需要读取权限。
- 此模块可作为发生器使用。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获得当前用户的监视列表上的所有页面。
- wrcontinue
当更多结果可用时,使用这个继续。
- wrnamespace
只列出指定名字空间的页面。
- 值(以|或替代物分隔):0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
- wrlimit
根据结果返回的结果总数。
- 不允许超过500个(对于机器人则是5,000个)。
- 类型:整数或max
- 默认:10
- wrprop
要获取的额外属性:
- changed
- 添加最近被通知有关编辑的用户的时间戳。
- 值(以|或替代物分隔):changed
- wrshow
只列出符合这些标准的项目。
- 值(以|或替代物分隔):changed,!changed
- wrowner
与wrtoken一起使用以访问不同用户的监视列表。
- 类型:用户名
- wrtoken
允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。
- wrdir
罗列所采用的方向。
- 以下值中的一个:ascending,descending
- 默认:ascending
- wrfromtitle
要列举的起始标题(带名字空间前缀)。
- wrtotitle
要列举的最终标题(带名字空间前缀)。
- 列出当前用户的监视列表中的页面。
- api.php?action=query&list=watchlistraw [在沙盒中打开]
- 检索当前用户监视列表上的页面的页面信息。
- api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [在沙盒中打开]
meta=allmessages (am)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回来自该网站的消息。
- ammessages
要输出的消息。*(默认)表示所有消息。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- 默认:*
- amprop
要获取的属性。
- 值(以|或替代物分隔):default
- amenableparser
设置以启用解析器,将处理消息的wiki文本(替代魔术字、处理模板等)。
- 类型:布尔值(详细信息)
- amnocontent
如果设置,不要在输出中包含消息内容。
- 类型:布尔值(详细信息)
- amincludelocal
也包括本地消息,也就是不存在于软件但作为MediaWiki:页面存在的消息。 这会列举所有MediaWiki:页面,因此它也将列举那些不是真消息的消息,例如Common.js。
- 类型:布尔值(详细信息)
- amargs
要替代进消息的参数。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- amfilter
只返回名称包含此字符串的消息。
- amcustomised
只返回在此定制情形下的消息。
- 以下值中的一个:all,modified,unmodified
- 默认:all
- amlang
返回这种语言的信息。
- amfrom
从此消息开始返回消息。
- amto
返回消息至此消息为止。
- amtitle
当解析消息时,要用作环境的页面(用于amenableparser选项)。
- amprefix
返回带有该前缀的消息。
- 显示以ipb-开始的消息。
- api.php?action=query&meta=allmessages&refix=ipb- [在沙盒中打开]
- 显示德语版的august和mainpage消息。
- api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de [在沙盒中打开]
meta=authmanagerinfo (ami)
- 来源:MediaWiki
- 许可协议:GPL-2.0+
检索有关当前身份验证状态的信息。
- amisecuritysensitiveoperation
测试用户当前的身份验证状态是否足够用于指定的安全敏感操作。
- amirequestsfor
取得指定身份验证操作所需的有关身份验证请求的信息。
- 以下值中的一个:login,login-continue,create,create-continue,link,link-continue,change,remove,unlink
- amimergerequestfields
合并用于所有身份验证请求的字段信息至一个数组中。
- 类型:布尔值(详细信息)
- amimessageformat
返回消息使用的格式。
- 以下值中的一个:html,wikitext,raw,none
- 默认:wikitext
- 检索当开始登录时可能使用的请求。
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login [在沙盒中打开]
- 检索当开始登录时可能使用的请求,并合并表单字段。
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login&amimergerequestfields=1 [在沙盒中打开]
- 测试身份验证对操作foo是否足够。
- api.php?action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo [在沙盒中打开]
meta=filerepoinfo (fri)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回有关wiki配置的图片存储库的元信息。
- friprop
要获取的存储库属性(这在一些wiki上可能有更多可用选项):
- apiurl
- 链接至API的URL - 对从主机获取图片信息有用。
- name
- 存储库关键词 - 用于例如$wgForeignFileRepos,并且imageinfo会返回值。
- displayname
- 人类可读的存储库wiki名称。
- rooturl
- 图片路径的根URL。
- local
- 存储库是否在本地。
- 值(以|或替代物分隔):name,displayname,rootUrl,local,url,thumbUrl,initialCapital,scriptDirUrl,scriptExtension,favicon,canUpload
- 默认:name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|scriptExtension|favicon|canUpload
meta=siteinfo (si)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
返回有关网站的一般信息。
- siprop
要获取的信息:
- general
- 全部系统信息。
- namespaces
- 注册的名字空间及其规范名称列表。
- namespacealiases
- 注册的名字空间别名列表。
- specialpagealiases
- 特殊页面别名列表。
- magicwords
- 魔术字及其别名列表。
- interwikimap
- 返回跨wiki映射(可选过滤,可选择使用siinlanguagecode本地化)。
- dbrepllag
- 返回数据库服务器与最高反应延迟。
- statistics
- 返回网站统计。
- usergroups
- 返回用户组及其相关权限。
- libraries
- 返回wiki上安装的库。
- extensions
- 返回wiki上安装的扩展。
- fileextensions
- 返回允许上传的文件扩展名(文件类型)列表。
- rightsinfo
- 如果可用,返回wiki的版权信息。
- restrictions
- 返回可用的编辑限制(保护)类型信息。
- languages
- 返回MediaWiki支持的语言列表(可选择使用siinlanguagecode本地化)。
- skins
- 返回所有启用的皮肤列表(可选择使用siinlanguagecode本地化,否则是内容语言)。
- extensiontags
- 返回解析器扩展标签列表。
- functionhooks
- 返回解析器函数钩列表。
- showhooks
- 返回所有订阅的钩列表($wgHooks的内容)。
- variables
- 返回变量ID列表。
- protocols
- 返回外部链接中允许的协议列表。
- defaultoptions
- 返回用户设置的默认值。
- uploaddialog
- 返回上传对话框的配置。
- 值(以|或替代物分隔):general,namespaces,namespacealiases,specialpagealiases,magicwords,interwikimap,dbrepllag,statistics,usergroups,libraries,extensions,fileextensions,rightsinfo,restrictions,languages,skins,extensiontags,functionhooks,showhooks,variables,protocols,defaultoptions,uploaddialog
- 默认:general
- sifilteriw
只返回跨wiki地图中的本地或非本地记录。
- 以下值中的一个:local,!local
- sishowalldb
列出所有数据库服务器,不只是最落后的那个。
- 类型:布尔值(详细信息)
- sinumberingroup
列出用户组中的用户数。
- 类型:布尔值(详细信息)
- siinlanguagecode
用于本地化语言名称(尽可能)和皮肤名称的语言代码。
meta=tokens
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取可修改数据的操作的令牌。
- type
要请求的令牌类型。
- 值(以|或替代物分隔):createaccount,csrf,login,patrol,rollback,userrights,watch
- 默认:csrf
- 检索一个csrf令牌(默认)。
- api.php?action=query&meta=tokens [在沙盒中打开]
- 检索一个监视令牌和一个巡查令牌。
- api.php?action=query&meta=tokens&type=watch|patrol [在沙盒中打开]
meta=userinfo (ui)
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取有关当前用户的信息。
- uiprop
要包含的信息束:
- blockinfo
- 如果当前用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
- hasmsg
- 如果当前用户有等待中的消息的话,添加标签messages。
- groups
- 列举当前用户隶属的所有群组。
- implicitgroups
- 列举当前用户的所有自动成为成员的用户组。
- rights
- 列举当前用户拥有的所有权限。
- changeablegroups
- Lists the groups the current user can add to and remove from.
- options
- Lists all preferences the current user has set.
- preferencestoken
- 已弃用。获取令牌以更改当前用户的参数设置。
- editcount
- 添加当前用户的编辑计数。
- ratelimits
- Lists all rate limits applying to the current user.
- Adds the user's email address and email authentication date.
- realname
- 添加用户的真实姓名。
- acceptlang
- Echoes the
Accept-Language
header sent by the client in a structured format. - registrationdate
- 添加用户的注册时间。
- unreadcount
- Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
- centralids
- 添加中心ID并为用户附加状态。
- 值(以|或替代物分隔):blockinfo,hasmsg,groups,implicitgroups,rights,changeablegroups,options,preferencestoken,editcount,ratelimits,email,realname,acceptlang,registrationdate,unreadcount,centralids
- uiattachedwiki
与uiprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。
action=removeauthenticationdata
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从当前用户移除身份验证数据。
- request
使用此身份验证请求,通过返回自action=query&meta=authmanagerinfo的id与amirequestsfor=remove。
- 这个参数是必须的。
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 尝试移除当前用户的FooAuthenticationRequest数据。
- api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [在沙盒中打开]
action=resetpassword
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
向用户发送密码重置邮件。
- user
正在重置的用户。
- 类型:用户名
正在重置用户的电子邮件地址。
- capture
返回已发送的临时密码。需要
passwordreset
用户权限。- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 向用户Example发送密码重置邮件。
- api.php?action=resetpassword&user=Example&token=123ABC [在沙盒中打开]
- 向所有电子邮件地址为user@example.com的用户发送密码重置邮件。
- api.php?action=resetpassword&user=user@example.com&token=123ABC [在沙盒中打开]
action=revisiondelete
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
删除和恢复修订版本。
- type
正在执行的修订版本删除类型。
- 这个参数是必须的。
- 以下值中的一个:revision,archive,oldimage,filearchive,logging
- target
要进行修订版本删除的页面标题,如果对某一类型需要。
- ids
用于将被删除的修订的标识符。
- 这个参数是必须的。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- hide
每次修订要隐藏的东西。
- 值(以|或替代物分隔):content,comment,user
- show
每次修订要恢复显示的东西。
- 值(以|或替代物分隔):content,comment,user
- suppress
是否对管理员及其他人禁止数据。
- 以下值中的一个:yes,no,nochange
- 默认:nochange
- reason
删除或恢复的原因。
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
action=rollback
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
撤销对页面的最近编辑。
如果最近编辑页面的用户在一行中进行多次编辑,所有编辑将被回退。
- title
要回退的页面标题。不能与pageid一起使用。
- pageid
要回退的页面的页面 ID。不能与title一起使用。
- 类型:整数
- tags
要应用在回退上的标签。
- 值(以|或替代物分隔):
- user
做出要回退的编辑的用户名称。
- 这个参数是必须的。
- 类型:用户名
- summary
自定义编辑摘要。如果为空,将使用默认摘要。
- 默认:(空)
- markbot
将被回退的编辑和回退操作标记为机器人编辑。
- 类型:布尔值(详细信息)
- watchlist
无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。
- 以下值中的一个:watch,unwatch,preferences,nochange
- 默认:preferences
- token
从action=query&meta=tokens取回的“rollback”令牌
出于兼容性考虑,web UI中使用的令牌也被接受。
- 这个参数是必须的。
- 回退由用户Example对Main Page做出的最近编辑。
- api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [在沙盒中打开]
- 回退由IP用户192.0.2.5对页面Main Page做出的最近编辑,带编辑摘要Reverting vandalism,并将这些编辑和回退标记为机器人编辑。
- api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [在沙盒中打开]
action=rsd
- 来源:MediaWiki
- 许可协议:GPL-2.0+
导出一个RSD(Really Simple Discovery)架构。
- 导出RSD架构。
- api.php?action=rsd [在沙盒中打开]
action=setnotificationtimestamp
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
更新用于监视页面的通知时间戳。
这会影响监视列表和历史中已更改页面的高亮度,并且如果“当我的监视列表中的页面或文件更改时发送电子邮件通知我”设置被启用的话,也会影响电子邮件的发送。
- entirewatchlist
工作于所有已监视页面。
- 类型:布尔值(详细信息)
- timestamp
要设置通知时间戳的时间戳。
- 类型:时间戳(允许格式)
- torevid
要设置通知时间戳的修订(只限一个页面)。
- 类型:整数
- newerthanrevid
要设置通知时间戳的较新修订(只限一个页面)。
- 类型:整数
- continue
当更多结果可用时,使用这个继续。
- titles
要工作的标题列表。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- pageids
要工作的页面ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- revids
要工作的修订ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- generator
通过执行指定查询模块获得页面列表以工作。
注意:发生器参数名称必须以“g”开头,参见例子。
- 以下值中的一个:allcategories,alldeletedrevisions,allfileusages,allimages,alllinks,allpages,allredirects,allrevisions,alltransclusions,backlinks,categories,categorymembers,deletedrevisions,duplicatefiles,embeddedin,exturlusage,fileusage,images,imageusage,iwbacklinks,langbacklinks,links,linkshere,pageswithprop,prefixsearch,protectedtitles,querypage,random,recentchanges,redirects,revisions,search,templates,transcludedin,watchlist,watchlistraw
- redirects
自动解决在titles、pageids和revids,以及在由generator返回的页面中的重定向。
- 类型:布尔值(详细信息)
- converttitles
如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan,iu,kk,ku,shi,sr,tg,uz,zh。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 重置整个监视列表的通知状态。
- api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC [在沙盒中打开]
- 重置用于Main page的通知状态。
- api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC [在沙盒中打开]
- 设置Main page的通知时间戳,这样所有从2012年1月1日起的编辑都会是未复核的。
- api.php?action=setnotificationtimestamp&titles=Main_page×tamp=2012-01-01T00:00:00Z&token=123ABC [在沙盒中打开]
- 重置在用户名字空间中的页面的通知状态。
- api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC [在沙盒中打开]
action=stashedit
- 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
在分享的缓存中准备一次编辑。
这是为了从编辑表单中通过AJAX使用,以改进页面保存的性能。
- title
已开始编辑的页面标题。
- 这个参数是必须的。
- section
段落数。0用于首段,new用于新的段落。
- sectiontitle
新段落的标题。
- text
页面内容。
- stashedtexthash
要使用的来自先前暂存处的页面内容哈希。
- summary
更改摘要。
- contentmodel
新内容的内容模型。
- 这个参数是必须的。
- 以下值中的一个:wikitext,javascript,json,css,text
- contentformat
用于输入文本的内容序列化格式。
- 这个参数是必须的。
- 以下值中的一个:text/x-wiki,text/javascript,application/json,text/css,text/plain
- baserevid
基础修订的修订ID。
- 这个参数是必须的。
- 类型:整数
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
action=tag
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从个别修订或日志记录中添加或移除更改标签。
- rcid
要添加或移除标签的一个或更多的最近更改ID。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- revid
要添加或移除标签的一个或更多的修订ID。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- logid
要添加或移除标签的一个或更多的日志记录ID。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- add
要添加的标签。只有手动定义的标签可以添加。
- 值(以|或替代物分隔):
- remove
要移除的标签。只有手动定义或完全不明确的标签可以被移除。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- reason
更改原因。
- 默认:(空)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 将vandalism标签添加至修订ID 123,而不指定原因
- api.php?action=tag&revid=123&add=vandalism&token=123ABC [在沙盒中打开]
- 从日志记录ID 123移除spam标签,原因为Wrongly applied
- api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [在沙盒中打开]
action=tokens
- 此模块已弃用。
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
获取可修改数据的操作的令牌。
此模块被弃用以有利于action=query&meta=tokens。
- type
要请求的令牌类型。
- 值(以|或替代物分隔):block,createaccount,csrf,delete,edit,email,import,login,move,options,patrol,protect,rollback,unblock,userrights,watch
- 默认:edit
- 检索一个编辑令牌(默认)。
- api.php?action=tokens [在沙盒中打开]
- 检索一个电子邮件令牌和一个移动令牌。
- api.php?action=tokens&type=email|move [在沙盒中打开]
action=unblock
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
解封一位用户。
- id
解封时需要的封禁ID(通过list=blocks获得)。不能与user一起使用。
- 类型:整数
- user
要解封的用户名、IP地址或IP段。不能与id一起使用。
- reason
解封的原因。
- 默认:(空)
- tags
要在封禁日志中应用到实体的更改标签。
- 值(以|或替代物分隔):
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 解封封禁ID #105。
- api.php?action=unblock&id=105 [在沙盒中打开]
- 解封用户Bob,原因Sorry Bob。
- api.php?action=unblock&user=Bob&reason=Sorry%20Bob [在沙盒中打开]
action=undelete
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
恢复一个被删除页面的修订。
被删除修订的列表(包括时间戳)可通过list=deletedrevs检索到,并且被删除的文件ID列表可通过list=filearchive检索到。
- title
要恢复的页面标题。
- 这个参数是必须的。
- reason
恢复的原因。
- 默认:(空)
- tags
要在删除日志中应用到实体的更改标签。
- 值(以|或替代物分隔):
- timestamps
要回复的修订的时间戳。如果timestamps和fileids都为空,所有将被恢复。
- 类型:时间戳列表(允许格式)
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- fileids
要恢复的文件修订ID。如果timestamps和fileids都为空,所有将被恢复。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- watchlist
无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。
- 以下值中的一个:watch,unwatch,preferences,nochange
- 默认:preferences
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
action=unlinkaccount
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从当前用户移除已连接的第三方账户。
- request
使用此身份验证请求,通过返回自action=query&meta=authmanagerinfo的id与amirequestsfor=unlink。
- 这个参数是必须的。
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
- 尝试移除当前用户的,与FooAuthenticationRequest相关联提供方的链接。
- api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [在沙盒中打开]
action=upload
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
上传一个文件,或获取正在等待中的上传的状态。
可以使用的几种方法:
- 直接上传文件内容,使用file参数。
- 成批上传文件,使用filesize、chunk和offset参数。
- 有MediaWiki服务器从URL检索一个文件,使用url参数。
- 完成一次由于警告而失败的早前上传,使用filekey参数。
需要注意,当发送file时,HTTP POST必须做为一次文件上传(也就是使用multipart/form-data
)完成。
- filename
目标文件名。
- comment
上传注释。如果没有指定text,那么它也被用于新文件的初始页面文本。
- 默认:(空)
- tags
更改标签以应用于上传日志记录和文件页面修订中。
- 值(以|或替代物分隔):
- text
用于新文件的初始页面文本。
- watch
- 已弃用。
监视页面。
- 类型:布尔值(详细信息)
- watchlist
无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。
- 以下值中的一个:watch,preferences,nochange
- 默认:preferences
- ignorewarnings
忽略任何警告。
- 类型:布尔值(详细信息)
- file
文件内容。
- 必须被公布为使用multipart/form-data的一次文件上传。
- url
要检索文件来源的URL。
- filekey
用于识别一次临时藏匿的早前上传的关键字。
- sessionkey
- 已弃用。
与filekey相同,基于向后兼容而维护。
- stash
如果设置,服务器将临时藏匿文件而不是加入存储库。
- 类型:布尔值(详细信息)
- filesize
全部上传的文件大小。
- 值必须介于0和104,857,600之间。
- 类型:整数
- offset
数据块的偏移量(字节)。
- 值必须不少于0。
- 类型:整数
- chunk
大块内容。
- 必须被公布为使用multipart/form-data的一次文件上传。
- async
在可能的情况下,使潜在的大文件操作异步进行。
- 类型:布尔值(详细信息)
- checkstatus
只检索指定文件密钥的上传状态。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“csrf”令牌
- 这个参数是必须的。
action=userrights
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
更改一位用户的组成员。
- user
用户名。
- 类型:用户名
- userid
用户ID。
- 类型:整数
- add
将用户加入至这些组中。
- 值(以|或替代物分隔):bot,sysop,bureaucrat
- remove
将用户从这些组中移除。
- 值(以|或替代物分隔):bot,sysop,bureaucrat
- reason
更改原因。
- 默认:(空)
- token
从action=query&meta=tokens取回的“userrights”令牌
出于兼容性考虑,web UI中使用的令牌也被接受。
- 这个参数是必须的。
- 将用户FooBot添加至bot用户组,并从sysop和bureaucrat组移除。
- api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [在沙盒中打开]
- 将ID为123的用户加入至机器人组,并将其从管理员和行政员组移除。
- api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [在沙盒中打开]
action=watch
- 此模块需要读取权限。
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
从当前用户的监视列表中添加或移除页面。
- title
- 已弃用。
要(取消)监视的页面。也可使用titles。
- unwatch
如果设置页面将被取消监视而不是被监视。
- 类型:布尔值(详细信息)
- continue
当更多结果可用时,使用这个继续。
- titles
要工作的标题列表。
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- pageids
要工作的页面ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- revids
要工作的修订ID列表。
- 类型:整数列表
- 通过|或替代物隔开各值。 值的最高数字是50(对于机器人则是500)。
- generator
通过执行指定查询模块获得页面列表以工作。
注意:发生器参数名称必须以“g”开头,参见例子。
- 以下值中的一个:allcategories,alldeletedrevisions,allfileusages,allimages,alllinks,allpages,allredirects,allrevisions,alltransclusions,backlinks,categories,categorymembers,deletedrevisions,duplicatefiles,embeddedin,exturlusage,fileusage,images,imageusage,iwbacklinks,langbacklinks,links,linkshere,pageswithprop,prefixsearch,protectedtitles,querypage,random,recentchanges,redirects,revisions,search,templates,transcludedin,watchlist,watchlistraw
- redirects
自动解决在titles、pageids和revids,以及在由generator返回的页面中的重定向。
- 类型:布尔值(详细信息)
- converttitles
如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan,iu,kk,ku,shi,sr,tg,uz,zh。
- 类型:布尔值(详细信息)
- token
从action=query&meta=tokens取回的“watch”令牌
- 这个参数是必须的。
format=json
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
输出数据为JSON格式。
- callback
如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。
- utf8
如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。
- 类型:布尔值(详细信息)
- ascii
如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion为1时。
- 类型:布尔值(详细信息)
- formatversion
输出格式:
- 1
- 向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
- 2
- 实验现代格式。细节可以更改!
- latest
- 使用最新格式(当前为2),可以在没有警告的情况下更改。
- 以下值中的一个:1,2,latest
- 默认:1
format=jsonfm
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
输出数据为JSON格式(HTML优质打印效果)。
- wrappedhtml
作为一个JSON对象返回渲染好的HTML和关联的ResouceLoader模块。
- 类型:布尔值(详细信息)
- callback
如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。
- utf8
如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。
- 类型:布尔值(详细信息)
- ascii
如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion为1时。
- 类型:布尔值(详细信息)
- formatversion
输出格式:
- 1
- 向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
- 2
- 实验现代格式。细节可以更改!
- latest
- 使用最新格式(当前为2),可以在没有警告的情况下更改。
- 以下值中的一个:1,2,latest
- 默认:1
format=none
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
不输出任何东西。
format=php
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
输出数据为序列化PHP格式。
- formatversion
输出格式:
- 1
- 向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
- 2
- 实验现代格式。细节可以更改!
- latest
- 使用最新格式(当前为2),可以在没有警告的情况下更改。
- 以下值中的一个:1,2,latest
- 默认:1
format=phpfm
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
输出数据为序列化PHP格式(HTML优质打印效果)。
- wrappedhtml
作为一个JSON对象返回渲染好的HTML和关联的ResouceLoader模块。
- 类型:布尔值(详细信息)
- formatversion
输出格式:
- 1
- 向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
- 2
- 实验现代格式。细节可以更改!
- latest
- 使用最新格式(当前为2),可以在没有警告的情况下更改。
- 以下值中的一个:1,2,latest
- 默认:1
format=rawfm
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
输出数据为JSON格式,包含调试元素(HTML优质打印效果)。
- wrappedhtml
作为一个JSON对象返回渲染好的HTML和关联的ResouceLoader模块。
- 类型:布尔值(详细信息)
format=xml
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
输出数据为XML格式。
- xslt
如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki名字空间以
.xsl
为结尾的标题。- includexmlnamespace
如果指定,添加一个XML名字空间。
- 类型:布尔值(详细信息)
format=xmlfm
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
输出数据为XML格式(HTML优质打印效果)。
数据类型
至MediaWiki的输入应为NFC标准化的UTF-8。MediaWiki可以尝试转换其他输入,但这可能导致一些操作失败(例如edits与MD5校验)。
一些在API请求中的参数类型需要更进一步解释:
- boolean
- 布尔参数就像HTML复选框一样工作:如果指定参数,无论何值都被认为是真。如果要假值,则可完全忽略参数。
- timestamp
- 时间戳可被指定为很多格式。推荐使用ISO 8601日期和时间标准。所有时间为UTC时间,包含的任何时区会被忽略。
- ISO 8601日期和时间,2001-01-15T14:56:00Z(标点和Z是可选项)
- 带小数秒(会被忽略)的ISO 8601日期和时间,2001-01-15T14:56:00.00001Z(破折号、括号和Z是可选的)
- MediaWiki格式,20010115145600
- 一般数字格式,2001-01-15 14:56:00(GMT、+##或-##的可选时区会被忽略)
- EXIF格式,2001:01:15 14:56:00
- RFC 2822格式(时区可能会被省略),Mon, 15 Jan 2001 14:56:00
- RFC 850格式(时区可能会被省略),Monday, 15-Jan-2001 14:56:00
- C ctime格式,Mon Jan 15 14:56:00 2001
- 秒数是从1970-01-01T00:00:00Z开始,作为1到13位数的整数(除了0)
- 字符串now
- 替代多值分隔符
- 使用多个值的参数通常会与管道符号分隔的值一起提交,例如param=value1|value2或param=value1%7Cvalue2。如果值必须包含管道符号,使用U+001F(单位分隔符)作为分隔符,并在值前加前缀U+001F,例如param=%1Fvalue1%1Fvalue2。
制作人员
API 开发人员:
- Yuri Astrakhan(创建者,2006年9月~2007年9月的开发组领导)
- Roan Kattouw(2007年9月~2009年的开发组领导)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch(2013年至今的开发组领导)
请将您的评论、建议和问题发送至mediawiki-api@lists.wikimedia.org,或提交错误请求至https://phabricator.wikimedia.org/。