API 通用语法

要启动对象的 API 请求，请按以下格式使用命令

GET "http://ws-ip/api/v1/obj/method?arg1=<value>&arg2=<value>&vdc=<grid>"

其中：: ws-ip 是用来访问 WS_API 应用的 IP 地址
object 是 API 对象，例如应用、类等。
method 是要对对象执行的操作，例如启动、停止等。
arg1、arg2 是要传递给方法的参数
vdc 是网格控制器的名称
说明

有值选项语法：有值的选项通常采用以下格式表示：
```
<property_name>=<value>
```
值必须根据 URI 的路径组件特有的规则，使用 URI 编码（统一资源标识符百分比编码）。使用百分比编码的版本 %HH（其中 HH 是所指字符的十六进制 ASCII 表示形式）替换 URI 的路径字段中的任何保留字符，如百分比、空格和制表符、等号、逗号、正斜杠、问号、单双引号。

注意：有关 URI 编码的信息，请参阅 RFC 3986。

选项标志语法：虽然 CLI 使用双连字符或长破折号 (—) 作为前缀以指定选项标志（通常是没有值的选项），但是 Web 服务 API 仍然使用与符号 (&) 作为前缀。因此，CLI 使用 --option 的地方，Web 服务将使用 &option。例如，如果 CLI 使用 --debug，Web 服务 API 将使用 &debug。
虽然对象的 API 请求的说明包括所有强制性参数，但是它们仅包括部分可选参数。未包含在此指南中的可选参数在《命令行 Shell 参考指南》中介绍。

示例：

获取对象 app 的方法
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid

示例输出：

{
   "method" : [
      {
         "name" : "config"
      },
      {
         "name" : "copy"
      },
      {
         "name" : "create"
      },
      {
         "name" : "destroy"
      },
      。
      。
      。
   ]
}

输出格式

可接受的输出格式可以是 XML 或 JSON。可以在 API 请求中进行指定。

示例：

以 XML 格式获取对象 app 的方法。

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/xml"

以 JSON 格式获取对象 app 的方法。

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/json"

注意：JSON 中的所有输出均为 UTF8 编码。使用 UTF8 解码对 UTF8 编码的输出进行解码。下面是对 UTF8 编码的 JSON 输出进行解码的简单 PHP 脚本示例：

<? 
$json = '{"a": "\u00e3\u0081\u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

此部分包含以下主题：

常见参数类型

可以使用许多命令所公用的以下通用参数类型。通过任何特殊命令说明引用特定参数类型时，请使用所述类型的以下详细信息。

<主体>

<principal> 表示给定范围（本地或全局）的角色，可以是个人或组。根据以下可能的语法之一指定主体：

<名称>: 本地用户或组。
/<名称>: 全局用户或组。
<范围>:<类型>:<名称>: 完全限定的主体名称，其中 <scope> 为 global 或 local，<type> 为 group 或 user，<name> 为组名或用户名。

注意：主体必须使用 URL 编码。例如：local:user:api@3tera.com 应以 local%3Auser%3Aapi%403tera.com 的形式传递