Web服务API - 使用XML-RPC

XML-RPC

XML-RPC是一个远程过程调用（远端程序呼叫）（remote procedure call，RPC)的分布式计算协议，通过XML将调用函数封装，并使用HTTP协议作为传送机制。

方法列表

资源

pmp.resources.create

密码

方法详情

pmp.resources.create

用于在PMP中创建资源。

URL: https://pmp-server:7070/xmlrpc

请求参数

名称	类型	必需	描述
resourceName	字符串	是	在PMP的唯一资源名称。
resourceType	字符串	是	资源类型。
accountName	字符串	是	资源的用户账户名称。
newPassword	字符串	可选	用户账户的密码。
notes	字符串	是	用户账户说明。

响应参数

名称	描述	值
resultCode	描述请求调用结果的数字。	0 - 成功其他值 - 失败。失败原因在message中。
message	基于resultCode的操作结果的文本描述。	成功的时候为“SUCCESS” 失败的时候为<Message>

请求XML示例

<?xml version="1.0" encoding="utf-8"?>


<methodCall>
<methodName>pmp.resource.create</methodName>
<params>
    <param>
        <value><string>pmp-server<>string></value>
    </param>
    <param>
        <value><string>Windows</string></value>
    </param>
    <param>
        <value><string>administrator</string></value>
    </param>
    <param>
        <value><string>SMP</string></value>
    </param>
 <param>


 <value><string>Admin user</string></value>


   </param> </params>


</methodCall>

响应XML示例

成功

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      value><int>0</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>SUCCESS</string>/value>
                 </member>
             </struct>
         </value>
  </param>
 </params> 


</methodResponse>

失败

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>1</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>Resource with the given resource name already exists.</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params> 


</methodResponse>

pmp.password.retrieve

从PMP中获取指定用户账户的密码。

URL: https://pmp-server:7070/xmlrpc

请求参数

名称	类型	必需	描述
resourceName	字符串	是	PMP中的唯一资源名称。
userAccount	字符串	是	要获取密码的用户账户名称。
reason	字符串	可选	获取密码的原因。

响应参数

名称

描述

值

resultCode

描述请求调用结果的数字。

0 - 成功
其他值 - 失败。失败原因在message中。

message

基于resultCode的操作结果的文本描述。

需要的密码

返回的字符串格式的密码，或者
失败的时候为<Message>

请求XML示例


<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>pmp.password.retrieve</methodName>
<params>
<param>
<value><string>pmp-server</string></value>
</param>
<param>
<value><string>administrator</string></value>
</param>
</params>
</methodCall>

响应XML示例

成功

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>0</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>edhfED45@#f</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse>

失败

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>1</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>Resource with the given resource name does not exist.</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse>

pmp.password.update

在PMP更新指定用户账户的密码。

URL: https://pmp-server:7070/xmlrpc

请求参数

名称	类型	必需	描述
resourceName	字符串	是	PMP中的唯一资源名称。
userAccount	字符串	是	要获取密码的用户账户名称。
reason	字符串	可选	更新密码的原因。
newPassword	字符串	可选	用户账户的新密码。
updateRemote	布尔	是	如要远程更新，设置为true。

请求参数

名称	描述	值
resultCode	描述请求调用结果的数字。	0 - 成功其他值 - 失败。失败原因在message中。
message	基于resultCode的操作结果的文本描述。	成功的时候为“SUCCESS” 失败的时候为<Message>

请求XML示例

<?xml version="1.0" encoding="utf-8"?>


<methodCall>
<methodName>pmp.password.update</methodName>
<params>
<param>
<value><string>pmp-server</string></value>
</param>
<param>
<value><string>administrator</string></value>
</param>
<param>
<value><boolean>true</boolean></value>
</param>
</params>
</methodCall>
响应XML示例

成功

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>0</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>SUCCESS</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse>

失败

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>1</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>Resource with the given resource name does not exist.</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse>