1. 参数约定

为了程序测试方便，所有接口，就算出错，不论出什么错，在result字段也要回id字段。所以在处理代码的开头就把result里的id放置好。

index.php也要尽力把id字段放回到$result里。

1.1. 请求参数

地球号接口的字段有一套的规则，规定了一系列固定参数。地球号接口参数分为四部分：用户业务参数，网关常量参数，SDK参数，令牌参数。业务参数是用户在调用API请求时发送的业务参数。网关参数是请求在经过网关时，网关自动添加的参数。主要用来辅助权限控制。SDK参数是API请求调用时，SDK自动添加的参数。这些参数对统计，分析，定位

[!note|label:为什么AG所有可选参数必须配置默认？] 为了FC的index能够方便的检查各种请求的参数，FC要求所有AG的可选参数必须配置默认，因为如果不配置默认，参数就不会头传到FC。所以FC所有参数必须配置默认参数。

[!note] 注意命名规则，XduaApiZoneAstate的命名是个简称，表示XduaApiAssertZoneState,因为太冗长，所以简化成Astate。

1.2. POST参数

在地球号设计里POST接口是创建资源用的，创建资源的字段有很多是公用的。这里列举一些公用的字段。这些字节的长度限制是全局有效的。

[!note|style:flat|label:avatar为什么要小于40字节？|iconVisibility:hidden] 因为md5码是32个字节，加上一个.号，后面可能的jpeg,webp后缀，40个字节足够了。除非各个接口有意指定这个接口的长度。

{
    "id":"创建资源的id"    
}

1.3. DELETE参数

在地球号设计里DELETE接口是删除资源用的，删除资源的ID字段是确定的。

{
    "id":"删除资源的id"    
}

1.4. PUT参数

在地球号设计里PUT接口是修改资源用的，修改资源的ID字段是确定的，还有修改的内容放置在updates里

返回格式

{
    "id":"修改的资源的ID",
    "updates":[
        {"field":"字段名","old":"旧值","new":"新值"}
    ]
}

1.5. GET参数

在地球号设计里GET接口是详情资源用的，详情资源的ID字段是确定的，这里要注意，详情需要的fields字段和query一样。

[!note|style:flat|label:为什么查询返回里要有where字段？|iconVisibility:hidden] where字段必须是字典,返回where是为了让客户端更好的调试。

返回格式

{
    "id":"修改的资源的ID",
    "format":"raw",
    "data":{
        {"field":"value1"}
    }
}