'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Market',
'version' => '2015-11-01',
],
'directories' => [
[
'id' => 250866,
'title' => '消息通知',
'type' => 'directory',
'children' => [
'DescribeFailedNotifications',
'ConfirmNotification',
],
],
[
'id' => 250867,
'title' => '发票',
'type' => 'directory',
'children' => [
'ModifyInvoiceForIsv',
'DescribeInvoiceForIsv',
],
],
[
'id' => 65815,
'title' => '商品',
'type' => 'directory',
'children' => [
'DescribePrice',
'DescribeProduct',
'DescribeProducts',
],
],
[
'id' => 65819,
'title' => '订单',
'type' => 'directory',
'children' => [
'DescribeOrderForIsv',
'CreateOrder',
'DescribeOrder',
],
],
[
'id' => 65822,
'title' => '流程',
'type' => 'directory',
'children' => [
'DescribeProjectMessages',
'DescribeProjectNodes',
'DescribeProjectOperateLogs',
'DescribeCurrentNodeInfo',
'FinishCurrentProjectNode',
'RollbackCurrentProjectNode',
],
],
[
'id' => 65829,
'title' => '实例',
'type' => 'directory',
'children' => [
'DescribeInstance',
'DescribeInstanceForIsv',
'DescribeInstances',
'AutoRenewInstance',
],
],
[
'id' => 65832,
'title' => '项目',
'type' => 'directory',
'children' => [
'PauseProject',
'DescribeProjectAttachments',
'DescribeProjectInfo',
'ResumeProject',
],
],
[
'id' => 65837,
'title' => '授权',
'type' => 'directory',
'children' => [
'DescribeLicense',
'ActivateLicense',
],
],
[
'id' => 65840,
'title' => '计量',
'type' => 'directory',
'children' => [
'PushMeteringData',
],
],
[
'id' => 182754,
'title' => '其他',
'type' => 'directory',
'children' => [
'CrossAccountVerifyToken',
'DescribeDistributionProductsLink',
'DescribeDistributionProducts',
'DescribeApiMetering',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'DescribeFailedNotifications' => [
'summary' => '查询订阅通知失败列表，云市场调用商家消息SPI失败后，商家可以通过此接口主动查询出失败的信息。',
'path' => '',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页的实例个数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
],
'TotalCount' => [
'description' => '实例总数',
'type' => 'integer',
'format' => 'int32',
'example' => '55',
],
'PageNumber' => [
'description' => '当前页数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页的实例个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NotificationList' => [
'description' => '通知列表',
'type' => 'array',
'items' => [
'description' => '通知对象',
'type' => 'object',
'properties' => [
'NotificationRequestId' => [
'description' => '通知请求ID（UUID生成），用于幂等',
'type' => 'string',
'example' => 'deab3673236843a3b378c7d8d25c5f01',
],
'Message' => [
'description' => '通知消息体，json结构',
'type' => 'string',
'example' => '{"productCode":"cmgj00001","orderId":"123456","orderBizId":"111222","action":"orderPay","aliUid":"12211222211","skuId":"cmgj00001-prepay"}',
],
'Action' => [
'description' => '操作事件',
'type' => 'string',
'example' => 'orderPay',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1665988512000',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"TotalCount\\": 55,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"NotificationList\\": [\\n {\\n \\"NotificationRequestId\\": \\"deab3673236843a3b378c7d8d25c5f01\\",\\n \\"Message\\": \\"{\\\\\\"productCode\\\\\\":\\\\\\"cmgj00001\\\\\\",\\\\\\"orderId\\\\\\":\\\\\\"123456\\\\\\",\\\\\\"orderBizId\\\\\\":\\\\\\"111222\\\\\\",\\\\\\"action\\\\\\":\\\\\\"orderPay\\\\\\",\\\\\\"aliUid\\\\\\":\\\\\\"12211222211\\\\\\",\\\\\\"skuId\\\\\\":\\\\\\"cmgj00001-prepay\\\\\\"}\\",\\n \\"Action\\": \\"orderPay\\",\\n \\"CreateTime\\": 1665988512000\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询订阅通知失败列表',
'description' => '查询商家订阅通知失败的信息'."\n"
."\n"
.'- 如果当前不存在未确认的通知失败信息，TotalCount返回0',
],
'ConfirmNotification' => [
'summary' => '商家查收完毕通知信息之后调用此接口反馈给平台，后续该信息不会再被查询出来。',
'path' => '',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'NotificationRequestId',
'in' => 'query',
'schema' => [
'description' => '通知请求ID',
'type' => 'string',
'required' => true,
'example' => 'deab3673236843a3b378c7d8d25c5f01',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817',
],
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A077D99E-0C4D-421E-A5D4-F533F6657817\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '确认查收订阅通知',
'description' => '确认查收订阅通知失败信息'."\n"
."\n"
.'- 调用成功之后该信息后续不会再被查询出来，平台认为商家已经把该信息正确处理完毕'."\n",
],
'ModifyInvoiceForIsv' => [
'summary' => '发票受理接口',
'path' => '',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '发票类型：数字电子普通发票：2；数字电子专用发票：3',
'description' => '当前开票的发票类型：'."\n"
.'- 数字电子普通发票：2'."\n"
.'- 数字电子专用发票：3',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'ElectronUrl',
'in' => 'query',
'schema' => [
'title' => '电子发票地址',
'description' => '电子发票地址，用于客户下载',
'type' => 'string',
'required' => false,
'example' => 'https://oss.aliyuncs.com/xxxx.png',
],
],
[
'name' => 'InvoiceId',
'in' => 'query',
'schema' => [
'title' => '发票Id',
'description' => '发票申请Id（对应DescribeInvoiceForIsv接口返回结果中的Result.Id）',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4072040****',
],
],
[
'name' => 'OperateType',
'in' => 'query',
'schema' => [
'title' => '操作类型：开票：0 ；拒绝开票：1',
'description' => '操作当前发票：'."\n"
.'- 开票：0'."\n"
.'- 拒绝开票：1',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '0',
],
],
[
'name' => 'CheckNotice',
'in' => 'query',
'schema' => [
'title' => '服务商发票信息备注',
'description' => '服务商发票信息备注',
'type' => 'string',
'required' => false,
'example' => '******',
],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'title' => '发票号',
'description' => '发票号',
'type' => 'string',
'required' => false,
'example' => '1897702****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码，200表示成功',
'type' => 'string',
'example' => 'cmjj01**45',
],
'Message' => [
'description' => '错误信息',
'type' => 'string',
'example' => '"成功"',
],
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '是否返回成功',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5BD09171-MB74-18D8-890E-C70C067527BE',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"cmjj01**45\\",\\n \\"Message\\": \\"\\\\\\"成功\\\\\\"\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5BD09171-MB74-18D8-890E-C70C067527BE\\"\\n}","type":"json"}]',
'title' => '云市场店铺发票受理',
'description' => '查询商家订阅通知失败的信息'."\n"
."\n"
.'- 如果当前不存在未确认的通知失败信息，TotalCount返回0',
],
'DescribeInvoiceForIsv' => [
'summary' => '查询云市场供应商店铺的发票信息',
'path' => '',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'title' => '发票状态：申请中：0；已完成：1',
'description' => '当前发票状态'."\n"
.'- 申请中：0'."\n"
.'- 已完成：1',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '发票类型：数字电子普通发票：2；数字电子专用发票：3',
'description' => '发票类型，为空代表默认查询所有类型'."\n"
.'- 数字电子普通发票：2'."\n"
.'- 数字电子专用发票：3',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'InvoiceId',
'in' => 'query',
'schema' => [
'title' => '发票Id',
'description' => '发票申请 Id（对应 DescribeInvoiceForIsv 接口返回结果中的 Result.Id）',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4072040****',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页的实例个数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'title' => '客户的阿里云userId',
'description' => '客户的阿里云userId',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '174452687724****',
],
],
[
'name' => 'CreateTimeEnd',
'in' => 'query',
'schema' => [
'title' => '开始时间',
'description' => '结束时间（日期后默认拼接23:59:59）',
'type' => 'string',
'required' => false,
'example' => '2025-01-01 00:00:00',
],
],
[
'name' => 'CreateTimeStart',
'in' => 'query',
'schema' => [
'title' => '结束时间',
'description' => '开始时间（日期后默认拼接00:00:00）',
'type' => 'string',
'required' => false,
'example' => '2025-01-31 23:59:59',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '查询页码,从1开始',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分页查询时每页的最大条目数。最大值为50。默认值为10。(未启用此参数)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '本次调用返回的查询凭证值。(未启用此参数)',
'type' => 'string',
'required' => false,
'example' => '3v3mzZN1QdVsTPNiT0OkD9v+MeV8LSqSQDSuTTVFCUMMWShmnj/LXRMScqm242bB',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
],
'PageSize' => [
'description' => '每页的实例个数。',
'type' => 'string',
'example' => '10',
],
'PageNumber' => [
'description' => '当前页数',
'type' => 'string',
'example' => '1',
],
'Count' => [
'description' => '总数',
'type' => 'string',
'example' => '100',
],
'Code' => [
'description' => '商品对应商品码',
'type' => 'string',
'example' => '200',
],
'Success' => [
'description' => '结果标识',
'type' => 'boolean',
'example' => 'true',
],
'Result' => [
'description' => '成功流程节点信息',
'type' => 'array',
'items' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'AliyunPk' => [
'description' => '客户的阿里云userId',
'type' => 'string',
'example' => '102277855749****',
],
'CreateTimeStr' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2025-01-01 00:00:00'."\n",
],
'EvaluateList' => [
'description' => '订单/账单/合同编号',
'type' => 'array',
'items' => [
'description' => '修改时间',
'type' => 'object',
'properties' => [
'Agent' => [
'title' => '是否代理开票',
'description' => '是否代理开票',
'type' => 'boolean',
'example' => 'false',
],
'Amount' => [
'title' => '金额（分）',
'description' => '金额（单位：元）',
'type' => 'string',
'example' => '1',
],
'BizTimeStr' => [
'description' => '业务发生时间',
'type' => 'string',
'example' => '2025-01-01 00:00:00'."\n",
],
'Id' => [
'title' => '开票对象id',
'description' => '开票对象id',
'type' => 'string',
'example' => '9540765',
],
'OrderType' => [
'title' => '订账单类型'."\n"
.'0：订单'."\n"
.'1：账单',
'description' => '订账单类型'."\n"
."\n"
.'- 0：订单'."\n"
."\n"
.'- 1：账单',
'type' => 'string',
'example' => '0',
],
'OutBizId' => [
'title' => '订单Id',
'description' => '订单Id',
'type' => 'string',
'example' => '2024091610072000****',
],
'RealAliyunPk' => [
'title' => '订单归属账号',
'description' => '订单归属账号',
'type' => 'string',
'example' => '102277855749****'."\n",
],
'RealAliyunId' => [
'description' => '账号id',
'type' => 'string',
'example' => 'example@alibaba-inc.com',
],
'ProductCode' => [
'description' => '商品Code',
'type' => 'string',
'example' => 'cmapi00067***',
],
'ProductName' => [
'description' => '商品名称（已废弃）',
'type' => 'string',
'example' => '图像识别OCR***',
],
],
],
],
'Id' => [
'description' => '发票申请Id（对应调用发票受理接口ModifyInvoiceForIsv'."\n"
.'时参数InvoiceId）',
'type' => 'string',
'example' => '4072040****'."\n",
],
'InvoiceId' => [
'description' => '发票对象id',
'type' => 'string',
'example' => '4072040****'."\n",
],
'InvoiceList' => [
'description' => '发票子集合（废弃）',
'type' => 'array',
'items' => [
'description' => '发票子集合（废弃）',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '发票对象id',
'type' => 'string',
'example' => '4072040****'."\n",
],
'InvoiceAmount' => [
'description' => '申请开票金额（单位：元）。',
'type' => 'string',
'example' => '99.99',
],
],
],
],
'MaterialType' => [
'title' => '发票开具类型，0：纸质，1：电子',
'description' => '发票开具类型'."\n"
.'- 0：纸质'."\n"
.'- 1：电子',
'type' => 'string',
'example' => '1',
],
'ModifiedTime' => [
'description' => '订单状态修改时间(GMT时间)',
'type' => 'string',
'example' => '2025-03-04T09:43:18+08:00',
],
'Price' => [
'title' => '电子发票下载地址',
'description' => '发票总金额（单位：元）',
'type' => 'string',
'example' => '99.99',
],
'Status' => [
'title' => '发票状态 0：待开票；1：已开票',
'description' => '发票状态 0：待开票；1：已开票',
'type' => 'string',
'example' => 'Success',
],
'Title' => [
'title' => '发票抬头',
'description' => '发票抬头',
'type' => 'string',
'example' => '阿里云计算有限公司',
],
'Type' => [
'title' => '数字电子普通发票:2'."\n"
.'数字电子专用发票:3',
'description' => '发票类型'."\n"
.'- 数字电子普通发票:2'."\n"
.'- 数字电子专用发票:3',
'type' => 'string',
'example' => '2',
],
'UserAddressDto' => [
'description' => '地址信息',
'type' => 'object',
'properties' => [
'AliyunPk' => [
'description' => '客户的阿里云userId',
'type' => 'string',
'example' => '174452687724****'."\n",
],
'BizType' => [
'description' => '废弃',
'type' => 'string',
'example' => '******',
],
'Emails' => [
'description' => '邮箱',
'type' => 'string',
'example' => '******',
],
'Addressee' => [
'description' => '收件人',
'type' => 'string',
'example' => '***',
],
'DeliveryAddress' => [
'description' => '收货地址',
'type' => 'string',
'example' => '杭州市****'."\n",
],
'Phone' => [
'description' => '电话',
'type' => 'string',
'example' => '130********',
],
'PostalCode' => [
'description' => '邮政编码',
'type' => 'string',
'example' => '******',
],
],
],
'ModifiedTimeStr' => [
'description' => '发票修改时间',
'type' => 'string',
'example' => '2025-01-01 00:00:00'."\n",
],
'ReceiptUserInfoDto' => [
'description' => '发票申请人用户信息',
'type' => 'object',
'properties' => [
'TaxNumber' => [
'description' => '企业社会征信代码',
'type' => 'string',
'example' => '91420100MA49L5****',
],
],
],
'UserNotice' => [
'title' => '用户发票备注',
'description' => '用户发票备注',
'type' => 'string',
'example' => '无',
],
'CheckNotice' => [
'title' => '服务商发票备注',
'description' => '服务商发票备注',
'type' => 'string',
'example' => '无',
],
],
],
],
'NextToken' => [
'description' => '本次调用返回的查询凭证值。',
'type' => 'string',
'example' => '3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+',
],
'MaxResults' => [
'description' => '分页查询时每页的最大条目数。最大值为50。默认值为10。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
403 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'PageSize' => [
'type' => 'string',
],
'Message' => [
'type' => 'string',
],
'PageNumber' => [
'type' => 'string',
],
'Version' => [
'type' => 'string',
],
'HttpStatusCode' => [
'type' => 'integer',
'format' => 'int32',
],
'Count' => [
'type' => 'string',
],
'Fatal' => [
'type' => 'boolean',
],
'Code' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Count\\": \\"100\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"AliyunPk\\": \\"102277855749****\\",\\n \\"CreateTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"EvaluateList\\": [\\n {\\n \\"Agent\\": false,\\n \\"Amount\\": \\"1\\",\\n \\"BizTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"Id\\": \\"9540765\\",\\n \\"OrderType\\": \\"0\\",\\n \\"OutBizId\\": \\"2024091610072000****\\",\\n \\"RealAliyunPk\\": \\"102277855749****\\\\n\\",\\n \\"RealAliyunId\\": \\"example@alibaba-inc.com\\",\\n \\"ProductCode\\": \\"cmapi00067***\\",\\n \\"ProductName\\": \\"图像识别OCR***\\"\\n }\\n ],\\n \\"Id\\": \\"4072040****\\\\n\\",\\n \\"InvoiceId\\": \\"4072040****\\\\n\\",\\n \\"InvoiceList\\": [\\n {\\n \\"Id\\": \\"4072040****\\\\n\\",\\n \\"InvoiceAmount\\": \\"99.99\\"\\n }\\n ],\\n \\"MaterialType\\": \\"1\\",\\n \\"ModifiedTime\\": \\"2025-03-04T09:43:18+08:00\\",\\n \\"Price\\": \\"99.99\\",\\n \\"Status\\": \\"Success\\",\\n \\"Title\\": \\"阿里云计算有限公司\\",\\n \\"Type\\": \\"2\\",\\n \\"UserAddressDto\\": {\\n \\"AliyunPk\\": \\"174452687724****\\\\n\\",\\n \\"BizType\\": \\"******\\",\\n \\"Emails\\": \\"******\\",\\n \\"Addressee\\": \\"***\\",\\n \\"DeliveryAddress\\": \\"杭州市****\\\\n\\",\\n \\"Phone\\": \\"130********\\",\\n \\"PostalCode\\": \\"******\\"\\n },\\n \\"ModifiedTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"ReceiptUserInfoDto\\": {\\n \\"TaxNumber\\": \\"91420100MA49L5****\\"\\n },\\n \\"UserNotice\\": \\"无\\",\\n \\"CheckNotice\\": \\"无\\"\\n }\\n ],\\n \\"NextToken\\": \\"3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
'title' => '查询云市场供应商店铺的发票信息',
'description' => '根据授权码查询业务信息首先验证授权码是否有效。'."\n"
."\n"
.'- 授权码无效，返回错误信息'."\n"
."\n"
.'- 授权码有效，返回授权信息',
],
'DescribePrice' => [
'summary' => '调用 DescribePrice 查询对应商品的价格信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
'description' => '订单类型。取值：'."\n"
."\n"
.'INSTANCE_BUY：商品购买'."\n"
.'INSTANCE_RENEW：实例续费'."\n"
.'INSTANCE_UPGRADE：实例升级'."\n"
.'说明：对于续费类型的询价，需要在 Commodity 中传入 InstanceId。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INSTANCE_BUY',
],
],
[
'name' => 'Commodity',
'in' => 'query',
'schema' => [
'description' => '根据指定的 OrderType，使用对应的配件并序列化。 不同 OrderType 分别对应的 CommodityType 如下所示：'."\n"
."\n"
.'INSTANCE_BUY：InstanceBuyCommodity'."\n"
.'INSTANCE_RENEW：InstanceRenewCommodity'."\n"
.'INSTANCE_UPGRADE：InstanceUpgradeCommodity'."\n"
.'示例中的参数说明如下：'."\n"
."\n"
.'productCode：商品 Code。'."\n"
.'skuCode：商品规格 Code。非镜像商品：预付费固定为 prepay，后付费固定为 postpay；镜像商品：按量为ECS，包年包月为Package'."\n"
.'components：规格模块。其中版本 package_version 必传，其他模块根据商品的设置来传。'."\n"
.'duration：周期数量 1,2,3...。'."\n"
.'pricingCycle: 周期单位。Day（日），Month（月），Year（年）。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"components":{"package_version":"yuncode12928000016"},"duration":1,"pricingCycle":"YEAR","productCode":"cmgj01**28","quantity":1,"skuCode":"prepay"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ExpressionCode' => [
'description' => '限购编码',
'type' => 'string',
'example' => 'ORDER.NO_REAL_NAME_AUTHENTICATION',
],
'Cuxiao' => [
'description' => '是否有促销',
'type' => 'boolean',
'example' => 'true',
],
'DiscountPrice' => [
'description' => '优惠的价格（原价-实际价格），单位：元',
'type' => 'number',
'format' => 'float',
'example' => '178.20',
],
'Cycle' => [
'description' => '周期单位'."\n"
."\n"
.'DAY：日'."\n"
.'MONTH：月'."\n"
.'YEAR：年',
'type' => 'string',
'example' => 'MONTH',
],
'TradePrice' => [
'description' => '实际价格，单位：元',
'type' => 'number',
'format' => 'float',
'example' => '19.80',
],
'OriginalPrice' => [
'description' => '原价，单位：元',
'type' => 'number',
'format' => 'float',
'example' => '198.00',
],
'Duration' => [
'description' => '周期数， 1，2，3...',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Currency' => [
'description' => '币种'."\n"
."\n"
.'CNY： 人民币'."\n"
.'USD： 美元'."\n"
.'JPY：日元',
'type' => 'string',
'example' => 'CNY',
],
'ExpressionMessage' => [
'description' => '限购描述',
'type' => 'string',
'example' => '企业用户才能购买',
],
'InfoTitle' => [
'description' => '活动名称',
'type' => 'string',
'example' => '新年特惠',
],
'ProductCode' => [
'description' => '商品 Code',
'type' => 'string',
'example' => 'cmgj01****',
],
'PromotionRules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PromotionRule' => [
'description' => '优惠信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Title' => [
'description' => '优惠标题',
'type' => 'string',
'example' => '展示型首年19.8元',
],
'Name' => [
'description' => '优惠内容',
'type' => 'string',
'example' => '展示型首年19.8元',
],
'RuleId' => [
'description' => '优惠ID',
'type' => 'string',
'example' => '102112',
],
],
],
],
],
],
'Coupons' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Coupon' => [
'description' => '优惠券信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CouponOptionCode' => [
'description' => '优惠券类型',
'type' => 'string',
'example' => 'ActiveCoupon',
],
'CouponOptionNo' => [
'description' => '优惠券编号',
'type' => 'string',
'example' => '3874923111',
],
'CouponName' => [
'description' => '优惠券名称',
'type' => 'string',
'example' => '促销',
],
'CouponDesc' => [
'description' => '优惠券描述',
'type' => 'string',
'example' => '促销',
],
'IsSelected' => [
'description' => '是否选中',
'type' => 'boolean',
'example' => 'false',
],
'CanPromFee' => [
'description' => '可优惠价格',
'type' => 'number',
'format' => 'float',
'example' => '100.00',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
[
[
'errorCode' => 'DownstreamError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
[
[
'errorCode' => 'ReturnNull',
'errorMessage' => 'No results found.',
],
],
999999 => [
[
'errorCode' => 'IgnoreError',
'errorMessage' => 'The specified parameter is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ExpressionCode\\": \\"ORDER.NO_REAL_NAME_AUTHENTICATION\\",\\n \\"Cuxiao\\": true,\\n \\"DiscountPrice\\": 178.2,\\n \\"Cycle\\": \\"MONTH\\",\\n \\"TradePrice\\": 19.8,\\n \\"OriginalPrice\\": 198,\\n \\"Duration\\": 1,\\n \\"Currency\\": \\"CNY\\",\\n \\"ExpressionMessage\\": \\"企业用户才能购买\\",\\n \\"InfoTitle\\": \\"新年特惠\\",\\n \\"ProductCode\\": \\"cmgj01****\\",\\n \\"PromotionRules\\": {\\n \\"PromotionRule\\": [\\n {\\n \\"Title\\": \\"展示型首年19.8元\\",\\n \\"Name\\": \\"展示型首年19.8元\\",\\n \\"RuleId\\": \\"102112\\"\\n }\\n ]\\n },\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"CouponOptionCode\\": \\"ActiveCoupon\\",\\n \\"CouponOptionNo\\": \\"3874923111\\",\\n \\"CouponName\\": \\"促销\\",\\n \\"CouponDesc\\": \\"促销\\",\\n \\"IsSelected\\": false,\\n \\"CanPromFee\\": 100\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n false\\n Month\\n 0\\n 1\\n 0\\n cmgj01****\\n 0\\n","errorExample":""}]',
'title' => '查询对应商品的价格信息',
],
'DescribeProduct' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AliUid',
'in' => 'query',
'schema' => [
'description' => 'AliUid',
'type' => 'string',
'required' => false,
'example' => '190********569',
],
],
[
'name' => 'Code',
'in' => 'query',
'schema' => [
'description' => '商品对应商品码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cmjj01**45',
],
],
[
'name' => 'QueryDraft',
'in' => 'query',
'schema' => [
'description' => '是否查询商品草稿，通常不需要查询商品草稿，商品草稿适用于在商品正式上架售卖之前查询。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'FrontCategoryId' => [
'description' => '商品类目 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '523617212',
],
'Status' => [
'description' => '已废弃',
'type' => 'string',
'example' => '1',
],
'Type' => [
'description' => '商品类型。取值：'."\n"
."\n"
.'* APP：应用类'."\n"
.'* DOWNLOAD： 下载类'."\n"
.'* MIRROR： 镜像类'."\n"
.'* SERVICE： 服务类'."\n"
.'* API_SERVICE： api类',
'type' => 'string',
'example' => 'MIRROR',
],
'PicUrl' => [
'description' => '商品图片 URL',
'type' => 'string',
'example' => 'https://oss.aliyuncs.com/photogallery/photo/1930532890589852/6245/495d5f19-03e4-4c2e-9c4e-bef9ab6af1e1.png',
],
'Score' => [
'description' => '商品评分',
'type' => 'number',
'format' => 'float',
'example' => '5.0',
],
'UseCount' => [
'description' => '使用计数',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'GmtModified' => [
'description' => '更改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578931200000',
],
'SupplierPk' => [
'description' => '服务商 UID',
'type' => 'integer',
'format' => 'int64',
'example' => '1526111111****',
],
'GmtCreated' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578931200000',
],
'RequestId' => [
'description' => '请求 ID',
'type' => 'string',
'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
],
'ShortDescription' => [
'description' => '商品简介',
'type' => 'string',
'example' => '该镜像为LNMP（Ubuntu16.04 64位+Nginx+MySQL5.6+PHP5.3）',
],
'Description' => [
'description' => '商品详情描述，支持 HTML。',
'type' => 'string',
'example' => '基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！
',
],
'Code' => [
'description' => '商品对应商品码',
'type' => 'string',
'example' => 'cmjj01**45',
],
'AuditFailMsg' => [
'description' => '审核失败原因，QueryDraft = true 时返回。',
'type' => 'string',
'example' => '功能验收不通过',
],
'Name' => [
'description' => '商品名称',
'type' => 'string',
'example' => 'LNMP环境（Ubuntu16.04 Nginx PHP5.3）',
],
'AuditTime' => [
'description' => '审核时间，QueryDraft = true 时返回。',
'type' => 'integer',
'format' => 'int64',
'example' => '1581609600000',
],
'AuditStatus' => [
'description' => '审核状态，QueryDraft = true 时返回。'."\n"
.'- draft：未提交'."\n"
.'- security_ing：安全审核中'."\n"
.'- security_fail：安全审核失败'."\n"
.'- function_ing：功能审核中'."\n"
.'- function_fail：功能审核失败'."\n"
.'- info_ing：商品信息审核中'."\n"
.'- info_fail：商品信息审核失败'."\n"
.'- success：成功'."\n",
'type' => 'string',
'example' => 'function_fail',
],
'ShopInfo' => [
'description' => '店铺信息',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '店铺名称',
'type' => 'string',
'example' => '**科学公司',
],
'Emails' => [
'description' => '邮箱',
'type' => 'string',
'example' => '46**41@example.com',
],
'Id' => [
'description' => '店铺 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'WangWangs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WangWang' => [
'description' => '旺旺',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Remark' => [
'description' => '备注',
'type' => 'string',
'example' => '123',
],
'UserName' => [
'description' => '旺旺用户名',
'type' => 'string',
'example' => 'ABC',
],
],
],
],
],
],
'Telephones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Telephone' => [
'type' => 'array',
'items' => [
'description' => '电话',
'type' => 'string',
'example' => '{1386658****, 1386658****}',
],
],
],
],
],
],
'ProductSkus' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ProductSku' => [
'description' => '商品规格信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Hidden' => [
'description' => '是否隐藏',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '规格码',
'type' => 'string',
'example' => 'cmjj01****-Package',
],
'Constraints' => [
'description' => '规格模块约束，支持 JSON 格式。',
'type' => 'string',
'example' => '{\\"img_id\\":{\\"img_version|img_region\\":{\\"V1.7|cn-shenzhen-st3-a01\\":[\\"m-wz9ho4hmos0lpxcldqoq\\"]}}',
],
'Name' => [
'description' => '规格名称',
'type' => 'string',
'example' => '21',
],
'ChargeType' => [
'description' => '付费方式：'."\n"
."\n"
.'* POSTPAY：后付费'."\n"
.'* PREPAY：预付费'."\n",
'type' => 'string',
'example' => 'PREPAY',
],
'OrderPeriods' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OrderPeriod' => [
'description' => '可订购周期',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '订购周期名称',
'type' => 'string',
'example' => '小时',
],
'PeriodType' => [
'description' => '预付费时间单位',
'type' => 'string',
'example' => 'HOUR',
],
],
],
],
],
],
'Modules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Module' => [
'description' => '规格模块信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '规格模块 Code',
'type' => 'string',
'example' => 'img_id',
],
'Name' => [
'description' => '模块名称',
'type' => 'string',
'example' => '镜像ID',
],
'Id' => [
'description' => '模块 ID',
'type' => 'string',
'example' => '248220',
],
'Properties' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Property' => [
'description' => '模块可选值',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '英文名称',
'type' => 'string',
'example' => 'img_id',
],
'ShowType' => [
'description' => '展示样式类型。取值：'."\n"
.'- number： 数字'."\n"
.'- string: 字符串'."\n"
.'- radio：单选',
'type' => 'string',
'example' => 'number',
],
'Name' => [
'description' => '中文名称',
'type' => 'string',
'example' => '镜像ID',
],
'DisplayUnit' => [
'description' => '显示单位',
'type' => 'string',
'example' => '1',
],
'PropertyValues' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PropertyValue' => [
'description' => '属性值',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '展示名称',
'type' => 'string',
'example' => '华北 1_V1.1',
],
'Type' => [
'description' => '属性值类型',
'type' => 'string',
'example' => 'single_string',
],
'Step' => [
'description' => '步进',
'type' => 'string',
'example' => '1',
],
'Value' => [
'description' => '属性值',
'type' => 'string',
'example' => 'm-28e213e7t',
],
'Max' => [
'description' => '最大',
'type' => 'string',
'example' => '123',
],
'Remark' => [
'description' => '备注',
'type' => 'string',
'example' => 'abc',
],
'Min' => [
'description' => '最小',
'type' => 'string',
'example' => '11',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'ProductExtras' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ProductExtra' => [
'description' => '商品附加信息：'."\n"
."\n"
.'* 产品亮点 product_advantage'."\n"
.'* 产品截图 product_shot'."\n"
.'* 使用指南 product_guide'."\n"
.'* 售后支持范围 product_support'."\n"
.'* 产品资质 product_aptitude'."\n"
.'* 产品说明 product_direction'."\n"
.'* 客户案例 product_case'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '扩展项类型：'."\n"
."\n"
.'* HTML'."\n"
.'* LIST'."\n"
.'* JSON'."\n"
.'* SLIDER'."\n"
.'* LINK'."\n"
.'* IMG'."\n",
'type' => 'string',
'example' => 'HTML',
],
'Key' => [
'description' => '扩展项英文标识',
'type' => 'string',
'example' => 'product_advantage',
],
'Label' => [
'description' => '扩展项中文标识',
'type' => 'string',
'example' => '产品亮点',
],
'Order' => [
'description' => '排序',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Values' => [
'description' => '扩展项数据值',
'type' => 'string',
'example' => '\\"1. 基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！\\"',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DeniedModify',
'errorMessage' => 'You are not authorized to call the specified API operation.',
],
],
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"FrontCategoryId\\": 523617212,\\n \\"Status\\": \\"1\\",\\n \\"Type\\": \\"MIRROR\\",\\n \\"PicUrl\\": \\"https://oss.aliyuncs.com/photogallery/photo/1930532890589852/6245/495d5f19-03e4-4c2e-9c4e-bef9ab6af1e1.png\\",\\n \\"Score\\": 5,\\n \\"UseCount\\": 10,\\n \\"GmtModified\\": 1578931200000,\\n \\"SupplierPk\\": 0,\\n \\"GmtCreated\\": 1578931200000,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"ShortDescription\\": \\"该镜像为LNMP（Ubuntu16.04 64位+Nginx+MySQL5.6+PHP5.3）\\",\\n \\"Description\\": \\"基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！
\\",\\n \\"Code\\": \\"cmjj01**45\\",\\n \\"AuditFailMsg\\": \\"功能验收不通过\\",\\n \\"Name\\": \\"LNMP环境（Ubuntu16.04 Nginx PHP5.3）\\",\\n \\"AuditTime\\": 1581609600000,\\n \\"AuditStatus\\": \\"function_fail\\",\\n \\"ShopInfo\\": {\\n \\"Name\\": \\"**科学公司\\",\\n \\"Emails\\": \\"46**41@example.com\\",\\n \\"Id\\": 123,\\n \\"WangWangs\\": {\\n \\"WangWang\\": [\\n {\\n \\"Remark\\": \\"123\\",\\n \\"UserName\\": \\"ABC\\"\\n }\\n ]\\n },\\n \\"Telephones\\": {\\n \\"Telephone\\": [\\n \\"{1386658****, 1386658****}\\"\\n ]\\n }\\n },\\n \\"ProductSkus\\": {\\n \\"ProductSku\\": [\\n {\\n \\"Hidden\\": true,\\n \\"Code\\": \\"cmjj01****-Package\\",\\n \\"Constraints\\": \\"{\\\\\\\\\\\\\\"img_id\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"img_version|img_region\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"V1.7|cn-shenzhen-st3-a01\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"m-wz9ho4hmos0lpxcldqoq\\\\\\\\\\\\\\"]}}\\",\\n \\"Name\\": \\"21\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"OrderPeriods\\": {\\n \\"OrderPeriod\\": [\\n {\\n \\"Name\\": \\"小时\\",\\n \\"PeriodType\\": \\"HOUR\\"\\n }\\n ]\\n },\\n \\"Modules\\": {\\n \\"Module\\": [\\n {\\n \\"Code\\": \\"img_id\\",\\n \\"Name\\": \\"镜像ID\\",\\n \\"Id\\": \\"248220\\",\\n \\"Properties\\": {\\n \\"Property\\": [\\n {\\n \\"Key\\": \\"img_id\\",\\n \\"ShowType\\": \\"number\\",\\n \\"Name\\": \\"镜像ID\\",\\n \\"DisplayUnit\\": \\"1\\",\\n \\"PropertyValues\\": {\\n \\"PropertyValue\\": [\\n {\\n \\"DisplayName\\": \\"华北 1_V1.1\\",\\n \\"Type\\": \\"single_string\\",\\n \\"Step\\": \\"1\\",\\n \\"Value\\": \\"m-28e213e7t\\",\\n \\"Max\\": \\"123\\",\\n \\"Remark\\": \\"abc\\",\\n \\"Min\\": \\"11\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"ProductExtras\\": {\\n \\"ProductExtra\\": [\\n {\\n \\"Type\\": \\"HTML\\",\\n \\"Key\\": \\"product_advantage\\",\\n \\"Label\\": \\"产品亮点\\",\\n \\"Order\\": 0,\\n \\"Values\\": \\"\\\\\\\\\\\\\\"1. 基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！\\\\\\\\\\\\\\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n<p>aaa</p>\\nAPP\\nhttps://photogallery.oss.aliyuncs.com/photo/1666562244190862/17909/ce4e8f40-1d3e-465d-b884-f78a432cde81.jpg\\ncmgj02****\\n\\n \\n \\"aaa\\"\\n product_advantage\\n HTML\\n 0\\n \\n \\n \\n \\n [\\"Windows\\"]\\n \\n \\n \\n aa\\n \\n \\n \\n 应用软件类\\n \\n \\n product_param\\n LIST\\n 15\\n \\n \\n\\nV3【回归】服务类-按周期\\naaa\\n\\n \\n 1581016*****\\n \\n ****有限公司测试\\n ***.dxz@***.com\\n \\n \\n 凌鲲\\n 凌鲲\\n \\n \\n 1597411\\n\\n\\n \\n PREPAY\\n 预付费\\n \\n \\n 一年\\n YEAR\\n \\n \\n \\n \\n 几号数\\n 1018040000484633\\n AC\\n \\n \\n 几号数\\n AC\\n 个\\n \\n \\n 1\\n range_float\\n 999\\n 1\\n \\n \\n 1\\n range_float\\n 999999999999999\\n 999\\n \\n \\n number\\n \\n \\n \\n \\n 购买个数\\n 1018040000484634\\n order_num\\n \\n \\n 购买个数\\n order_num\\n \\n \\n \\n 1\\n range_float\\n 100\\n 1\\n \\n \\n number\\n \\n \\n \\n \\n 购买时长\\n 1018040000484740\\n ord_time\\n \\n \\n 购买时长\\n ord_time\\n \\n \\n \\n 1:Month\\n single_string\\n 1个月\\n \\n \\n 2:Month\\n single_string\\n 2个月\\n \\n \\n 3:Month\\n single_string\\n 3个月\\n \\n \\n 4:Month\\n single_string\\n 4个月\\n \\n \\n 5:Month\\n single_string\\n 5个月\\n \\n \\n 6:Month\\n single_string\\n 6个月\\n \\n \\n 7:Month\\n single_string\\n 7个月\\n \\n \\n 8:Month\\n single_string\\n 8个月\\n \\n \\n 9:Month\\n single_string\\n 9个月\\n \\n \\n 10:Month\\n single_string\\n 10个月\\n \\n \\n 11:Month\\n single_string\\n 11个月\\n \\n \\n 1:Year\\n single_string\\n 1年\\n \\n \\n 2:Year\\n single_string\\n 2年\\n \\n \\n 3:Year\\n single_string\\n 3年\\n \\n \\n radio\\n \\n \\n \\n \\n 套餐配置\\n 1018040000484632\\n package_config\\n \\n \\n 套餐配置\\n package_config\\n \\n \\n \\n yuncode2138100001\\n single_string\\n {\\"frontShow\\":true}\\n \\n \\n yuncode2138100002\\n single_string\\n {\\"frontShow\\":true}\\n \\n \\n yuncode2138100003\\n single_string\\n {\\"frontShow\\":true}\\n \\n \\n string\\n \\n \\n \\n \\n 套餐版本\\n 1018040000484631\\n package_version\\n \\n \\n 套餐版本\\n package_version\\n \\n \\n \\n yuncode2138100001\\n single_string\\n 月版\\n \\n \\n yuncode2138100002\\n single_string\\n 年版\\n \\n \\n yuncode2138100003\\n single_string\\n 年月版\\n \\n \\n radio\\n \\n \\n \\n \\n {\\"AC\\":{\\"package_version\\":{\\"yuncode2138100003\\":[{\\"min\\":1,\\"max\\":999999999999999,\\"step\\":1}]}},\\"ord_time\\":{\\"package_version\\":{\\"yuncode2138100001\\":[\\"1:Month\\",\\"2:Month\\",\\"3:Month\\",\\"4:Month\\",\\"5:Month\\",\\"6:Month\\",\\"7:Month\\",\\"8:Month\\",\\"9:Month\\",\\"10:Month\\",\\"11:Month\\"],\\"yuncode2138100002\\":[\\"1:Year\\",\\"2:Year\\",\\"3:Year\\"],\\"yuncode2138100003\\":[\\"1:Month\\",\\"2:Month\\",\\"3:Month\\",\\"4:Month\\",\\"5:Month\\",\\"6:Month\\",\\"7:Month\\",\\"8:Month\\",\\"9:Month\\",\\"10:Month\\",\\"11:Month\\",\\"1:Year\\",\\"2:Year\\",\\"3:Year\\"]}}}\\n false\\n cmgj02****-prepay\\n \\n\\n0\\n152611111****\\n523617212\\n","errorExample":""}]',
'title' => '用于查询指定商品的详细信息',
'summary' => '调用 DescribeProduct 用于查询指定商品的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeProducts' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'SearchTerm',
'in' => 'query',
'schema' => [
'description' => '搜索词',
'type' => 'string',
'required' => false,
'example' => '镜像',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示商品数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '过滤条件列表。'."\n"
."\n\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '搜索标签类别，取值：'."\n"
."\n"
.'* sort：排序方式'."\n"
.'* categoryId：类目 ID'."\n"
.'* productType：商品类型'."\n"
.'* aliyunUid：商品所属服务商的阿里云主账号Uid',
'type' => 'string',
'required' => false,
'example' => 'categoryId',
],
'Value' => [
'description' => '搜索标签取值：'."\n"
."\n\n"
.'- sort'."\n"
.' - user_count-desc：近180天成交数'."\n"
.' - created_on-desc：创建时间'."\n"
.' - price-desc：价格'."\n"
.' - score-desc：评分'."\n"
."\n"
.'- categoryId '."\n"
.' - 软件市场 53366009'."\n"
.' + 运行环境 53448001'."\n"
.' - 管理与监控 53690006'."\n"
.' - 建站系统 53616009'."\n"
.' - 应用开发 55530001'."\n"
.' - 数据库 56024006'."\n"
.' - 服务器软件 56014009'."\n"
.' - 网络功能软件 56368007'."\n"
.' - 操作系统 57742013'."\n"
.' - 服务市场 52734001'."\n"
.' - 数据迁移 52738004'."\n"
.' - 环境配置 52746001'."\n"
.' - 故障排查 52740002'."\n"
.' - 安全代维 52732002'."\n"
.' - 定制开发 56082003'."\n"
.' - 培训与认证 57252001'."\n"
.' - 专线接入 57392001'."\n"
.' - 企业服务 56838014'."\n"
.' - 安全服务 57004003'."\n"
.' - 建站市场 52738001'."\n"
.' - 企业展示 52738005'."\n"
.' - 电子商务 52750001'."\n"
.' - 手机网站 52752001'."\n"
.' - 设计 52732003'."\n"
.' - 信息门户 52744002'."\n"
.' - 售后服务 52744003'."\n"
.' - 社区论坛 55586021'."\n"
.' - 移动营销 55514022'."\n"
.' - 模板网站 56598032'."\n"
.' - 网站空间 57342011'."\n"
.' - 云安全市场 56764045'."\n"
.' + 主机安全 56832023'."\n"
.' + 应用安全 56846020'."\n"
.' + 数据安全 56824015'."\n"
.' + 安全管理 56830014'."\n"
.' + 网络安全 56820014'."\n"
.' - 企业应用 56832009'."\n"
.' - 办公管理 56778013'."\n"
.' - 财务管理 56764034'."\n"
.' - 人事管理 56780006'."\n"
.' - 销售管理 56842010'."\n"
.' - 广告营销 56842011'."\n"
.' - 外贸业务 56790007'."\n"
.' - 云通信 57602001'."\n"
.' - 供应链管理 57604001'."\n"
.' - 数据服务 57606001'."\n"
.' - 解决方案 56848023'."\n"
.' - 电商 56848024'."\n"
.' - 金融 56820017'."\n"
.' - 物流 56776025'."\n"
.' - 政务 56842031'."\n"
.' - 多媒体 56784018'."\n"
.' - 物联网 56794026'."\n"
.' - 大数据 56792022'."\n"
.' - API市场 56956004'."\n"
.' - 电子商务 56928004'."\n"
.' - 金融理财 57000002'."\n"
.' - 交通地理 57002002'."\n"
.' - 企业管理 56928005'."\n"
.' - 公共事务 57002003'."\n"
.' - 气象水利 57096001'."\n"
.' - 人工智能 57124001'."\n"
.' - 生活服务 57126001'."\n"
.' - 物联网市场 201194001'."\n"
.' - 集成系统 201196001'."\n"
.' - 智能硬件 201198001'."\n"
.' - 模组 201200001'."\n"
.' - 传感器 201192002'."\n"
.' - 芯片 201202001'."\n"
.' - 物联网应用 201196002'."\n"
.' - 物联服务 201196003'."\n"
.' - 数据智能 201204005'."\n"
.' - 数据分析及展现 201190008'."\n"
.' - 舆情分析 201198004'."\n"
.' - 电商与营销 201202006'."\n"
.' - 人工智能 201204006'."\n"
.' - 气象交通 201214006'."\n"
.' - 金融财务 201208013'."\n"
.'- productType:'."\n"
.' - APP：应用类'."\n"
.' - SERVICE：服务类'."\n"
.' - MIRROR：镜像类'."\n"
.' - DOWNLOAD：下载类'."\n"
.' - API_SERVICE：API 类'."\n",
'type' => 'string',
'required' => false,
'example' => '53366009',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求 ID',
'type' => 'string',
'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817',
],
'PageNumber' => [
'description' => '当前页数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页显示商品数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '符合搜索条件的商品数',
'type' => 'integer',
'format' => 'int32',
'example' => '75',
],
'ProductItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ProductItem' => [
'description' => '商品信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PriceInfo' => [
'description' => '价格信息。',
'type' => 'string',
'example' => '{\'DiscountPrice\': 0.0, \'TradePrice\': 15750.0, \'Currency\': \'CNY\', \'OriginalPrice\': 15750.0, \'RuleIds\': {\'RuleId\': []}, \'Coupons\': {\'Coupon\': []}}',
],
'DeliveryWay' => [
'description' => '交付方式',
'type' => 'string',
'example' => '镜像',
],
'ImageUrl' => [
'description' => '图片 URL',
'type' => 'string',
'example' => 'https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png',
],
'WarrantyDate' => [
'description' => '质保时间',
'type' => 'string',
'example' => '1天',
],
'Tags' => [
'description' => '产品标签',
'type' => 'string',
'example' => '企业,上云,Windows,Windows server 2012,Apache,Nginx,Windows面板',
],
'Score' => [
'description' => '评分',
'type' => 'string',
'example' => '5.0',
],
'SupplierId' => [
'description' => '供应商 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '228399',
],
'OperationSystem' => [
'description' => '交付时间',
'type' => 'string',
'example' => 'windows',
],
'ShortDescription' => [
'description' => '商品简介',
'type' => 'string',
'example' => '【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务，应用标准化全自动服务流程体系，帮助企业轻松拥有官方网站。该建站产品与ECS下单时同时购买，ECS最低配置1核1G即可。购买须知：请在购买ECS配置安全组时选择HTTP：80端口 ...',
],
'DeliveryDate' => [
'description' => '交付时间',
'type' => 'string',
'example' => '1天',
],
'TargetUrl' => [
'description' => '详情页URL',
'type' => 'string',
'example' => '/products/53616009/cmjj02****.html',
],
'Code' => [
'description' => '商品码',
'type' => 'string',
'example' => 'cmjj02****',
],
'CategoryId' => [
'description' => '类目 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '53398003',
],
'Name' => [
'description' => '商品名称',
'type' => 'string',
'example' => 'PHP多版本环境（Windows2012 | phpStudy）',
],
'SuggestedPrice' => [
'description' => '建议价格',
'type' => 'string',
'example' => '10元/月',
],
'SupplierName' => [
'description' => '供应商名称',
'type' => 'string',
'example' => '长沙****有限公司',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
[
'errorCode' => 'Invalid.CategoryId',
'errorMessage' => 'The specified CategoryId is invalid.',
],
[
'errorCode' => 'Invalid.Sort',
'errorMessage' => 'The specified Sort is invalid.',
],
[
'errorCode' => 'Invalid.Param',
'errorMessage' => 'The specified Filter key is invalid.',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A077D99E-0C4D-421E-A5D4-F533F6657817\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 75,\\n \\"ProductItems\\": {\\n \\"ProductItem\\": [\\n {\\n \\"PriceInfo\\": \\"{\'DiscountPrice\': 0.0, \'TradePrice\': 15750.0, \'Currency\': \'CNY\', \'OriginalPrice\': 15750.0, \'RuleIds\': {\'RuleId\': []}, \'Coupons\': {\'Coupon\': []}}\\",\\n \\"DeliveryWay\\": \\"镜像\\",\\n \\"ImageUrl\\": \\"https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png\\",\\n \\"WarrantyDate\\": \\"1天\\",\\n \\"Tags\\": \\"企业,上云,Windows,Windows server 2012,Apache,Nginx,Windows面板\\",\\n \\"Score\\": \\"5.0\\",\\n \\"SupplierId\\": 228399,\\n \\"OperationSystem\\": \\"windows\\",\\n \\"ShortDescription\\": \\"【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务，应用标准化全自动服务流程体系，帮助企业轻松拥有官方网站。该建站产品与ECS下单时同时购买，ECS最低配置1核1G即可。购买须知：请在购买ECS配置安全组时选择HTTP：80端口 ...\\",\\n \\"DeliveryDate\\": \\"1天\\",\\n \\"TargetUrl\\": \\"/products/53616009/cmjj02****.html\\",\\n \\"Code\\": \\"cmjj02****\\",\\n \\"CategoryId\\": 53398003,\\n \\"Name\\": \\"PHP多版本环境（Windows2012 | phpStudy）\\",\\n \\"SuggestedPrice\\": \\"10元/月\\",\\n \\"SupplierName\\": \\"长沙****有限公司\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n1\\n10\\n\\n 53398003\\n PHP多版本环境（Windows2012 | phpStudy）\\n PHP多版本环境（Windows2012 | phpStudy）\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png\\n Windows2008 R2 企业版 64位\\n 5.0\\n 由Websof9提供的phpStudy镜像是一个预安装环境，可在<em>ECS</em>上一键安装。phpStudy是一个PHP环境集成包，支持php5.2到7.0多个版本切换，同时支持Apache,Nginx,IIS ...\\n 10元/月\\n 228399\\n 长沙****有限公司\\n 企业,上云,Windows,Windows server 2012,Apache,Nginx,Windows面板\\n\\n\\n 56014009\\n Pydio 开源在线文件管理系统（构建企业网盘和云存储系统）\\n Pydio 开源在线文件管理系统（构建企业网盘和云存储系统）\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7049/47bde5de-8610-439f-a160-1eb34aec5505.png\\n CentOS7.0 64位\\n 5.0\\n 由Websof9提供的Pydio镜像是一个预安装环境，可在<em>ECS</em>上一键安装。Pydio是功能强大在线文件管理系统（ECM），用于构建自托管的企业网盘和云存储系统，支持多用户的文档协作、分享、设备同步。 ...\\n 10元/月\\n 228399\\n 长沙****有限公司\\n 企业,应用开发,Linux,Centos,PHP,LAMP\\n\\n\\n 53616009\\n Joomla! 内容管理系统( WAMP )\\n Joomla! 内容管理系统( WAMP )\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/5280/fab724de-da66-4548-9717-1a1d3ac6f887.png\\n Windows2008 64位 标准版\\n 5.0\\n 由Websof9提供的Joomla3.7.5预装环境，可在<em>ECS</em>上一键安装。Joomla是全球三大开源内容管理系统之一（CMS），比肩WordPress和Drupal，占据全球5%的建站市场。 ...\\n 10元/月\\n 228399\\n 长沙****有限公司\\n 开发者,建站,Windows,Windows server 2008,PHP,WAMP,Joomla!\\n\\n\\n 53690006\\n Ubuntu 16.04 64位（含Webmin中文）\\n Ubuntu 16.04 64位（含Webmin中文）\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/4613/57259fc6-7086-42b8-9619-f688fd3eb310.png\\n 5.0\\n 由Websoft9提供Ubuntu 16.04+Webmin1.881（中文）镜像，可以一键安装到<em>ECS</em>。Webmin是知名的Linux可视化面板管理工具，100%免费开源，可轻松管理文件、配置域名、修改配置文件、备份数据等 ...\\n 10元/月\\n 228399\\n 长沙****有限公司\\n 站长,上云,Linux,Centos,LAMP,Webmin,Linux面板\\n\\n\\n 53616009\\n 云·企业官网尊贵版（ECS）\\n 云·企业官网尊贵版（ECS）\\n 镜像\\n https://photogallery.oss.aliyuncs.com/photo/1984723351411381/22286/727fc507-37b5-4b91-b706-8bbc2a765a88.jpg\\n windows\\n 5.0\\n 【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务，应用标准化全自动服务流程体系，帮助企业轻松拥有官方网站。该建站产品与<em>ECS</em>下单时同时购买，<em>ECS</em>最低配置1核1G即可。购买须知：请在购买<em>ECS</em>配置安全组时选择HTTP：80端口 ...\\n 998元/月\\n 3587828\\n **-云市场自营店\\n 企业,建站\\n\\n\\n 56014009\\n Zurmo 开源CRM系统（LAMP）\\n Zurmo 开源CRM系统（LAMP）\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7716/6b100770-1f15-43c6-b99f-9b6c53c89e2d.png\\n CentOS7.4 64位\\n 5.0\\n 由Websof9提供的Zurmo镜像是一个预安装环境，可在<em>ECS</em>上一键安装。Zurmo是一个开源的客户关系管理系统(CRM)，使用Yii框架、RedBeanPHP和Jquery实现，界面美观，功能全面 ...\\n 20元/月\\n 228399\\n 长沙****有限公司\\n 企业,上云,Linux,Centos,PHP,LAMP,ERP\\n\\n\\n 56014009\\n SuiteCRM，优质开源CRM\\n SuiteCRM，优质开源CRM\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7760/0db05f1e-aa8a-490d-b8eb-093c43d93f7d.png\\n CentOS7.3 64位\\n 5.0\\n 由Websof9提供的EspoCRM预装环境，可在<em>ECS</em>上一键安装。SuiteCRM是一个国际上屡获殊荣的企业级的、强大的、可定制的，免费的CRM系统。 ...\\n 20元/月\\n 228399\\n 长沙****有限公司\\n 企业,移动营销,Linux,Centos,PHP,LAMP,ERP\\n\\n\\n 55528001\\n Node.JS6 运行环境（Windows2008 | Nginx | Express）\\n Node.JS6 运行环境（Windows2008 | Nginx | Express）\\n 镜像\\n https://photogallery.oss.aliyuncs.com/photo/1904996544835414/7573/e03da499-c7e9-4784-867f-8789539e6a82.png\\n 5.0\\n Websoft9提供Node.JS镜像，预装了NodeJS 6.14,PM2 2.10,Express框架,Yarn1.7,MySQL5.6,MongoDB4.0,Nginx1.14，任何<em>ECS</em>用户可以一键获取，用于快速部署Node.JS应用程序。 ...\\n 0元/月\\n 228399\\n 长沙****有限公司\\n 企业,上云,Windows,Windows server 2008,Node.js,Nginx,MySQL\\n\\n\\n 56014009\\n ERPNext 中小企业开源ERP系统（Ubuntu16.04）\\n ERPNext 中小企业开源ERP系统（Ubuntu16.04）\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7259/cdee958f-bcfa-4362-ad2f-543e01140e60.png\\n 5.0\\n 由Websof9提供的Vtiger CRM预装环境，可在<em>ECS</em>上一键安装。ERPNext是全球化的开源ERP系统，使用Python语言开发，支持70+种语言，拥有150+国家的用户。界面友好，入门简单，包括：财务、采购、销售和库存管理、POS系统、制造管理、资产管理等功能。 ...\\n 10元/月\\n 228399\\n 长沙****有限公司\\n 企业,上云,Linux,Ubuntu,Python,ERP\\n\\n\\n 55530001\\n Gitlab-CE10.1.0 代码托管系统（Ubuntu16）\\n Gitlab-CE10.1.0 代码托管系统（Ubuntu16）\\n 镜像\\n https://oss.aliyuncs.com/photogallery/photo/1904996544835414/17080/cd8053ae-2666-4716-9e4d-1b754f24fbc2.png\\n Ubuntu16.04 64位\\n 5.0\\n 由Websof9提供的Omnibus Gitlab镜像是一个预安装环境，可在<em>ECS</em>上一键安装。Gitlab是一个开源的Git代码仓库系统，用于构建私有代码托管平台，基于Rails开发，速度快、安全稳定 ...\\n 10元/月\\n 228399\\n 长沙****有限公司\\n 开发者,应用开发,Linux,Ubuntu,Ruby,Nginx,PostgreSQL\\n\\n5A85CB8D-EF2F-46DA-91E2-8AF75900F1BF\\n75\\n","errorExample":""}]',
'title' => 'DescribeProducts',
'summary' => '调用 DescribeProducts 拉取符合条件的商品列表及详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeOrderForIsv' => [
'summary' => '服务商侧查询订单详情',
'path' => '',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '订单id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '202*********415',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'ProductName' => [
'title' => '订购商品名称',
'description' => '订购商品名称',
'type' => 'string',
'example' => 'saas服务产品',
],
'OriginalPrice' => [
'title' => '订单原价（元）',
'description' => '订单原价（元）',
'type' => 'number',
'format' => 'float',
'example' => '10.0',
],
'AliUid' => [
'title' => '阿里云用户唯一标识（aliyunPK）',
'description' => '阿里云用户唯一标识（aliyunPK）',
'type' => 'integer',
'format' => 'int64',
'example' => '190311111111****',
],
'CouponPrice' => [
'title' => '已使用代金券金额（元）',
'description' => '已使用代金券金额（元）',
'type' => 'number',
'format' => 'float',
'example' => '0.0',
],
'AccountQuantity' => [
'title' => '账号数',
'description' => '账号数',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'PeriodType' => [
'title' => '预付费的时间单位。取值：'."\n"
.'● MONTH：单月'."\n"
.'● SEASON：季度'."\n"
.'● HALFYEAR：半年'."\n"
.'● YEAR：一年'."\n"
.'● TWOYEARS：两年'."\n"
.'● ONCE：单次',
'description' => '预付费的时间单位。取值：'."\n"
.'● MONTH：单月'."\n"
.'● SEASON：季度'."\n"
.'● HALFYEAR：半年'."\n"
.'● YEAR：一年'."\n"
.'● TWOYEARS：两年'."\n"
.'● ONCE：单次',
'type' => 'string',
'example' => 'MONTH',
],
'PayStatus' => [
'title' => '付款状态。取值：'."\n"
.'● PAID 已支付'."\n"
.'● UNPAID 未支付',
'description' => '付款状态。取值：'."\n"
.'● PAID 已支付'."\n"
.'● UNPAID 未支付',
'type' => 'string',
'example' => 'PAID',
],
'PaymentPrice' => [
'title' => '实际支付金额（元）',
'description' => '实际支付金额（元）',
'type' => 'number',
'format' => 'float',
'example' => '0.0',
],
'OrderStatus' => [
'title' => '订单状态。取值：'."\n"
.'● NORMAL 正常'."\n"
.'● REFUND 退款'."\n"
.'● DELETE 作废',
'description' => '订单状态。取值：'."\n"
.'● NORMAL 正常'."\n"
.'● REFUND 退款'."\n"
.'● DELETE 作废',
'type' => 'string',
'example' => 'NORMAL',
],
'ProductSkuCode' => [
'title' => '订购商品规格 Code',
'description' => '订购商品规格 Code',
'type' => 'string',
'example' => 'cmgj02****-prepay',
],
'PaidOn' => [
'title' => '付款时间',
'description' => '付款时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1531191675000',
],
'CreatedOn' => [
'title' => '下单时间',
'description' => '下单时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1531191564000',
],
'OrderType' => [
'title' => '订单类型。取值：'."\n"
.'● NEW 新购订单'."\n"
.'● RENEW 续费订单'."\n"
.'● TRIAL 试用订单',
'description' => '订单类型。取值：'."\n"
.'● NEW 新购订单'."\n"
.'● RENEW 续费订单'."\n"
.'● TRIAL 试用订单'."\n"
.'● UPGRADE 升级订单'."\n"
.'● DOWNGRADE 降配订单'."\n"
.'● PURCHASE 转正订单',
'type' => 'string',
'example' => 'NEW',
],
'TotalPrice' => [
'title' => '订单应收金额（元）',
'description' => '订单应收金额（元）',
'type' => 'number',
'format' => 'float',
'example' => '0.0',
],
'Quantity' => [
'title' => '订购数量',
'description' => '订购数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'OrderId' => [
'title' => '订单ID',
'description' => '订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '202211111111111',
],
'ProductCode' => [
'title' => '商品Code',
'description' => '商品Code',
'type' => 'string',
'example' => 'cmgj02****',
],
'InstanceIds' => [
'title' => '订单关联业务实例 ID',
'description' => 'List',
'type' => 'array',
'items' => [
'description' => '实例id',
'type' => 'string',
'example' => '1597985',
],
],
'RequestId' => [
'description' => '请求ID。用于出现错误后排查问题。'."\n",
'type' => 'string',
'example' => '6EF60BEC-****-****-****-270359FB54A7',
],
'Components' => [
'description' => '订单模块信息。示例中的参数说明如下：'."\n"
.'● package_quantity： 使用次数（API 商品特有模块）'."\n"
.'● package_version：版本'."\n"
.'● ord_time： 时长'."\n"
.'● order_num： 数量'."\n"
.'● code：模块 Code'."\n"
.'● globarKey： 模块 key'."\n"
.'● name： 模块名称'."\n"
.'● value： 模块值',
'type' => 'any',
'example' => '{"package_version":{"code":"package_version","globarKey":"cmgj0******8_package_version_package_version_yuncode4176*****1","name":"0.01","value":"yuncode4176*****1"},"ord_time":{"code":"ord_time","globarKey":"cmgj0******8_ord_time_ord_time_1:Month","name":"1个月","value":"1:Month"},"order_num":{"code":"order_num","globarKey":"cmgj0******8_order_num_order_num_1","name":"1","value":"1"}}',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ProductName\\": \\"saas服务产品\\",\\n \\"OriginalPrice\\": 10,\\n \\"AliUid\\": 0,\\n \\"CouponPrice\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"PeriodType\\": \\"MONTH\\",\\n \\"PayStatus\\": \\"PAID\\",\\n \\"PaymentPrice\\": 0,\\n \\"OrderStatus\\": \\"NORMAL\\",\\n \\"ProductSkuCode\\": \\"cmgj02****-prepay\\",\\n \\"PaidOn\\": 1531191675000,\\n \\"CreatedOn\\": 1531191564000,\\n \\"OrderType\\": \\"NEW\\",\\n \\"TotalPrice\\": 0,\\n \\"Quantity\\": 1,\\n \\"OrderId\\": 202211111111111,\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"InstanceIds\\": [\\n \\"1597985\\"\\n ],\\n \\"RequestId\\": \\"6EF60BEC-****-****-****-270359FB54A7\\",\\n \\"Components\\": \\"{\\\\\\"package_version\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"package_version\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_package_version_package_version_yuncode4176*****1\\\\\\",\\\\\\"name\\\\\\":\\\\\\"0.01\\\\\\",\\\\\\"value\\\\\\":\\\\\\"yuncode4176*****1\\\\\\"},\\\\\\"ord_time\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"ord_time\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_ord_time_ord_time_1:Month\\\\\\",\\\\\\"name\\\\\\":\\\\\\"1个月\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1:Month\\\\\\"},\\\\\\"order_num\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"order_num\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_order_num_order_num_1\\\\\\",\\\\\\"name\\\\\\":\\\\\\"1\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n saas服务产品\\n 10\\n 0\\n 0\\n MONTH\\n PAID\\n 0\\n NORMAL\\n cmgj02****-prepay\\n 1531191675000\\n 1531191564000\\n NEW\\n 0\\n 1\\n 202211111111111\\n cmgj02****\\n 1597985\\n 6EF60BEC-****-****-****-270359FB54A7\\n","errorExample":""}]',
'title' => '服务商侧查询订单详情',
],
'CreateOrder' => [
'summary' => '调用 CreateOrder 创建订单。'."\n"
."\n"
.'请确保在使用该接口前，已充分了解云市场产品的收费方式和价格。'."\n"
."\n"
.'商业镜像创建订单接口请参考 CreateInstance。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
'description' => '订单类型。 取值： '."\n"
.'- INSTANCE_BUY：商品购买 '."\n"
.'- INSTANCE_RENEW：实例续费 '."\n"
.'- INSTANCE_UPGRADE：实例升级'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INSTANCE_BUY',
],
],
[
'name' => 'Commodity',
'in' => 'query',
'schema' => [
'description' => '订单配件信息。 '."\n"
."\n"
.'可根据指定的 OrderType，使用对应的配件再进行序列化。'."\n"
."\n"
.'不同 OrderType 分别对应的 CommodityType 如下所示： '."\n"
.'* INSTANC_BUY：InstanceBuyCommodity'."\n"
.'* INSTANCE_RENEW：InstanceRenewCommodity'."\n"
.'* INSTANCE_UPGRADE：InstanceUpgradeCommodity'."\n"
."\n"
.'示例中的 Commodity 参数说明如下：'."\n"
.'- 必传参数'."\n"
.' - productCode：商品码'."\n"
.' - skuCode：商品规格码。预付费固定为 prepay，后付费固定为 postpay。'."\n"
.' - duration：周期数量 1，2，3...。'."\n"
.' - pricingCycle：周期单位。Day（日），Month（月），Year（年）。'."\n"
.' - components：规格模块。其中版本 package_version 必传，其他模块根据商品的设置来传。'."\n"
."\n"
.'- 可选参数'."\n"
.' - quantity：订购数量'."\n"
.' - queryPromotion：是否查询优惠'."\n"
.' - couponId：优惠卷 ID'."\n"
.' - properties：订单扩展属性字符串，JSON 的 dict 格式'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'InstanceBuyCommodity示例：{"components":{"package_version":"yuncode1394000000"},"duration":100,"pricingCycle":"Year","productCode":"cmfw019940","properties":{},"quantity":1,"skuCode":"cmfw019940-prepay"}；InstanceRenewCommodity示例：{“components”:{“package_version”:”yuncode1806900001”},”quantity”:1,”duration”:2,”instanceId”:”6227091”,”productCode”:”cmgj024069”,”pricingCycle”:”Month”,”properties”:{},”skuCode”:”cmgj024069-prepay”}；InstanceUpgradeCommodity示例：{“components”:{“package_version”:”yuncode1806900002”},”quantity”:1,”duration”:1,”instanceId”:”6227091”,”productCode”:”cmgj024069”,”pricingCycle”:”Month”,”properties”:{},”skuCode”:”cmgj024069-prepay”} ',
],
],
[
'name' => 'OrderSouce',
'in' => 'query',
'schema' => [
'description' => '订单来源（未启用）',
'type' => 'string',
'required' => false,
'example' => 'abc',
],
],
[
'name' => 'PaymentType',
'in' => 'query',
'schema' => [
'description' => '付款方式：'."\n"
.'* AUTO：余额自动支付'."\n"
.'* HAND：手动支付'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HAND',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。 '."\n"
.'由客户端生成该参数值，要保证在不同请求间唯一，最大不值过 64 个 ASCII 字符。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2709c68a-d569-4819-9c5d-1222ed2ee924',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单 ID',
'type' => 'string',
'example' => '202********0117',
],
'RequestId' => [
'description' => '请求 ID',
'type' => 'string',
'example' => '4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed',
],
'InstanceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceId' => [
'type' => 'array',
'items' => [
'description' => '实例 ID',
'type' => 'string',
'example' => '5604018',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"202********0117\\",\\n \\"RequestId\\": \\"4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"5604018\\"\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"004CDE94-C51C-4EBD-8D4A-8874888ECBDB\\",\\"HostId\\":\\"market.aliyuncs.com\\",\\"Code\\":\\"UnknownError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}\\n"},{"type":"xml","example":"\\n4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed\\n\\n 5604018\\n\\n202********0117\\n","errorExample":"904A07C3-D30A-4E2C-93B2-DDECAE4B66E8market.aliyuncs.comUnknownErrorThe request processing has failed due to some unknown error.\\n"}]',
'title' => '创建订单',
'description' => '请确保在使用该接口前，已充分了解云市场产品的收费方式和[价格](https://market.aliyun.com/)。'."\n"
."\n"
.'商业镜像创建订单接口请参考 [CreateInstance](https://help.aliyun.com/document_detail/25499.html)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeOrder' => [
'summary' => '调用 DescribeOrder 用于查询对应订单的详细信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '订单ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '202*********415',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ProductName' => [
'description' => '订购商品名称',
'type' => 'string',
'example' => 'saas服务产品',
],
'SupplierCompanyName' => [
'description' => '卖家公司名称',
'type' => 'string',
'example' => '**科技股份有限公司',
],
'OriginalPrice' => [
'description' => '订单原价（元）',
'type' => 'number',
'format' => 'float',
'example' => '10.0',
],
'AliUid' => [
'description' => '阿里云用户唯一标识（aliyunPK）',
'type' => 'integer',
'format' => 'int64',
'example' => '190311111111****',
],
'CouponPrice' => [
'description' => '已使用代金券金额（元）',
'type' => 'number',
'format' => 'float',
'example' => '0.0',
],
'AccountQuantity' => [
'description' => '账号数',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'PeriodType' => [
'description' => '预付费的时间单位。取值：'."\n"
."\n"
.'- MONTH：单月'."\n"
.'- SEASON：季度'."\n"
.'- HALFYEAR：半年'."\n"
.'- YEAR：一年'."\n"
.'- TWOYEARS：两年'."\n"
.'- ONCE：单次',
'type' => 'string',
'example' => 'MONTH',
],
'RequestId' => [
'description' => '请求 ID',
'type' => 'string',
'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
],
'PayStatus' => [
'description' => '付款状态。取值：'."\n"
."\n"
.'- PAID 已支付'."\n"
.'- UNPAID 未支付',
'type' => 'string',
'example' => 'PAID',
],
'PaymentPrice' => [
'description' => '实际支付金额（元）',
'type' => 'number',
'format' => 'float',
'example' => '0.0',
],
'OrderStatus' => [
'description' => '订单状态。取值：'."\n"
."\n"
.'- NORMAL 正常'."\n"
.'- REFUND 退款'."\n"
.'- DELETE 作废',
'type' => 'string',
'example' => 'NORMAL',
],
'ProductSkuCode' => [
'description' => '订购商品规格 Code',
'type' => 'string',
'example' => 'cmgj02****-prepay',
],
'PaidOn' => [
'description' => '付款时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1531191675000',
],
'Components' => [
'description' => '订单模块信息。示例中的参数说明如下：'."\n"
."\n"
.'- package_quantity： 使用次数（API 商品特有模块）'."\n"
.'- package_version：版本'."\n"
.'- ord_time： 时长'."\n"
.'- order_num： 数量'."\n"
.'- code：模块 Code'."\n"
.'- globarKey： 模块 key'."\n"
.'- name： 模块名称'."\n"
.'- value： 模块值',
'type' => 'object',
'example' => '{ "package_quantity": { "code": "package_quantity", "globarKey": "cmapi014302_package_quantity_package_quantity_10000", "name": "10000次", "value": "10000" }, "package_version": { "code": "package_version", "globarKey": "cmapi014302_package_version_package_version_yuncode830200000", "name": "0元／10000次", "value": "yuncode830200000" }, "ord_time": { "code": "ord_time", "globarKey": "cmapi014302_ord_time_ord_time_6:Month", "name": "6个月", "value": "6:Month" }, "order_num": { "code": "order_num", "globarKey": "cmapi014302_order_num_order_num_1", "name": "1", "value": "1" } }',
],
'CreatedOn' => [
'description' => '下单时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1531191564000',
],
'OrderType' => [
'description' => '订单类型。取值：'."\n"
."\n"
.'- NEW 新购订单'."\n"
.'- RENEW 续费订单'."\n"
.'- TRIAL 试用订单',
'type' => 'string',
'example' => 'NEW',
],
'TotalPrice' => [
'description' => '订单应收金额（元）',
'type' => 'number',
'format' => 'float',
'example' => '0.0',
],
'Quantity' => [
'description' => '订购数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'OrderId' => [
'description' => '订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '202211111111111',
],
'ProductCode' => [
'description' => '商品Code',
'type' => 'string',
'example' => 'cmgj02****',
],
'SupplierTelephones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Telephone' => [
'description' => '卖家客服热线',
'type' => 'array',
'items' => [
'description' => '卖家客服热线',
'type' => 'string',
'example' => '{139*****950, 139*****831}',
],
],
],
],
'InstanceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceId' => [
'description' => '订单关联业务实例',
'type' => 'array',
'items' => [
'description' => '订单关联业务实例 ID',
'type' => 'string',
'example' => '{1597985, 1227195}',
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ProductName\\": \\"saas服务产品\\",\\n \\"SupplierCompanyName\\": \\"**科技股份有限公司\\",\\n \\"OriginalPrice\\": 10,\\n \\"AliUid\\": 0,\\n \\"CouponPrice\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"PeriodType\\": \\"MONTH\\",\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"PayStatus\\": \\"PAID\\",\\n \\"PaymentPrice\\": 0,\\n \\"OrderStatus\\": \\"NORMAL\\",\\n \\"ProductSkuCode\\": \\"cmgj02****-prepay\\",\\n \\"PaidOn\\": 1531191675000,\\n \\"Components\\": {\\n \\"package_quantity\\": {\\n \\"code\\": \\"package_quantity\\",\\n \\"globarKey\\": \\"cmapi014302_package_quantity_package_quantity_10000\\",\\n \\"name\\": \\"10000次\\",\\n \\"value\\": \\"10000\\"\\n },\\n \\"package_version\\": {\\n \\"code\\": \\"package_version\\",\\n \\"globarKey\\": \\"cmapi014302_package_version_package_version_yuncode830200000\\",\\n \\"name\\": \\"0元／10000次\\",\\n \\"value\\": \\"yuncode830200000\\"\\n },\\n \\"ord_time\\": {\\n \\"code\\": \\"ord_time\\",\\n \\"globarKey\\": \\"cmapi014302_ord_time_ord_time_6:Month\\",\\n \\"name\\": \\"6个月\\",\\n \\"value\\": \\"6:Month\\"\\n },\\n \\"order_num\\": {\\n \\"code\\": \\"order_num\\",\\n \\"globarKey\\": \\"cmapi014302_order_num_order_num_1\\",\\n \\"name\\": \\"1\\",\\n \\"value\\": \\"1\\"\\n }\\n },\\n \\"CreatedOn\\": 1531191564000,\\n \\"OrderType\\": \\"NEW\\",\\n \\"TotalPrice\\": 0,\\n \\"Quantity\\": 1,\\n \\"OrderId\\": 202211111111111,\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"SupplierTelephones\\": {\\n \\"Telephone\\": [\\n \\"{139*****950, 139*****831}\\"\\n ]\\n },\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"{1597985, 1227195}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1531191675000\\n MONTH\\n 0.0\\n PAID\\n 10.0\\n saas服务产品\\n 6EF60BEC-0242-43AF-BB20-270359FB54A7\\n cmgj02****\\n **科技股份有限公司\\n 1\\n 202211111111111\\n \\n {139*****950, 139*****831}\\n \\n { \\"package_quantity\\": { \\"code\\": \\"package_quantity\\", \\"globarKey\\": \\"cmapi014302_package_quantity_package_quantity_10000\\", \\"name\\": \\"10000次\\", \\"value\\": \\"10000\\" }, \\"package_version\\": { \\"code\\": \\"package_version\\", \\"globarKey\\": \\"cmapi014302_package_version_package_version_yuncode830200000\\", \\"name\\": \\"0元／10000次\\", \\"value\\": \\"yuncode830200000\\" }, \\"ord_time\\": { \\"code\\": \\"ord_time\\", \\"globarKey\\": \\"cmapi014302_ord_time_ord_time_6:Month\\", \\"name\\": \\"6个月\\", \\"value\\": \\"6:Month\\" }, \\"order_num\\": { \\"code\\": \\"order_num\\", \\"globarKey\\": \\"cmapi014302_order_num_order_num_1\\", \\"name\\": \\"1\\", \\"value\\": \\"1\\" } }\\n NORMAL\\n NEW\\n 0.0\\n cmgj02****-prepay\\n 1531191564000\\n 0.0\\n \\n {1597985, 1227195}\\n \\n 0\\n 190311111111****\\n","errorExample":""}]',
'title' => '用于查询对应订单的详细信息',
],
'DescribeProjectMessages' => [
'summary' => '调用DescribeProjectMessages获取项目流程留言信息列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场业务实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '查询页码，每页查询20条。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d',
],
'TotalCount' => [
'description' => '留言总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '28',
],
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
'Result' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GmtCreate' => [
'description' => '留言时间（Unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1589015560000',
],
'Operator' => [
'description' => '留言人的阿里云UID',
'type' => 'integer',
'format' => 'int64',
'example' => '452611111****',
],
'OperatorRole' => [
'description' => '操作人角色，取值：'."\n"
."\n"
.'- System：系统'."\n"
.'- Custom：客户'."\n"
.'- Provider：服务提供商',
'type' => 'string',
'example' => 'Provider',
],
'Content' => [
'description' => '留言内容',
'type' => 'string',
'example' => '尊敬的客户您好，我们已经为您上传了方案，请您查阅，然后尽快将您的意见反馈给我们。',
],
'OperatorName' => [
'description' => '留言人名称',
'type' => 'string',
'example' => '***科技技术有限公司',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"00eb4de1-6cff-4f56-833e-7b1e070e398d\\",\\n \\"TotalCount\\": 28,\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"GmtCreate\\": 1589015560000,\\n \\"Operator\\": 0,\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"Content\\": \\"尊敬的客户您好，我们已经为您上传了方案，请您查阅，然后尽快将您的意见反馈给我们。\\",\\n \\"OperatorName\\": \\"***科技技术有限公司\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 21\\n 00eb4de1-6cff-4f56-833e-7b1e070e398d\\n true\\n \\n 452611111****\\n ***科技技术有限公司\\n 1589015560000\\n Provider\\n 尊敬的客户您好，我们已经为您上传了方案，请您查阅，然后尽快将您的意见反馈给我们。\\n \\n","errorExample":""}]',
'title' => '获取项目流程留言信息列表',
],
'DescribeProjectNodes' => [
'summary' => '调用DescribeProjectNodes获取项目流程节点列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场订单实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求 ID',
'type' => 'string',
'example' => '937fee1f-26bb-4b6e-8def-977a6bdaa1e5',
],
'Result' => [
'description' => '无',
'type' => 'array',
'items' => [
'description' => '节点执行结果',
'type' => 'object',
'properties' => [
'NextNodeId' => [
'description' => '下一个流程节点 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '8472',
],
'StepNo' => [
'description' => '所属流程节点的序号',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'AutoFinishNode' => [
'description' => '节点超时是否自动完成',
'type' => 'boolean',
'example' => 'false',
],
'FinalStepNo' => [
'description' => '最终流程节点的序号',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'PreviousNodeId' => [
'description' => '上一个流程节点 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '8470',
],
'ParentNodeId' => [
'description' => '父级流程节点 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'GmtExpired' => [
'description' => '流程节点超时时间（Unix 时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1588834325000',
],
'OperatorRole' => [
'description' => '操作人角色，取值：'."\n"
."\n"
.'- System：系统'."\n"
.'- Custom：客户'."\n"
.'- Provider：服务提供商',
'type' => 'string',
'example' => 'System',
],
'GmtStart' => [
'description' => '流程节点开始时间（Unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1588834325000',
],
'NodeStatus' => [
'description' => '节点执行状态，取值：'."\n"
.'- NotStart：未开始'."\n"
.'- Starting：进行中'."\n"
.'- Cancel：已取消'."\n"
.'- Finish：已完成',
'type' => 'string',
'example' => 'Finish',
],
'NodeName' => [
'description' => '节点名称',
'type' => 'string',
'example' => '分配服务商节点',
],
'GmtFinished' => [
'description' => '流程节点完成时间（unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1588834325000',
],
'AllowRollbackNode' => [
'description' => '是否允许执行回滚到上一个流程节点',
'type' => 'boolean',
'example' => 'false',
],
'TemplateForm' => [
'description' => '流程节点表单内容',
'type' => 'string',
'example' => '[ {"fieldKey": "TFD0","isRequired": true,"maxLength": 50, "placeHolder": "姓名","stepNum": 0,"title": "收货人姓名","type": "text" },{ "fieldKey": "TFD1","isRequired": true,"maxLength": 50,"placeHolder": "手机号码","stepNum": 1,"title": "收货人电话","type": "text"},{"fieldKey": "TFD2","isRequired": true,"maxLength": 50,"placeHolder": "省市区街道门牌号码","stepNum": 2,"title": "详细收货地址","type": "textarea"}]',
],
'NeedAttachment' => [
'description' => '是否强制要求上传附件',
'type' => 'boolean',
'example' => 'false',
],
'NodeId' => [
'description' => '流程节点id',
'type' => 'integer',
'format' => 'int64',
'example' => '8471',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"937fee1f-26bb-4b6e-8def-977a6bdaa1e5\\",\\n \\"Result\\": [\\n {\\n \\"NextNodeId\\": 8472,\\n \\"StepNo\\": 2,\\n \\"AutoFinishNode\\": false,\\n \\"FinalStepNo\\": 4,\\n \\"PreviousNodeId\\": 8470,\\n \\"ParentNodeId\\": 0,\\n \\"GmtExpired\\": 1588834325000,\\n \\"OperatorRole\\": \\"System\\",\\n \\"GmtStart\\": 1588834325000,\\n \\"NodeStatus\\": \\"Finish\\",\\n \\"NodeName\\": \\"分配服务商节点\\",\\n \\"GmtFinished\\": 1588834325000,\\n \\"AllowRollbackNode\\": false,\\n \\"TemplateForm\\": \\"[ {\\\\\\"fieldKey\\\\\\": \\\\\\"TFD0\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50, \\\\\\"placeHolder\\\\\\": \\\\\\"姓名\\\\\\",\\\\\\"stepNum\\\\\\": 0,\\\\\\"title\\\\\\": \\\\\\"收货人姓名\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\" },{ \\\\\\"fieldKey\\\\\\": \\\\\\"TFD1\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"手机号码\\\\\\",\\\\\\"stepNum\\\\\\": 1,\\\\\\"title\\\\\\": \\\\\\"收货人电话\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\"},{\\\\\\"fieldKey\\\\\\": \\\\\\"TFD2\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"省市区街道门牌号码\\\\\\",\\\\\\"stepNum\\\\\\": 2,\\\\\\"title\\\\\\": \\\\\\"详细收货地址\\\\\\",\\\\\\"type\\\\\\": \\\\\\"textarea\\\\\\"}]\\",\\n \\"NeedAttachment\\": false,\\n \\"NodeId\\": 8471\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 937fee1f-26bb-4b6e-8def-977a6bdaa1e5\\n \\n 8472\\n 2\\n false\\n 4\\n 8470\\n 0\\n 1588834325000\\n System\\n 1588834325000\\n Finish\\n 分配服务商节点\\n 1588834325000\\n false\\n [ {\\"fieldKey\\": \\"TFD0\\",\\"isRequired\\": true,\\"maxLength\\": 50, \\"placeHolder\\": \\"姓名\\",\\"stepNum\\": 0,\\"title\\": \\"收货人姓名\\",\\"type\\": \\"text\\" },{ \\"fieldKey\\": \\"TFD1\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"手机号码\\",\\"stepNum\\": 1,\\"title\\": \\"收货人电话\\",\\"type\\": \\"text\\"},{\\"fieldKey\\": \\"TFD2\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"省市区街道门牌号码\\",\\"stepNum\\": 2,\\"title\\": \\"详细收货地址\\",\\"type\\": \\"textarea\\"}]\\n false\\n 8471\\n \\n","errorExample":""}]',
'title' => '获取项目流程节点列表',
'description' => '**'."\n"
.'**',
],
'DescribeProjectOperateLogs' => [
'summary' => '调用DescribeProjectOperateLogs获取项目流程操作日志。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场订单实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'e6037e86-657f-4194-bb6a-7b26973aec8d',
],
'Result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'GmtCreate' => [
'description' => '操作时间（unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1587624497000',
],
'Operator' => [
'description' => '操作人阿里云uid',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OperatorRole' => [
'description' => '操作人角色-System：系统-Custom：客户-Provider：服务提供商',
'type' => 'string',
'example' => 'System',
],
'Description' => [
'description' => '操作内容描述',
'type' => 'string',
'example' => '进入分配服务商操作人',
],
'OperatorName' => [
'description' => '操作人名称',
'type' => 'string',
'example' => '系统',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"e6037e86-657f-4194-bb6a-7b26973aec8d\\",\\n \\"Result\\": [\\n {\\n \\"GmtCreate\\": 1587624497000,\\n \\"Operator\\": 0,\\n \\"OperatorRole\\": \\"System\\",\\n \\"Description\\": \\"进入分配服务商操作人\\",\\n \\"OperatorName\\": \\"系统\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n e6037e86-657f-4194-bb6a-7b26973aec8d\\n \\n 1587624497000\\n 0\\n System\\n 进入分配服务商操作人\\n 系统\\n \\n","errorExample":""}]',
'title' => '获取项目流程操作日志',
'description' => '**'."\n"
.'**',
],
'DescribeCurrentNodeInfo' => [
'summary' => '调用DescribeCurrentNodeInfo获取当前节点的流程信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场订单实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d',
],
'Result' => [
'description' => '成功流程节点信息',
'type' => 'object',
'properties' => [
'NextNodeId' => [
'description' => '下一个流程节点id',
'type' => 'integer',
'format' => 'int64',
'example' => '8473',
],
'StepNo' => [
'description' => '所属流程节点的序号',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'AutoFinishNode' => [
'description' => '是否自动完成节点',
'type' => 'boolean',
'example' => 'false',
],
'FinalStepNo' => [
'description' => '最后节点的序号',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'PreviousNodeId' => [
'description' => '上一个流程节点id',
'type' => 'integer',
'format' => 'int64',
'example' => '8471',
],
'ParentNodeId' => [
'description' => '父级流程节点id',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'GmtExpired' => [
'description' => '流程节点超时时间（unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1588920725000',
],
'OperatorRole' => [
'description' => '流程节点操作人角色，取值：-system：系统-custom：用户',
'type' => 'string',
'example' => 'Provider',
],
'GmtStart' => [
'description' => '流程节点开始时间（unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1588834325000',
],
'NodeStatus' => [
'description' => '节点执行状态，取值：-NotStart：未开始-Starting：进行中-Cancel：已取消-Finish：已完成',
'type' => 'string',
'example' => 'Starting',
],
'NodeName' => [
'description' => '节点名称',
'type' => 'string',
'example' => '等待服务开通',
],
'GmtFinished' => [
'description' => '流程节点完成时间（unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1588920725000',
],
'AllowRollbackNode' => [
'description' => '是否允许执行回滚到上一个流程节点',
'type' => 'boolean',
'example' => 'false',
],
'TemplateForm' => [
'description' => '流程节点表单内容，格式为json。'."\n"
.'示例代码如下：'."\n"
.'`[ { "fieldKey": "TFD0", //表单 key "isRequired": true, //是否必填项 "maxLength": 50, //最大值长度 "placeHolder": "姓名", //表单值简介 "stepNum": 0, //排序值（升序） "title": "收货人姓名", //表单标题 "type": "text" //表单类型 }, { "fieldKey": "TFD1", "isRequired": true, "maxLength": 50, "placeHolder": "手机号码", "stepNum": 1, "title": "收货人电话", "type": "text" }, { "fieldKey": "TFD2", "isRequired": true, "maxLength": 50, "placeHolder": "省市区街道门牌号码", "stepNum": 2, "title": "详细收货地址", "type": "textarea" } ]`',
'type' => 'string',
'example' => '[ {"fieldKey": "TFD0","isRequired": true,"maxLength": 50, "placeHolder": "姓名","stepNum": 0,"title": "收货人姓名","type": "text" },{ "fieldKey": "TFD1","isRequired": true,"maxLength": 50,"placeHolder": "手机号码","stepNum": 1,"title": "收货人电话","type": "text"},{"fieldKey": "TFD2","isRequired": true,"maxLength": 50,"placeHolder": "省市区街道门牌号码","stepNum": 2,"title": "详细收货地址","type": "textarea"}]',
],
'NeedAttachment' => [
'description' => '是否强制要求上传附件',
'type' => 'boolean',
'example' => 'false',
],
'NodeId' => [
'description' => '流程节点id',
'type' => 'integer',
'format' => 'int64',
'example' => '8472',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"00eb4de1-6cff-4f56-833e-7b1e070e398d\\",\\n \\"Result\\": {\\n \\"NextNodeId\\": 8473,\\n \\"StepNo\\": 3,\\n \\"AutoFinishNode\\": false,\\n \\"FinalStepNo\\": 4,\\n \\"PreviousNodeId\\": 8471,\\n \\"ParentNodeId\\": 0,\\n \\"GmtExpired\\": 1588920725000,\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"GmtStart\\": 1588834325000,\\n \\"NodeStatus\\": \\"Starting\\",\\n \\"NodeName\\": \\"等待服务开通\\",\\n \\"GmtFinished\\": 1588920725000,\\n \\"AllowRollbackNode\\": false,\\n \\"TemplateForm\\": \\"[ {\\\\\\"fieldKey\\\\\\": \\\\\\"TFD0\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50, \\\\\\"placeHolder\\\\\\": \\\\\\"姓名\\\\\\",\\\\\\"stepNum\\\\\\": 0,\\\\\\"title\\\\\\": \\\\\\"收货人姓名\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\" },{ \\\\\\"fieldKey\\\\\\": \\\\\\"TFD1\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"手机号码\\\\\\",\\\\\\"stepNum\\\\\\": 1,\\\\\\"title\\\\\\": \\\\\\"收货人电话\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\"},{\\\\\\"fieldKey\\\\\\": \\\\\\"TFD2\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"省市区街道门牌号码\\\\\\",\\\\\\"stepNum\\\\\\": 2,\\\\\\"title\\\\\\": \\\\\\"详细收货地址\\\\\\",\\\\\\"type\\\\\\": \\\\\\"textarea\\\\\\"}]\\",\\n \\"NeedAttachment\\": false,\\n \\"NodeId\\": 8472\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 00eb4de1-6cff-4f56-833e-7b1e070e398d\\n \\n 8473\\n 3\\n false\\n 4\\n 8471\\n 0\\n 1588920725000\\n Provider\\n 1588834325000\\n Starting\\n 等待服务开通\\n 1588920725000\\n false\\n [ {\\"fieldKey\\": \\"TFD0\\",\\"isRequired\\": true,\\"maxLength\\": 50, \\"placeHolder\\": \\"姓名\\",\\"stepNum\\": 0,\\"title\\": \\"收货人姓名\\",\\"type\\": \\"text\\" },{ \\"fieldKey\\": \\"TFD1\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"手机号码\\",\\"stepNum\\": 1,\\"title\\": \\"收货人电话\\",\\"type\\": \\"text\\"},{\\"fieldKey\\": \\"TFD2\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"省市区街道门牌号码\\",\\"stepNum\\": 2,\\"title\\": \\"详细收货地址\\",\\"type\\": \\"textarea\\"}]\\n false\\n 8472\\n \\n","errorExample":""}]',
'title' => '获取当前节点的流程信息',
'description' => '**'."\n"
.'**',
],
'FinishCurrentProjectNode' => [
'summary' => '调用FinishCurrentProjectNode完成当前流程。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场订单实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => [
'description' => '流程节点ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1924',
],
],
[
'name' => 'TemplateForm',
'in' => 'query',
'schema' => [
'description' => '提交表单内容，格式为json。示例代码如下：{"TFD0":"mr.go","TFD1":"1330010xxxx","TFD2":"北京市朝阳区望京街道x区y号"}',
'type' => 'string',
'required' => false,
'example' => '{"TFD0": "Mr.Go","TFD1": "1330010xxxx","TFD2": "北京市朝阳区望京街道X区Y号" }',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注信息',
'type' => 'string',
'required' => false,
'example' => '收货地址已提交，请尽快安排发货。',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
],
'Result' => [
'description' => '返回结果',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
[
'errorCode' => 'IllegalOperatorRole',
'errorMessage' => 'Illegal operator role.',
],
[
'errorCode' => 'IllegalCurrentNode',
'errorMessage' => 'Illegal current node.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ee69a00f-189b-400f-9fd2-af89749fb50f\\n true\\n true\\n","errorExample":""}]',
'title' => '完成当前流程',
'description' => '**'."\n"
.'**',
],
'RollbackCurrentProjectNode' => [
'summary' => '调用RollbackCurrentProjectNode触发当前流程驳回。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场订单实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => [
'description' => '当前流程节点ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1925',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '打回原因备注',
'type' => 'string',
'required' => false,
'example' => '尊敬的顾客您好，您提交的收货地址存在多个匹配结果，请您核对后再重新提交。',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
],
'Result' => [
'description' => '是否返回成功',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
[
'errorCode' => 'IllegalOperatorRole',
'errorMessage' => 'Illegal operator role.',
],
[
'errorCode' => 'IllegalCurrentNode',
'errorMessage' => 'Illegal current node.',
],
[
'errorCode' => 'IllegalProjectStatus',
'errorMessage' => 'Illegal project status.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ee69a00f-189b-400f-9fd2-af89749fb50f\\n true\\n true\\n","errorExample":""}]',
'title' => '触发当前流程驳回',
'description' => '**'."\n"
.'**',
],
'DescribeInstance' => [
'summary' => '调用 DescribeInstance 查询实例信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例 ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '155****11',
],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
'description' => '订单类型，已废弃。',
'type' => 'string',
'required' => false,
'example' => 'NEW',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '业务状态，根据不同商品类型设置不同值：'."\n"
."\n"
.'当ProductType = MIRROR 时'."\n"
.'- PRODUCE：生产中'."\n"
.'- USING：使用中'."\n"
.'- UNUSED：未使用'."\n"
.'- EXPIRED：已过期'."\n"
.'- CLOSED：已释放'."\n"
."\n"
.'当 ProductType = SERVICE 时'."\n"
.'- READYING：未开始'."\n"
.'- STARTED：服务中'."\n"
.'- CONFIRM：已完成'."\n"
.'- EXPIRED：已过期'."\n"
.'- CLOSED：已释放'."\n"
."\n"
.'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n"
.'- OPENING：开通中'."\n"
.'- OPENED：已开通'."\n"
.'- EXPIRED：已过期'."\n"
.'- CLOSED：已释放',
'type' => 'string',
'example' => 'OPENED',
],
'AppJson' => [
'description' => '应用信息，示例中的参数说明如下：'."\n"
."\n"
.'- username：用户名'."\n"
.'- passowrd：密码'."\n"
.'- frontEndUrl：前台地址'."\n"
.'- adminUrl：管理地址',
'type' => 'string',
'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}',
],
'ProductName' => [
'description' => '商品名称',
'type' => 'string',
'example' => '***协同办公',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1551111111',
],
'ExtendJson' => [
'description' => '扩展信息',
'type' => 'string',
'example' => '{"说明": "如有使用问题，请联系..."}',
],
'IsTrial' => [
'description' => '是否试用',
'type' => 'boolean',
'example' => 'true',
],
'BeganOn' => [
'description' => '实例开通时间（时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1570634021000',
],
'ComponentJson' => [
'description' => '业务模块'."\n"
."\n"
.'示例中的参数说明如下：'."\n"
."\n"
.'- package_version：版本',
'type' => 'string',
'example' => '{"package_version":"yuncode000111"}',
],
'Constraints' => [
'description' => '已废弃',
'type' => 'string',
'example' => '{}',
],
'ProductType' => [
'description' => '商品类型，取值：'."\n"
."\n"
.'- APP：应用类'."\n"
.'- SERVIC：服务类'."\n"
.'- MIRROR：镜像类'."\n"
.'- DOWNLOAD：下载类'."\n"
.'- API_SERVICE：API类'."\n"
.'- DOCKER：DOCKER类',
'type' => 'string',
'example' => 'APP',
],
'HostJson' => [
'description' => '主机信息，示例中的参数说明如下：'."\n"
."\n"
.'- username：用户名'."\n"
.'- passowrd：密码'."\n"
.'- ip：主机 IP'."\n"
.'- innerIp：主机内网 IP',
'type' => 'string',
'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}',
],
'ProductSkuCode' => [
'description' => '规格Code',
'type' => 'string',
'example' => 'cmgj00**11-prepay',
],
'CreatedOn' => [
'description' => '创建时间（时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1570634018000',
],
'EndOn' => [
'description' => '到期时间（时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1602259200000',
],
'OrderId' => [
'description' => '订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '204211111111111',
],
'ProductCode' => [
'description' => '商品Code',
'type' => 'string',
'example' => 'cmgj00**11',
],
'SupplierName' => [
'description' => '服务商名称',
'type' => 'string',
'example' => '*****有限公司',
],
'RelationalData' => [
'description' => '关联信息',
'type' => 'object',
'properties' => [
'ServiceStatus' => [
'description' => '服务状态'."\n"
."\n"
.'- READYING：未开始'."\n"
.'- STARTED： 服务中'."\n"
.'- CONFIRM：已完成'."\n"
.'- EXPIRED： 已过期'."\n"
.'- CLOSED： 已释放',
'type' => 'string',
'example' => 'STARTED',
],
],
],
'Modules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Module' => [
'description' => '商品模块信息，已废弃。',
'type' => 'array',
'items' => [
'description' => '已废弃',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '已废弃',
'type' => 'string',
'example' => 'package_config',
],
'Name' => [
'description' => '已废弃',
'type' => 'string',
'example' => '套餐配置',
],
'Id' => [
'description' => '已废弃',
'type' => 'string',
'example' => '101*********026',
],
'Properties' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Property' => [
'description' => '已废弃',
'type' => 'array',
'items' => [
'description' => '已废弃',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'ShowType' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'Name' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'DisplayUnit' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'PropertyValues' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PropertyValue' => [
'description' => '已废弃',
'type' => 'array',
'items' => [
'description' => '已废弃',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'Type' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'Step' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'Value' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'Max' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'Remark' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
'Min' => [
'description' => '已废弃',
'type' => 'string',
'example' => '12',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'AutoRenewal' => [
'type' => 'string',
],
'ActiveAddress' => [
'type' => 'string',
],
'LicenseCode' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"IsTrial\\": true,\\n \\"BeganOn\\": 1570634021000,\\n \\"ComponentJson\\": \\"{\\\\\\"package_version\\\\\\":\\\\\\"yuncode000111\\\\\\"}\\",\\n \\"Constraints\\": \\"{}\\",\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634018000,\\n \\"EndOn\\": 1602259200000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"*****有限公司\\",\\n \\"RelationalData\\": {\\n \\"ServiceStatus\\": \\"STARTED\\"\\n },\\n \\"Modules\\": {\\n \\"Module\\": [\\n {\\n \\"Code\\": \\"package_config\\",\\n \\"Name\\": \\"套餐配置\\",\\n \\"Id\\": \\"101*********026\\",\\n \\"Properties\\": {\\n \\"Property\\": [\\n {\\n \\"Key\\": \\"12\\",\\n \\"ShowType\\": \\"12\\",\\n \\"Name\\": \\"12\\",\\n \\"DisplayUnit\\": \\"12\\",\\n \\"PropertyValues\\": {\\n \\"PropertyValue\\": [\\n {\\n \\"DisplayName\\": \\"12\\",\\n \\"Type\\": \\"12\\",\\n \\"Step\\": \\"12\\",\\n \\"Value\\": \\"12\\",\\n \\"Max\\": \\"12\\",\\n \\"Remark\\": \\"12\\",\\n \\"Min\\": \\"12\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"AutoRenewal\\": \\"\\",\\n \\"ActiveAddress\\": \\"\\",\\n \\"LicenseCode\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1570634021000\\n cmgj00**11\\n cmgj00**11-prepay\\n 204605827111111\\n 15581111\\n 1602259200000\\n OPENED\\n {\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}\\n APP\\n 1570634018000\\n \\n READYING\\n \\n ***协同办公\\n {\\"package_version\\":\\"yuncode000111\\"}\\n 阿里巴巴技术有限公司\\n","errorExample":""}]',
'title' => '查询实例信息',
],
'DescribeInstanceForIsv' => [
'summary' => '服务商侧查询实例信息',
'path' => '',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '155****11',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '业务状态，根据不同商品类型设置不同值：'."\n"
.'当ProductType = MIRROR 时'."\n"
.'● PRODUCE：生产中'."\n"
.'● USING：使用中'."\n"
.'● UNUSED：未使用'."\n"
.'● EXPIRED：已过期'."\n"
.'● CLOSED：已释放'."\n"
.'当 ProductType = SERVICE 时'."\n"
.'● READYING：未开始'."\n"
.'● STARTED：服务中'."\n"
.'● CONFIRM：已完成'."\n"
.'● EXPIRED：已过期'."\n"
.'● CLOSED：已释放'."\n"
.'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n"
.'● OPENING：开通中'."\n"
.'● OPENED：已开通'."\n"
.'● EXPIRED：已过期'."\n"
.'● CLOSED：已释放',
'description' => '业务状态，根据不同商品类型设置不同值：'."\n"
.'当ProductType = MIRROR 时'."\n"
.'● PRODUCE：生产中'."\n"
.'● USING：使用中'."\n"
.'● UNUSED：未使用'."\n"
.'● EXPIRED：已过期'."\n"
.'● CLOSED：已释放'."\n"
.'当 ProductType = SERVICE 时'."\n"
.'● READYING：未开始'."\n"
.'● STARTED：服务中'."\n"
.'● CONFIRM：已完成'."\n"
.'● EXPIRED：已过期'."\n"
.'● CLOSED：已释放'."\n"
.'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n"
.'● OPENING：开通中'."\n"
.'● OPENED：已开通'."\n"
.'● EXPIRED：已过期'."\n"
.'● CLOSED：已释放',
'type' => 'string',
'example' => 'OPENED',
],
'AppJson' => [
'title' => '应用信息，示例中的参数说明如下：'."\n"
."\n"
.'username：用户名'."\n"
.'passowrd：密码'."\n"
.'frontEndUrl：前台地址'."\n"
.'adminUrl：管理地址',
'description' => '应用信息，示例中的参数说明如下：'."\n"
."\n"
.'username：用户名'."\n"
.'passowrd：密码'."\n"
.'frontEndUrl：前台地址'."\n"
.'adminUrl：管理地址',
'type' => 'string',
'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}',
],
'ProductName' => [
'title' => '商品名称',
'description' => '商品名称',
'type' => 'string',
'example' => '***协同办公',
],
'InstanceId' => [
'title' => '实例ID',
'description' => '实例ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1551111111',
],
'ExtendJson' => [
'title' => '扩展信息',
'description' => '扩展信息',
'type' => 'string',
'example' => '{"说明": "如有使用问题，请联系..."}',
],
'IsTrial' => [
'title' => '是否试用',
'description' => '是否试用',
'type' => 'boolean',
'example' => 'true',
],
'BeganOn' => [
'title' => '实例开通时间（时间戳）',
'description' => '实例开通时间（时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1570634021000',
],
'ComponentJson' => [
'title' => '业务模块'."\n"
.'示例中的参数说明如下：'."\n"
.'● package_version：版本',
'description' => '业务模块'."\n"
.'示例中的参数说明如下：'."\n"
.'● package_version：版本',
'type' => 'string',
'example' => '{"package_version":"yuncode000111"}',
],
'ProductType' => [
'title' => '商品类型，取值：'."\n"
.'● APP：应用类'."\n"
.'● SERVIC：服务类'."\n"
.'● MIRROR：镜像类'."\n"
.'● DOWNLOAD：下载类'."\n"
.'● API_SERVICE：API类'."\n"
.'● DOCKER：DOCKER类',
'description' => '商品类型，取值：'."\n"
.'● APP：应用类'."\n"
.'● SERVIC：服务类'."\n"
.'● MIRROR：镜像类'."\n"
.'● DOWNLOAD：下载类'."\n"
.'● API_SERVICE：API类'."\n"
.'● DOCKER：DOCKER类',
'type' => 'string',
'example' => 'APP',
],
'HostJson' => [
'title' => '主机信息，示例中的参数说明如下：'."\n"
."\n"
.'username：用户名'."\n"
.'passowrd：密码'."\n"
.'ip：主机 IP'."\n"
.'innerIp：主机内网 IP',
'description' => '主机信息，示例中的参数说明如下：'."\n"
."\n"
.'username：用户名'."\n"
.'passowrd：密码'."\n"
.'ip：主机 IP'."\n"
.'innerIp：主机内网 IP',
'type' => 'string',
'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}',
],
'ProductSkuCode' => [
'title' => '规格Code',
'description' => '规格Code',
'type' => 'string',
'example' => 'cmgj00**11-prepay',
],
'CreatedOn' => [
'title' => '创建时间（时间戳）',
'description' => '创建时间（时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1570634018000',
],
'EndOn' => [
'title' => '到期时间（时间戳）',
'description' => '到期时间（时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1602259200000',
],
'OrderId' => [
'title' => '订单ID',
'description' => '订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '204211111111111',
],
'ProductCode' => [
'title' => '商品Code',
'description' => '商品Code',
'type' => 'string',
'example' => 'cmgj00**11',
],
'SupplierName' => [
'title' => '服务商名称',
'description' => '服务商名称',
'type' => 'string',
'example' => '*****有限公司',
],
'RelationalData' => [
'title' => '关联信息',
'description' => '关联信息',
'type' => 'object',
'properties' => [
'ServiceStatus' => [
'title' => '服务状态'."\n"
.'● READYING：未开始'."\n"
.'● STARTED： 服务中'."\n"
.'● CONFIRM：已完成'."\n"
.'● EXPIRED： 已过期'."\n"
.'● CLOSED： 已释放',
'description' => '服务状态'."\n"
.'● READYING：未开始'."\n"
.'● STARTED： 服务中'."\n"
.'● CONFIRM：已完成'."\n"
.'● EXPIRED： 已过期'."\n"
.'● CLOSED： 已释放',
'type' => 'string',
'example' => 'STARTED',
],
],
],
'RequestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => '6EF60BEC-****-****-****-270359FB54A7',
],
'AutoRenewal' => [
'title' => '周期类商品自动付费，不为空时表示已开通自动续费'."\n"
.'autoRenewCycle:Day（日），Month（月），Year（年）'."\n"
.'autoRenewDuration:续费周期',
'description' => '周期类商品自动付费，不为空时表示已开通自动续费'."\n"
.'autoRenewCycle:Day（日），Month（月），Year（年）'."\n"
.'autoRenewDuration:续费周期',
'type' => 'string',
'example' => '{"autoRenewCycle":"Year","autoRenewDuration":1}',
],
'ActiveAddress' => [
'title' => '激活地址',
'description' => '激活地址',
'type' => 'string',
'example' => 'https://*****.com',
],
'LicenseCode' => [
'title' => '激活码',
'description' => '激活码',
'type' => 'string',
'example' => 'xxxxxx',
],
'ImageJson' => [
'title' => '镜像实例信息'."\n"
.'imageId：镜像id'."\n"
.'instanceId: 实例id'."\n"
.'ecsInstanceId: ecs id',
'description' => '镜像实例信息'."\n"
.'imageId：镜像id'."\n"
.'instanceId: 实例id'."\n"
.'ecsInstanceId: ecs id',
'type' => 'string',
'example' => '{"imageId":"m-*******","instanceId":********}',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"IsTrial\\": true,\\n \\"BeganOn\\": 1570634021000,\\n \\"ComponentJson\\": \\"{\\\\\\"package_version\\\\\\":\\\\\\"yuncode000111\\\\\\"}\\",\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634018000,\\n \\"EndOn\\": 1602259200000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"*****有限公司\\",\\n \\"RelationalData\\": {\\n \\"ServiceStatus\\": \\"STARTED\\"\\n },\\n \\"RequestId\\": \\"6EF60BEC-****-****-****-270359FB54A7\\",\\n \\"AutoRenewal\\": \\"{\\\\\\"autoRenewCycle\\\\\\":\\\\\\"Year\\\\\\",\\\\\\"autoRenewDuration\\\\\\":1}\\",\\n \\"ActiveAddress\\": \\"https://*****.com\\",\\n \\"LicenseCode\\": \\"xxxxxx\\",\\n \\"ImageJson\\": \\"{\\\\\\"imageId\\\\\\":\\\\\\"m-*******\\\\\\",\\\\\\"instanceId\\\\\\":********}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OPENED\\n {\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}\\n ***协同办公\\n 1551111111\\n {\\"说明\\": \\"如有使用问题，请联系...\\"}\\n true\\n 1570634021000\\n {\\"package_version\\":\\"yuncode000111\\"}\\n APP\\n {\\"password\\":\\"***\\",\\"ip\\":\\"118.31.***.41\\",\\"innerIp\\":\\"118.31.***.41\\",\\"region\\":\\"\\",\\"username\\":\\"***\\",\\"beianInfo\\":\\"\\"}\\n cmgj00**11-prepay\\n 1570634018000\\n 1602259200000\\n 204211111111111\\n cmgj00**11\\n *****有限公司\\n \\n STARTED\\n \\n 6EF60BEC-****-****-****-270359FB54A7\\n {\\"autoRenewCycle\\":\\"Year\\",\\"autoRenewDuration\\":1}\\n https://*****.com\\n xxxxxx\\n {\\"imageId\\":\\"m-*******\\",\\"instanceId\\":********}\\n","errorExample":""}]',
'title' => '服务商侧查询实例信息',
],
'DescribeInstances' => [
'summary' => '查询用户已购买的服务列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
'description' => '商品类型：'."\n"
.'APP-应用类'."\n"
.'SERVICE-服务类'."\n"
.'MIRROR-镜像类'."\n"
.'DOWNLOAD-下载类'."\n"
.'API_SERVICE-API类'."\n"
.'ROS-资源编排类'."\n"
.'DOCKER-容器类'."\n"
.'IOT-IOT类',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'title' => '分页参数，当前页码',
'description' => '分页参数，每页数量',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '分页参数，每页数量',
'description' => '分页参数，页数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'Codes',
'in' => 'query',
'schema' => [
'description' => '指定商品code, 如有多个，用 , 分隔',
'type' => 'string',
'required' => false,
'example' => 'cmgj000112,cmgj000113',
],
],
[
'name' => 'ExceptCodes',
'in' => 'query',
'schema' => [
'description' => '排除商品code，与指定商品code不能同时传， 如有多个，用 , 分隔',
'type' => 'string',
'required' => false,
'example' => 'cmgj000114,cmgj000115',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54C22FB9-0CB1-5629-97A8-653FC7990F00',
],
'PageNumber' => [
'description' => '当前页数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页的实例个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '实例总数',
'type' => 'integer',
'format' => 'int32',
'example' => '55',
],
'InstanceItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceItem' => [
'description' => '实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '业务状态'."\n"
.'- 当 ProductType = MIRROR 时'."\n"
.' - PRODUCE：生产中'."\n"
.' - USING：使用中'."\n"
.' - UNUSED：未使用'."\n"
.' - EXPIRED：已过期'."\n"
.' - CLOSED：已释放'."\n"
."\n"
.'- 当 ProductType = SERVICE 时'."\n"
.' - READYING：未开始'."\n"
.' - STARTED：服务中'."\n"
.' - CONFIRM：已完成'."\n"
.' - EXPIRED：已过期'."\n"
.' - CLOSED：已释放'."\n"
."\n"
.'- 当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n"
.' - OPENING：开通中'."\n"
.' - OPENED：已开通'."\n"
.' - EXPIRED：已过期'."\n"
.' - CLOSED：已释放',
'type' => 'string',
'example' => 'OPENED',
],
'AppJson' => [
'description' => '应用信息'."\n"
."\n"
.'示例中的参数说明如下：'."\n"
.'- username：用户名'."\n"
.'- passowrd：密码'."\n"
.'- frontEndUrl：前台地址'."\n"
.'- adminUrl：管理地址'."\n"
.'- authUrl: 免登地址',
'type' => 'string',
'example' => '{"frontEndUrl":"https://***.aliyun.com","password":"Sjtv***","adminUrl":"https://***.aiiyun.com","username":"aliyun***"}',
],
'ApiJson' => [
'type' => 'string',
'example' => '{}',
],
'ProductName' => [
'description' => '商品名称',
'type' => 'string',
'example' => '***协同办公',
],
'ImageJson' => [
'description' => '镜像信息',
'type' => 'string',
'example' => '{}',
],
'InstanceId' => [
'description' => '实例id',
'type' => 'integer',
'format' => 'int64',
'example' => '1551111111',
],
'ExtendJson' => [
'description' => '扩展信息',
'type' => 'string',
'example' => '{"说明": "如有使用问题，请联系..."}',
],
'BeganOn' => [
'description' => '开通时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1570634021000',
],
'ProductType' => [
'description' => '商品类型，取值：'."\n"
.'- APP：应用类'."\n"
.'- SERVIC：服务类'."\n"
.'- MIRROR：镜像类'."\n"
.'- DOWNLOAD：下载类'."\n"
.'- API_SERVICE：API类'."\n"
.'- DOCKER：DOCKER类',
'type' => 'string',
'example' => 'APP',
],
'HostJson' => [
'description' => '主机信息'."\n"
."\n"
.'示例中的参数说明如下：'."\n"
.'- username：用户名'."\n"
.'- passowrd：密码'."\n"
.'- ip：主机 IP'."\n"
.'- innerIp：主机内网 IP',
'type' => 'string',
'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}',
],
'ProductSkuCode' => [
'description' => '规格code',
'type' => 'string',
'example' => 'cmgj00**11-prepay',
],
'CreatedOn' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1570634021000',
],
'IdaasJson' => [
'description' => 'idaas信息，已经废弃',
'type' => 'string',
'example' => '{}',
],
'EndOn' => [
'description' => '结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1570644021000',
],
'OrderId' => [
'description' => '订单id',
'type' => 'integer',
'format' => 'int64',
'example' => '204211111111111',
],
'ProductCode' => [
'description' => '商品code',
'type' => 'string',
'example' => 'cmgj00**11',
],
'SupplierName' => [
'description' => '服务商名称',
'type' => 'string',
'example' => '阿里巴巴技术有限公司',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'UnknownError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54C22FB9-0CB1-5629-97A8-653FC7990F00\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 55,\\n \\"InstanceItems\\": {\\n \\"InstanceItem\\": [\\n {\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://***.aliyun.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://***.aiiyun.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ApiJson\\": \\"{}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"ImageJson\\": \\"{}\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"BeganOn\\": 1570634021000,\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634021000,\\n \\"IdaasJson\\": \\"{}\\",\\n \\"EndOn\\": 1570644021000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"阿里巴巴技术有限公司\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询业务列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AutoRenewInstance' => [
'summary' => '设置自动续费',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'title' => '开通open，关闭close，必传',
'type' => 'string',
'required' => true,
],
],
[
'name' => 'OrderBizId',
'in' => 'formData',
'schema' => [
'title' => '云市场实例id，必传',
'type' => 'integer',
'format' => 'int64',
'required' => true,
],
],
[
'name' => 'AutoRenewCycle',
'in' => 'formData',
'schema' => [
'title' => '周期单位，开通时必传。Day（日），Month（月），Year（年）',
'type' => 'string',
],
],
[
'name' => 'AutoRenewDuration',
'in' => 'formData',
'schema' => [
'title' => '续费周期，开通时必传',
'type' => 'integer',
'format' => 'int32',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ResponseDTO',
'type' => 'object',
'properties' => [
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'boolean',
],
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'PauseProject' => [
'summary' => '调用PauseProject暂停项目。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场订单实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => [
'description' => '当前操作流程节点ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1922',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注原因',
'type' => 'string',
'required' => false,
'example' => '等待与仓库确认库存，目前库存显示异常。',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
],
'Result' => [
'description' => '是否返回成功',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
[
'errorCode' => 'IllegalOperatorRole',
'errorMessage' => 'Illegal operator role.',
],
[
'errorCode' => 'IllegalCurrentNode',
'errorMessage' => 'Illegal current node.',
],
[
'errorCode' => 'IllegalProjectStatus',
'errorMessage' => 'Illegal project status.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ee69a00f-189b-400f-9fd2-af89749fb50f\\n true\\n true\\n","errorExample":""}]',
'title' => '暂停项目',
'description' => '**'."\n"
.'**',
],
'DescribeProjectAttachments' => [
'summary' => '调用DescribeProjectAttachments获取项目附件列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场业务实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求标识',
'type' => 'string',
'example' => 'e03a9f78-7b40-4fb3-a015-350913e37e3f',
],
'Result' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FileLinkGmtExpired' => [
'description' => '文件地址生效截止时间（unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1589334682404',
],
'StepNo' => [
'description' => '流程节点序号',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'AttachmentToken' => [
'description' => '附件MD5',
'type' => 'string',
'example' => 'Mzc4NDAtODQ3MjY4MzI=',
],
'FileName' => [
'description' => '文件名称',
'type' => 'string',
'example' => 'f8-test-perview.jpeg',
],
'OperatorRole' => [
'description' => ' 操作人角色',
'type' => 'string',
'example' => 'Provider',
],
'NodeName' => [
'description' => '节点名称',
'type' => 'string',
'example' => '等待服务开通',
],
'OperatorName' => [
'description' => '操作人名称',
'type' => 'string',
'example' => '**科技技术有限公司',
],
'FileLink' => [
'description' => '文件访问地址',
'type' => 'string',
'example' => 'http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r*********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D',
],
'GmtCreate' => [
'description' => '附件上传时间（Unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1587968858000',
],
'FileSuffix' => [
'description' => '文件后缀',
'type' => 'string',
'example' => 'jpg',
],
'Operator' => [
'description' => '操作人阿里云UID',
'type' => 'integer',
'format' => 'int64',
'example' => '45261111****',
],
'Content' => [
'description' => '内容文本',
'type' => 'string',
'example' => '无',
],
'NodeId' => [
'description' => '附件上传的流程节点ID',
'type' => 'integer',
'format' => 'int64',
'example' => '8472',
],
'AttachmentType' => [
'description' => '附件类型',
'type' => 'string',
'example' => 'File',
],
'FileSize' => [
'description' => '文件大小（byte）',
'type' => 'integer',
'format' => 'int64',
'example' => '109124',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"e03a9f78-7b40-4fb3-a015-350913e37e3f\\",\\n \\"Result\\": [\\n {\\n \\"FileLinkGmtExpired\\": 1589334682404,\\n \\"StepNo\\": 3,\\n \\"AttachmentToken\\": \\"Mzc4NDAtODQ3MjY4MzI=\\",\\n \\"FileName\\": \\"f8-test-perview.jpeg\\",\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"NodeName\\": \\"等待服务开通\\",\\n \\"OperatorName\\": \\"**科技技术有限公司\\",\\n \\"FileLink\\": \\"http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r*********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D\\",\\n \\"GmtCreate\\": 1587968858000,\\n \\"FileSuffix\\": \\"jpg\\",\\n \\"Operator\\": 0,\\n \\"Content\\": \\"无\\",\\n \\"NodeId\\": 8472,\\n \\"AttachmentType\\": \\"File\\",\\n \\"FileSize\\": 109124\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n e03a9f78-7b40-4fb3-a015-350913e37e3f\\n \\n Mzc4NDAtODQ3MjY4MzI=\\n File\\n \\n http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D\\n 1589334682404\\n f8-test-perview.jpeg\\n 109124\\n jpg\\n 1587968858000\\n 8472\\n 等待服务开通\\n 45261111****\\n **科技技术有限公司\\n Provider\\n 3\\n \\n true\\n","errorExample":""}]',
'title' => '获取项目附件列表',
],
'DescribeProjectInfo' => [
'summary' => '调用DescribeProjectInfo获取项目信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场业务实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'ee3e1b3b-6c38-4bcf-be40-5a946cfda761',
],
'Result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'ProductName' => [
'description' => '云市场商品名称',
'type' => 'string',
'example' => '公司宝****记账',
],
'ProjectStatus' => [
'description' => '项目执行状态，取值：'."\n"
."\n"
.'- Starting：进行中'."\n"
.'- Cancel：已取消'."\n"
.'- Pause：已暂停'."\n"
.'- Finish：已完成',
'type' => 'string',
'example' => 'Starting',
],
'CustomerAliUid' => [
'description' => '用户阿里云UID',
'type' => 'integer',
'format' => 'int64',
'example' => '27291111****',
],
'TemplateType' => [
'description' => '项目所属模板类型，取值：'."\n"
."\n"
.'- Public：公共模板'."\n"
.'- Private：私有模板',
'type' => 'string',
'example' => 'Public',
],
'InstanceId' => [
'description' => '云市场业务实例ID',
'type' => 'string',
'example' => '4****89',
],
'ProductSkuName' => [
'description' => '云市场商品规格名称',
'type' => 'string',
'example' => '小***纳税人',
],
'FinalStepNo' => [
'description' => '最后节点的序号',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'CurrentStepNo' => [
'description' => '当前流程节点',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'GmtExpired' => [
'description' => '项目超时时间（Unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1620403200000',
],
'GmtFinished' => [
'description' => '项目完成时间（Unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1620403200000',
],
'ProductSkuCode' => [
'description' => '云市场商品规格Code',
'type' => 'string',
'example' => 'yuncode****500001',
],
'GmtCreate' => [
'description' => '项目创建时间（Unix时间戳）',
'type' => 'integer',
'format' => 'int64',
'example' => '1588834324000',
],
'SupplierAliUid' => [
'description' => '项目所属厂商UID',
'type' => 'integer',
'format' => 'int64',
'example' => '45121111****',
],
'FinishType' => [
'description' => '项目完成方式，取值：'."\n"
."\n"
.'- null：未完成项目默认值'."\n"
.'- CustomerConfirm：客户手动确认'."\n"
.'- SystemAutoConfirm：因超时系统自动确认',
'type' => 'string',
'example' => 'null',
],
'TemplateId' => [
'description' => '项目所属流程模板ID',
'type' => 'integer',
'format' => 'int64',
'example' => '410',
],
'OrderId' => [
'description' => '订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '2059111111111',
],
'ProductCode' => [
'description' => '商品Code',
'type' => 'string',
'example' => 'cmgj***055',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ee3e1b3b-6c38-4bcf-be40-5a946cfda761\\",\\n \\"Result\\": {\\n \\"ProductName\\": \\"公司宝****记账\\",\\n \\"ProjectStatus\\": \\"Starting\\",\\n \\"CustomerAliUid\\": 0,\\n \\"TemplateType\\": \\"Public\\",\\n \\"InstanceId\\": \\"4****89\\",\\n \\"ProductSkuName\\": \\"小***纳税人\\",\\n \\"FinalStepNo\\": 4,\\n \\"CurrentStepNo\\": 3,\\n \\"GmtExpired\\": 1620403200000,\\n \\"GmtFinished\\": 1620403200000,\\n \\"ProductSkuCode\\": \\"yuncode****500001\\",\\n \\"GmtCreate\\": 1588834324000,\\n \\"SupplierAliUid\\": 0,\\n \\"FinishType\\": \\"null\\",\\n \\"TemplateId\\": 410,\\n \\"OrderId\\": 2059111111111,\\n \\"ProductCode\\": \\"cmgj***055\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ee3e1b3b-6c38-4bcf-be40-5a946cfda761\\n \\n 3\\n 27291111****\\n 4\\n \\n 1588834324000\\n 1620403200000\\n \\n 4****89\\n 2059111111111\\n cmgj***055\\n 公司宝****记账\\n yuncode****500001\\n 小***纳税人\\n Starting\\n 45121111****\\n 410\\n Public\\n \\n true\\n","errorExample":""}]',
'title' => '获取项目信息',
],
'ResumeProject' => [
'summary' => '调用ResumeProject恢复暂停项目。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云市场订单实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4****89',
],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => [
'description' => '操作流程节点ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1922',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注原因',
'type' => 'string',
'required' => false,
'example' => '仓库库存已补充，可安排发货。',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
],
'Result' => [
'description' => '是否返回成功',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalRequest',
'errorMessage' => 'Illegal request.',
],
[
'errorCode' => 'IllegalParameter',
'errorMessage' => 'Illegal parameter %s.',
],
[
'errorCode' => 'IllegalResult',
'errorMessage' => 'Illegal result.',
],
[
'errorCode' => 'IllegalPermission',
'errorMessage' => 'Permission Denied.',
],
[
'errorCode' => 'IllegalOperatorRole',
'errorMessage' => 'Illegal operator role.',
],
[
'errorCode' => 'IllegalCurrentNode',
'errorMessage' => 'Illegal current node.',
],
[
'errorCode' => 'IllegalProjectStatus',
'errorMessage' => 'Illegal project status.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ee69a00f-189b-400f-9fd2-af89749fb50f\\n true\\n true\\n","errorExample":""}]',
'title' => '恢复暂停项目',
'description' => '**'."\n"
.'**',
],
'DescribeLicense' => [
'summary' => '调用 DescribeLicense 查询授权信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'LicenseCode',
'in' => 'query',
'schema' => [
'description' => '激活码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'xxxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求 ID',
'type' => 'string',
'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
],
'License' => [
'description' => '激活码对象',
'type' => 'object',
'properties' => [
'ActivateTime' => [
'description' => '激活时间',
'type' => 'string',
'example' => '2019-05-25 09:00:00',
],
'LicenseStatus' => [
'description' => '激活码状态'."\n"
.'- ACTIVATED'."\n"
.'- INACTIVATED',
'type' => 'string',
'example' => 'ACTIVATED',
],
'ProductName' => [
'description' => '商品名称',
'type' => 'string',
'example' => 'LNMP环境',
],
'ExpiredTime' => [
'description' => '过期时间',
'type' => 'string',
'example' => '2019-06-25 09:00:00',
],
'ProductSkuId' => [
'description' => '商品规格ID',
'type' => 'string',
'example' => 'cmgj02****-prepay',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2019-05-25 09:00:00',
],
'LicenseCode' => [
'description' => '激活码',
'type' => 'string',
'example' => '-',
],
'InstanceId' => [
'description' => '业务实例ID',
'type' => 'string',
'example' => '1551111111',
],
'SupplierName' => [
'description' => '供应商名称',
'type' => 'string',
'example' => '**科技股份有限公司',
],
'ProductCode' => [
'description' => '商品Code',
'type' => 'string',
'example' => 'cmgj02****',
],
'ExtendArray' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LicenseAttribute' => [
'description' => '扩展对象数组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '对象code',
'type' => 'string',
'example' => 'package_version:对应商品规格code;orderBizId:云市场实例ID;activeAddress:激活地址;orderId:包含新购和续费订单ID，逗号分割;aliUid:用户阿里云Uid;expiresTime:授权码过期时间;',
],
'Value' => [
'description' => '对象值',
'type' => 'string',
'example' => '-',
],
],
],
],
],
],
'ExtendInfo' => [
'description' => '扩展属性',
'type' => 'object',
'properties' => [
'AliUid' => [
'description' => '阿里云UID',
'type' => 'integer',
'format' => 'int64',
'example' => '190311111111****',
],
'AccountQuantity' => [
'description' => '账号信息',
'type' => 'integer',
'format' => 'int64',
'example' => '-',
],
'Email' => [
'description' => '邮箱',
'type' => 'string',
'example' => 'id***@**.com',
],
'Mobile' => [
'description' => '电话',
'type' => 'string',
'example' => '129****1111',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Auth.SubAccount.Error',
'errorMessage' => 'The specified AccessKey information does not belong to the RAM user.',
],
[
'errorCode' => 'License.Invalid',
'errorMessage' => 'The specified license is invalid.',
],
[
'errorCode' => 'License.Expired',
'errorMessage' => 'The specified license has expired.',
],
[
'errorCode' => 'License.Discard',
'errorMessage' => 'The specified license has been discarded.',
],
[
'errorCode' => 'License.NotFound',
'errorMessage' => 'The specified license does not exist.',
],
[
'errorCode' => 'Auth.ISV.Error',
'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.',
],
[
'errorCode' => 'Auth.Match',
'errorMessage' => 'The product to be enabled by the specified license does not belong to the ISV.',
],
[
'errorCode' => 'Auth.Authorized',
'errorMessage' => 'The specified RAM user is not authorized.',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"License\\": {\\n \\"ActivateTime\\": \\"2019-05-25 09:00:00\\",\\n \\"LicenseStatus\\": \\"ACTIVATED\\",\\n \\"ProductName\\": \\"LNMP环境\\",\\n \\"ExpiredTime\\": \\"2019-06-25 09:00:00\\",\\n \\"ProductSkuId\\": \\"cmgj02****-prepay\\",\\n \\"CreateTime\\": \\"2019-05-25 09:00:00\\",\\n \\"LicenseCode\\": \\"-\\",\\n \\"InstanceId\\": \\"1551111111\\",\\n \\"SupplierName\\": \\"**科技股份有限公司\\",\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"ExtendArray\\": {\\n \\"LicenseAttribute\\": [\\n {\\n \\"Code\\": \\"package_version:对应商品规格code;orderBizId:云市场实例ID;activeAddress:激活地址;orderId:包含新购和续费订单ID，逗号分割;aliUid:用户阿里云Uid;expiresTime:授权码过期时间;\\",\\n \\"Value\\": \\"-\\"\\n }\\n ]\\n },\\n \\"ExtendInfo\\": {\\n \\"AliUid\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"Email\\": \\"id***@**.com\\",\\n \\"Mobile\\": \\"129****1111\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6EF60BEC-0242-43AF-BB20-270359FB54A7\\n \\n 2019-05-25 09:00:00\\n ACTIVATED\\n LNMP环境\\n 2019-06-25 09:00:00\\n cmgj02****-prepay\\n 2019-05-25 09:00:00\\n -\\n 1551111111\\n **科技股份有限公司\\n cmgj02****\\n \\n -\\n -\\n \\n \\n id***@**.com\\n 129****1111\\n \\n \\n","errorExample":""}]',
'title' => '查询授权信息',
],
'ActivateLicense' => [
'summary' => '调用 ActivateLicense 激活授权码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'LicenseCode',
'in' => 'query',
'schema' => [
'description' => '授权码。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'APSEDH8TA5CSGK-********_6CNTACBH9EQPOATFXJQL4B2COE7M43VVQ7GUGKAA',
],
],
[
'name' => 'Identification',
'in' => 'query',
'schema' => [
'description' => '激活的身份信息，用户的 aliyunUid。',
'type' => 'string',
'required' => false,
'example' => '129****1111',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '成功状态标识',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求 ID',
'type' => 'string',
'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Auth.CallerType',
'errorMessage' => 'RAM users or STS tokens are not supported.',
],
[
'errorCode' => 'License.Invalid',
'errorMessage' => 'The specified license is invalid.',
],
[
'errorCode' => 'License.Expired',
'errorMessage' => 'The specified license has expired.',
],
[
'errorCode' => 'License.Discard',
'errorMessage' => 'The specified license has been discarded.',
],
[
'errorCode' => 'License.NotFound',
'errorMessage' => 'The specified license does not exist.',
],
[
'errorCode' => 'Auth.ISV',
'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.',
],
[
'errorCode' => 'Auth.Match',
'errorMessage' => 'The product to be enabled by the specified license does not belong to the ISV.',
],
[
'errorCode' => 'Auth.Authorized',
'errorMessage' => 'The specified RAM user is not authorized.',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n6EF60BEC-0242-43AF-BB20-270359FB54A7\\ntrue\\n","errorExample":""}]',
'title' => '激活授权码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PushMeteringData' => [
'summary' => '调用PushMeteringData推送计量数据。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'Metering',
'in' => 'query',
'schema' => [
'description' => '示例中的参数说明如下：'."\n"
."\n"
.'- InstanceId：云市场实例ID 。参数类型为String。'."\n"
.'- StartTime：计量开始时间。单位秒（格式为Unix时间戳, 如1723771200）。参数类型为Long。'."\n"
.'- EndTime：计量结束时间。单位秒（格式为Unix时间戳，如1723771800）。参数类型为Long。'."\n"
.'- Entities：计量实体对象。参数类型为List