阿里安全开放平台-阿里聚安全

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
preplan_request	PreplanRequest	必须			预案文档创建请求
└ prepend_target_uuid String 必须 uuid id └ namespace String 必须 dede/frfr 空间 └ format String 必须 markdown 格式 └ user_agent String 必须 sds8f 用户 └ title String 必须 title 标题 └ body String 必须 text 内容 └ token String 必须 DSSF12 token └ app_name String 必须 ops-manager 应用名

名称	类型	示例值	描述
succ	Boolean	true	成功
model	PreplanDocDTO		响应
└ id Number 12 id └ slug String cdcs 标识
msg_info	String	succ	信息
msg_code	String	0	错误码

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AliyunCloudgamePreplanDocCreateRequest req = new AliyunCloudgamePreplanDocCreateRequest();
AliyunCloudgamePreplanDocCreateRequest.PreplanRequest obj1 = new AliyunCloudgamePreplanDocCreateRequest.PreplanRequest();
obj1.setPrependTargetUuid("uuid");
obj1.setNamespace("dede/frfr");
obj1.setFormat("markdown");
obj1.setUserAgent("sds8f");
obj1.setTitle("title");
obj1.setBody("text");
obj1.setToken("DSSF12");
obj1.setAppName("ops-manager");
req.setPreplanRequest(obj1);
AliyunCloudgamePreplanDocCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AliyunCloudgamePreplanDocCreateRequest req = new AliyunCloudgamePreplanDocCreateRequest();
AliyunCloudgamePreplanDocCreateRequest.PreplanRequestDomain obj1 = new AliyunCloudgamePreplanDocCreateRequest.PreplanRequestDomain();
obj1.PrependTargetUuid = "uuid";
obj1.Namespace = "dede/frfr";
obj1.Format = "markdown";
obj1.UserAgent = "sds8f";
obj1.Title = "title";
obj1.Body = "text";
obj1.Token = "DSSF12";
obj1.AppName = "ops-manager";
req.PreplanRequest_ = obj1;
AliyunCloudgamePreplanDocCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AliyunCloudgamePreplanDocCreateRequest;
$preplan_request = new PreplanRequest;
$preplan_request->prepend_target_uuid="uuid";
$preplan_request->namespace="dede/frfr";
$preplan_request->format="markdown";
$preplan_request->user_agent="sds8f";
$preplan_request->title="title";
$preplan_request->body="text";
$preplan_request->token="DSSF12";
$preplan_request->app_name="ops-manager";
$req->setPreplanRequest(json_encode($preplan_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=aliyun.cloudgame.preplan.doc.create' \
-d 'partner_id=apidoc' \
-d 'sign=ECC309841D0AFF8B745481D90C4077B5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+00%3A50%3A32' \
-d 'v=2.0' \
-d 'preplan_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AliyunCloudgamePreplanDocCreateRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.preplan_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"aliyun.cloudgame.preplan.doc.create");
add_param(pRequest,"preplan_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('aliyun.cloudgame.preplan.doc.create', {
	'preplan_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<aliyun_cloudgame_preplan_doc_create_response>
    <succ>true</succ>
    <model>
        <id>12</id>
        <slug>cdcs</slug>
    </model>
    <msg_info>succ</msg_info>
    <msg_code>0</msg_code>
</aliyun_cloudgame_preplan_doc_create_response>

{
    "aliyun_cloudgame_preplan_doc_create_response":{
        "succ":true,
        "model":{
            "id":12,
            "slug":"cdcs"
        },
        "msg_info":"succ",
        "msg_code":"0"
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

云游戏API

aliyun.cloudgame.preplan.doc.create (创建预案文档)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈