summaryrefslogtreecommitdiff
path: root/data/en_us/market/2015-11-01/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/market/2015-11-01/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/market/2015-11-01/api-docs.php')
-rw-r--r--data/en_us/market/2015-11-01/api-docs.php8083
1 files changed, 3437 insertions, 4646 deletions
diff --git a/data/en_us/market/2015-11-01/api-docs.php b/data/en_us/market/2015-11-01/api-docs.php
index 2b174b3..a949816 100644
--- a/data/en_us/market/2015-11-01/api-docs.php
+++ b/data/en_us/market/2015-11-01/api-docs.php
@@ -1,452 +1,293 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Market',
- 'version' => '2015-11-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Market', 'version' => '2015-11-01'],
'directories' => [
[
- 'id' => 250866,
- 'title' => null,
+ 'children' => ['DescribeFailedNotifications', 'ConfirmNotification'],
'type' => 'directory',
- 'children' => [
- 'DescribeFailedNotifications',
- 'ConfirmNotification',
- ],
+ 'title' => 'Message Notifications',
],
[
- 'id' => 250867,
- 'title' => null,
+ 'children' => ['ModifyInvoiceForIsv', 'DescribeInvoiceForIsv'],
'type' => 'directory',
- 'children' => [
- 'ModifyInvoiceForIsv',
- 'DescribeInvoiceForIsv',
- ],
+ 'title' => 'Invoice',
],
[
- 'id' => 65815,
- 'title' => null,
+ 'children' => ['DescribePrice', 'DescribeProduct', 'DescribeProducts'],
'type' => 'directory',
- 'children' => [
- 'DescribePrice',
- 'DescribeProduct',
- 'DescribeProducts',
- ],
+ 'title' => 'Product',
],
[
- 'id' => 65819,
- 'title' => null,
+ 'children' => ['DescribeOrderForIsv', 'CreateOrder', 'DescribeOrder'],
'type' => 'directory',
- 'children' => [
- 'DescribeOrderForIsv',
- 'CreateOrder',
- 'DescribeOrder',
- ],
+ 'title' => 'Order',
],
[
- 'id' => 65822,
- 'title' => null,
+ 'children' => ['DescribeProjectMessages', 'DescribeProjectNodes', 'DescribeProjectOperateLogs', 'DescribeCurrentNodeInfo', 'FinishCurrentProjectNode', 'RollbackCurrentProjectNode'],
'type' => 'directory',
- 'children' => [
- 'DescribeProjectMessages',
- 'DescribeProjectNodes',
- 'DescribeProjectOperateLogs',
- 'DescribeCurrentNodeInfo',
- 'FinishCurrentProjectNode',
- 'RollbackCurrentProjectNode',
- ],
+ 'title' => 'Flow',
],
[
- 'id' => 65829,
- 'title' => null,
+ 'children' => ['DescribeInstance', 'DescribeInstanceForIsv', 'DescribeInstances', 'AutoRenewInstance'],
'type' => 'directory',
- 'children' => [
- 'DescribeInstance',
- 'DescribeInstanceForIsv',
- 'DescribeInstances',
- 'AutoRenewInstance',
- ],
+ 'title' => 'Instance',
],
[
- 'id' => 65832,
- 'title' => null,
+ 'children' => ['PauseProject', 'DescribeProjectAttachments', 'DescribeProjectInfo', 'ResumeProject'],
'type' => 'directory',
- 'children' => [
- 'PauseProject',
- 'DescribeProjectAttachments',
- 'DescribeProjectInfo',
- 'ResumeProject',
- ],
+ 'title' => 'Project',
],
[
- 'id' => 65837,
- 'title' => null,
+ 'children' => ['DescribeLicense', 'ActivateLicense'],
'type' => 'directory',
- 'children' => [
- 'DescribeLicense',
- 'ActivateLicense',
- ],
+ 'title' => 'Authorization',
],
[
- 'id' => 65840,
- 'title' => null,
+ 'children' => ['PushMeteringData'],
'type' => 'directory',
- 'children' => [
- 'PushMeteringData',
- ],
+ 'title' => 'Metering',
],
[
- 'id' => 182754,
- 'title' => null,
+ 'children' => ['CrossAccountVerifyToken', 'DescribeDistributionProductsLink', 'DescribeDistributionProducts', 'DescribeApiMetering'],
+ 'type' => 'directory',
+ 'title' => 'Other',
+ ],
+ [
+ 'children' => ['PushTimesUsage'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'CrossAccountVerifyToken',
- 'DescribeDistributionProductsLink',
- 'DescribeDistributionProducts',
- 'DescribeApiMetering',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'DescribeFailedNotifications' => [
- 'summary' => '查询订阅通知失败列表',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ActivateLicense' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'PageNumber',
+ 'name' => 'LicenseCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The authorization code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'APSEDH8TA5CSGK-********_6CNTACBH9EQPOATFXJQL4B2COE7M43VVQ7GUGKAA', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Identification',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The identity information for activation. Set this parameter to the Alibaba Cloud account ID (aliyunUid) of the user.', 'type' => 'string', 'required' => false, 'example' => '129****1111', 'title' => ''],
],
],
'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' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'NotificationRequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'deab3673236843a3b378c7d8d25c5f01',
- ],
- 'Message' => [
- 'description' => '',
- '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',
- ],
- ],
- ],
- ],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
- ],
+ ['errorCode' => 'Auth.CallerType', 'errorMessage' => 'RAM users or STS tokens are not supported.', 'description' => 'RAM users or STS tokens are not supported.'],
+ ['errorCode' => 'License.Invalid', 'errorMessage' => 'The specified license is invalid.', 'description' => 'The specified license is invalid.'],
+ ['errorCode' => 'License.Expired', 'errorMessage' => 'The specified license has expired.', 'description' => 'The specified license has expired.'],
+ ['errorCode' => 'License.Discard', 'errorMessage' => 'The specified license has been discarded.', 'description' => 'The specified license has been discarded.'],
+ ['errorCode' => 'License.NotFound', 'errorMessage' => 'The specified license does not exist.', 'description' => 'The specified license does not exist.'],
+ ['errorCode' => 'Auth.ISV', 'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.', 'description' => '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.', 'description' => '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.', 'description' => 'The specified RAM user is not authorized.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- '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"}]',
- ],
- 'ConfirmNotification' => [
- 'summary' => '确认查收订阅通知',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'Activate an authorization code',
+ 'summary' => 'Activates an authorization code by calling ActivateLicense.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ActivateLicense',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","type":"json"}]',
+ ],
+ 'AutoRenewInstance' => [
+ 'summary' => 'Sets auto-renewal.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'NotificationRequestId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'deab3673236843a3b378c7d8d25c5f01',
- ],
+ 'name' => 'Type',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n"
+ .'- open: enables auto-renewal.'."\n"
+ .'- close: disables auto-renewal.'."\n"
+ ."\n"
+ .'This parameter is required.', 'type' => 'string', 'required' => true, 'example' => ''],
+ ],
+ [
+ 'name' => 'OrderBizId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The Alibaba Cloud Marketplace instance ID. This parameter is required.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => ''],
+ ],
+ [
+ 'name' => 'AutoRenewCycle',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The cycle unit. This parameter is required when enabling auto-renewal. Valid values:'."\n"
+ .'- Day: day.'."\n"
+ .'- Month: month.'."\n"
+ .'- Year: year.', 'type' => 'string', 'example' => ''],
+ ],
+ [
+ 'name' => 'AutoRenewDuration',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The renewal cycle. This parameter is required when enabling auto-renewal.', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
'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',
- ],
+ 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'Data' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => 'ResponseDTO<Boolean>',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-23T01:54:11.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:AutoRenewInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A077D99E-0C4D-421E-A5D4-F533F6657817\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": false,\\n \\"Data\\": false,\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '',
],
- 'ModifyInvoiceForIsv' => [
- 'summary' => '发票受理接口',
+ 'ConfirmNotification' => [
+ 'summary' => 'Confirms that the merchant has received and processed a notification message. After this call, the message will no longer be returned in subsequent queries.',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'title' => '发票类型:数字电子普通发票:2;数字电子专用发票:3',
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'OperateType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '操作类型:开票:0 ;拒绝开票:1',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'CheckNotice',
- 'in' => 'query',
- 'schema' => [
- 'title' => '服务商发票信息备注',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Number',
+ 'name' => 'NotificationRequestId',
'in' => 'query',
- 'schema' => [
- 'title' => '发票号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1897702****',
- ],
+ 'schema' => ['description' => 'The notification request ID.', 'type' => 'string', 'required' => true, 'example' => 'deab3673236843a3b378c7d8d25c5f01', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmjj01**45',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817'],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ],
],
- '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"}]',
- ],
- 'DescribeInvoiceForIsv' => [
- 'summary' => '查询供应商下的发票信息',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Confirm subscription notification receipt',
+ 'description' => 'Confirms the receipt of a subscription notification failure message.'."\n"
+ ."\n"
+ .'- After a successful call, the message will no longer be returned in subsequent queries. The platform considers that the merchant has correctly processed the message.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ConfirmNotification',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A077D99E-0C4D-421E-A5D4-F533F6657817\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'CreateOrder' => [
+ 'summary' => 'Calls the CreateOrder operation to create an order.'."\n"
+ ."\n"
+ .'Before calling this operation, make sure that you fully understand the billing method and pricing of Alibaba Cloud Marketplace products.'."\n"
+ ."\n"
+ .'To create an order for a commercial image, refer to [CreateInstance](~~25499~~).',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -454,431 +295,199 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'Status',
+ 'name' => 'OrderType',
'in' => 'query',
- 'schema' => [
- 'title' => '发票状态:申请中:0;已完成:1',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'The order type. Valid values: '."\n"
+ .'- INSTANCE_BUY: purchase a product. '."\n"
+ .'- INSTANCE_RENEW: renew an instance. '."\n"
+ .'- INSTANCE_UPGRADE: upgrade an instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_BUY', 'title' => ''],
],
[
- 'name' => 'Type',
+ 'name' => 'Commodity',
'in' => 'query',
- 'schema' => [
- 'title' => '发票类型:数字电子普通发票:2;数字电子专用发票:3',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The commodity information of the order. '."\n"
+ ."\n"
+ .'You can serialize the corresponding commodity based on the specified OrderType.'."\n"
+ ."\n"
+ .'The CommodityType values that correspond to different OrderType values are as follows: '."\n"
+ .'* INSTANC_BUY: InstanceBuyCommodity'."\n"
+ .'* INSTANCE_RENEW: InstanceRenewCommodity'."\n"
+ .'* INSTANCE_UPGRADE: InstanceUpgradeCommodity'."\n"
+ ."\n"
+ .'The metric description of the Commodity parameter in the example is as follows:'."\n"
+ .'- Required parameters'."\n"
+ .' - productCode: the commodity code.'."\n"
+ .' - skuCode: the commodity specification code. Set this parameter to prepay for upfront or postpay for pay-as-you-go.'."\n"
+ .' - duration: the number of periods, such as 1, 2, or 3.'."\n"
+ .' - pricingCycle: the period unit. Valid values: Day, Month, and Year.'."\n"
+ .' - components: the specification modules. The package_version parameter is required. Other modules depend on the commodity settings.'."\n"
+ ."\n"
+ .'- Optional parameters'."\n"
+ .' - quantity: the quantity to purchase.'."\n"
+ .' - queryPromotion: specifies whether to query promotions.'."\n"
+ .' - couponId: the coupon ID.'."\n"
+ .' - properties: the order extension property string in JSON dict format. Pass parameter values in this field as needed.', '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”} ', 'title' => ''],
],
[
- 'name' => 'InvoiceId',
+ 'name' => 'OrderSouce',
'in' => 'query',
- 'schema' => [
- 'title' => '发票Id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '4072040****',
- ],
+ 'schema' => ['description' => 'The order source. This parameter is not in use.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'PaymentType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The payment method. Valid values:'."\n"
+ .'* AUTO: automatic payment from the account balance.'."\n"
+ .'* HAND: manual payment.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HAND', 'title' => ''],
],
[
- 'name' => 'UserId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '客户的阿里云userId',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '174452687724****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. This parameter value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2709c68a-d569-4819-9c5d-1222ed2ee924', 'title' => ''],
],
- [
- 'name' => 'CreateTimeEnd',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '开始时间',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '202********0117', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed', 'title' => ''],
+ 'InstanceIds' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'InstanceId' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '5604018', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-01-01 00:00:00',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'CreateTimeStart',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-01-31 23:59:59',
- ],
+ ],
+ 'title' => 'Create an order',
+ 'description' => 'Before calling this operation, make sure that you fully understand the billing method and [pricing](https://market.aliyun.com/) of Alibaba Cloud Marketplace products.'."\n"
+ ."\n"
+ .'To create an order for a commercial image, refer to [CreateInstance](https://help.aliyun.com/document_detail/25499.html).',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-03-28T06:49:05.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateOrder'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PageIndex',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'acm:CreateOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"202********0117\\",\\n \\"RequestId\\": \\"4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"5604018\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'CrossAccountVerifyToken' => [
+ 'summary' => 'Query cross-account role authorization information, including the authorized user\'s Alibaba Cloud account UID, name, authorization time, and authorized role name.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'name' => 'Token',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Token returned upon successful cross-account role authorization.', 'type' => 'string', 'required' => false, 'example' => 'C19D103FEA2D50A584410267CE9FBA56'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'Response result object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '102277855749****',
- ],
- 'CreateTimeStr' => [
- 'type' => 'string',
- ],
- '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' => '',
- 'type' => 'string',
- 'example' => '9540765',
- ],
- 'OrderType' => [
- 'title' => '订账单类型'."\n"
- .'0:订单'."\n"
- .'1:账单',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'OutBizId' => [
- 'title' => '订单Id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024091610072000****',
- ],
- 'RealAliyunPk' => [
- 'title' => '订单归属账号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '102277855749****'."\n",
- ],
- 'RealAliyunId' => [
- 'type' => 'string',
- ],
- 'ProductCode' => [
- 'type' => 'string',
- ],
- 'ProductName' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '58050005',
- ],
- 'InvoiceId' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'InvoiceList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50000018',
- ],
- 'InvoiceAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '99.99',
- ],
- ],
- ],
- ],
- 'MaterialType' => [
- 'title' => '发票开具类型,0:纸质,1:电子',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ModifiedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-03-04T09:43:18+08:00',
- ],
- 'Price' => [
- 'title' => '电子发票下载地址',
- 'description' => '',
- 'type' => 'string',
- 'example' => '99.99',
- ],
- 'Status' => [
- 'title' => '发票状态 0:待开票;1:已开票',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Title' => [
- 'title' => '发票抬头',
- 'description' => '',
- 'type' => 'string',
- ],
- 'Type' => [
- 'title' => '数字电子普通发票:2'."\n"
- .'数字电子专用发票:3',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'UserAddressDto' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AliyunPk' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'BizType' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'Emails' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'Addressee' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'DeliveryAddress' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'Phone' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'PostalCode' => [
- 'description' => '',
- 'type' => 'string',
- ],
- ],
- ],
- 'ModifiedTimeStr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-01-01 00:00:00'."\n",
- ],
- 'ReceiptUserInfoDto' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaxNumber' => [
- 'description' => '',
- 'type' => 'string',
- ],
- ],
- ],
- 'UserNotice' => [
- 'title' => '用户发票备注',
- 'type' => 'string',
- ],
- 'CheckNotice' => [
- 'title' => '服务商发票备注',
- 'type' => 'string',
- ],
+ 'description' => 'Response result object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '', 'description' => 'User display name.', 'type' => 'string', 'example' => 'marketplace_wangxiao_test'],
+ 'Uid' => ['title' => '', 'description' => 'User Alibaba Cloud UID.', 'type' => 'string', 'example' => '1744526877246715'],
+ 'AuthTime' => ['title' => '', 'description' => 'Authorization time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1676974108866'],
+ 'AuthRoles' => [
+ 'title' => '',
+ 'description' => 'Authorized roles.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Authorized role name.', 'type' => 'string', 'example' => 'VendorCrossAccountXIAOYUNACCESSSMSRole', 'title' => ''],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C19D103F-EA2D-50A5-8441-0267CE9FBA56', 'title' => ''],
],
+ 'example' => '',
],
],
- 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',
- ],
+ ],
+ 'title' => 'Query cross-account role authorization information',
+ 'responseParamsDescription' => 'The Name and Uid fields of the authorized user\'s Alibaba Cloud account information in the response are desensitized by default. To display them in plain text, contact the Cloud Marketplace operations team for activation.',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-03T01:36:13.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:CrossAccountVerifyToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- '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"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"Name\\": \\"marketplace_wangxiao_test\\",\\n \\"Uid\\": \\"1744526877246715\\",\\n \\"AuthTime\\": 1676974108866,\\n \\"AuthRoles\\": [\\n \\"VendorCrossAccountXIAOYUNACCESSSMSRole\\"\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C19D103F-EA2D-50A5-8441-0267CE9FBA56\\"\\n}","type":"json"}]',
],
- 'DescribePrice' => [
- 'summary' => '查询价格',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeApiMetering' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -886,217 +495,99 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OrderType',
+ 'name' => 'productCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'INSTANCE_BUY',
- ],
+ 'schema' => ['description' => 'The commodity code.', 'type' => 'string', 'required' => false, 'example' => 'cmapi0004****', 'title' => ''],
],
[
- 'name' => 'Commodity',
+ 'name' => 'type',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"components":{"package_version":"yuncode12928000016"},"duration":1,"pricingCycle":"YEAR","productCode":"cmgj01**28","quantity":1,"skuCode":"prepay"}',
- ],
+ 'schema' => ['description' => 'The type. Valid values:'."\n"
+ .'- 1: subscription package.'."\n"
+ .'- 2: resource plan.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
'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' => '',
- 'type' => 'string',
- 'example' => 'MONTH',
- ],
- 'TradePrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '19.80',
- ],
- 'OriginalPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '198.00',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Currency' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'ExpressionMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'InfoTitle' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj01****',
- ],
- 'PromotionRules' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'PromotionRule' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Title' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RuleId' => [
- 'description' => '',
- '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',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '62FC432C55A1A63534A6CB34', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Result' => [
+ 'description' => 'The list of results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The individual object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AliyunPk' => ['description' => 'The Alibaba Cloud primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '102277855749****', 'title' => ''],
+ 'ProductCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmapi0004****', 'title' => ''],
+ 'ProductName' => ['description' => 'The commodity name.', 'type' => 'string', 'example' => '身份证实名认证-身份证实名', 'title' => ''],
+ 'TotalQuota' => ['description' => 'The remaining quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '98', 'title' => ''],
+ 'TotalUsage' => ['description' => 'The usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '220', 'title' => ''],
+ 'TotalCapacity' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'Unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => '次', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Count' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"成功"', 'title' => ''],
+ 'Version' => ['description' => 'The version.', 'type' => 'string', 'example' => '1.0', 'title' => ''],
+ 'Fatal' => ['description' => 'fatal', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- ],
- [
- [
- 'errorCode' => 'DownstreamError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ 'title' => 'Retrieve API quota',
+ 'summary' => 'Retrieves the API quota data of a user, including the remaining quota, total quota, and usage.',
+ 'description' => '### **Note: This operation supports both Alibaba Cloud accounts and RAM users to retrieve API remaining quota, total quota, and usage information.**.',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-29T06:21:08.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-12-25T03:49:10.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiMetering'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'ReturnNull',
- 'errorMessage' => 'No results found.',
- ],
- ],
- 999999 => [
- [
- 'errorCode' => 'IgnoreError',
- 'errorMessage' => 'The specified parameter is invalid.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeApiMetering',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<DescribePriceResponse>\\n <Cuxiao>false</Cuxiao>\\n <Cycle>Month</Cycle>\\n <DiscountPrice>0</DiscountPrice>\\n <Duration>1</Duration>\\n <OriginalPrice>0</OriginalPrice>\\n <ProductCode>cmgj01****</ProductCode>\\n <TradePrice>0</TradePrice>\\n</DescribePriceResponse>","errorExample":""}]',
- 'title' => 'DescribePrice',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"62FC432C55A1A63534A6CB34\\",\\n \\"Code\\": \\"200\\",\\n \\"Result\\": [\\n {\\n \\"AliyunPk\\": 0,\\n \\"ProductCode\\": \\"cmapi0004****\\",\\n \\"ProductName\\": \\"身份证实名认证-身份证实名\\",\\n \\"TotalQuota\\": 98,\\n \\"TotalUsage\\": 220,\\n \\"TotalCapacity\\": 0,\\n \\"Unit\\": \\"次\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"Success\\": true,\\n \\"Count\\": 100,\\n \\"PageSize\\": 20,\\n \\"Message\\": \\"\\\\\\"成功\\\\\\"\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Fatal\\": false\\n}","type":"json"}]',
],
- 'DescribeProduct' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeCurrentNodeInfo' => [
+ 'summary' => 'Calls DescribeCurrentNodeInfo to retrieve the process information of the current node.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1104,40 +595,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'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',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace order.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
],
'responses' => [
@@ -1145,417 +608,84 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'FrontCategoryId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '523617212',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MIRROR',
- ],
- 'PicUrl' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1526111111****',
- ],
- 'GmtCreated' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1578931200000',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
- ],
- 'ShortDescription' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmjj01**45',
- ],
- 'AuditFailMsg' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AuditTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1581609600000',
- ],
- 'AuditStatus' => [
- 'description' => '',
- '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' => '',
- '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' => '',
- '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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'img_id',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Id' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'number',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- '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' => '',
- ],
- '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' => [
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d', 'title' => ''],
+ 'Result' => [
+ 'description' => 'The process node information returned upon success.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'ProductExtra' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- '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' => '',
- ],
- ],
- ],
- ],
+ 'NextNodeId' => ['description' => 'The ID of the next process node.', 'type' => 'integer', 'format' => 'int64', 'example' => '8473', 'title' => ''],
+ 'StepNo' => ['description' => 'The sequence number of the process node.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'AutoFinishNode' => ['description' => 'Indicates whether the node is automatically completed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'FinalStepNo' => ['description' => 'The sequence number of the last node.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'PreviousNodeId' => ['description' => 'The ID of the previous process node.', 'type' => 'integer', 'format' => 'int64', 'example' => '8471', 'title' => ''],
+ 'ParentNodeId' => ['description' => 'The ID of the parent process node.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'GmtExpired' => ['description' => 'The timeout of the process node. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1588920725000', 'title' => ''],
+ 'OperatorRole' => ['description' => 'The role of the operator for the process node. Valid values:'."\n"
+ .'- system: system.'."\n"
+ .'- custom: user.', 'type' => 'string', 'example' => 'Provider', 'title' => ''],
+ 'GmtStart' => ['description' => 'The start time of the process node. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000', 'title' => ''],
+ 'NodeStatus' => ['description' => 'The execution status of the node. Valid values:'."\n"
+ .'- NotStart: not started.'."\n"
+ .'- Starting: in progress.'."\n"
+ .'- Cancel: canceled.'."\n"
+ .'- Finish: completed.', 'type' => 'string', 'example' => 'Starting', 'title' => ''],
+ 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => '等待服务开通', 'title' => ''],
+ 'GmtFinished' => ['description' => 'The completion time of the process node. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1588920725000', 'title' => ''],
+ 'AllowRollbackNode' => ['description' => 'Indicates whether rollback to the previous process node is allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'TemplateForm' => ['description' => 'The form content of the process node in JSON format.'."\n"
+ .'Sample code:'."\n"
+ .'`[ { "fieldKey": "TFD0", //form key "isRequired": true, //whether the field is required "maxLength": 50, //maximum length "placeHolder": "姓名", //form value description "stepNum": 0, //sort value (ascending) "title": "收货人姓名", //form title "type": "text" //form type }, { "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"}]', 'title' => ''],
+ 'NeedAttachment' => ['description' => 'Indicates whether uploading an attachment is mandatory.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'NodeId' => ['description' => 'The ID of the process node.', 'type' => 'integer', 'format' => 'int64', 'example' => '8472', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'DeniedModify',
- 'errorMessage' => 'You are not authorized to call the specified API operation.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- '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\\": \\"<div>基于阿里云(Ubuntu16.04 64位)系统源码安装,安全、稳定、高效!</div>\\",\\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":"<DescribeProductResponse>\\n<Description>&lt;p&gt;aaa&lt;/p&gt;</Description>\\n<Type>APP</Type>\\n<PicUrl>https://photogallery.oss.aliyuncs.com/photo/1666562244190862/17909/ce4e8f40-1d3e-465d-b884-f78a432cde81.jpg</PicUrl>\\n<Code>cmgj02****</Code>\\n<ProductExtras>\\n <ProductExtra>\\n <Values>\\"aaa\\"</Values>\\n <Key>product_advantage</Key>\\n <Type>HTML</Type>\\n <Order>0</Order>\\n <Label>产品亮点</Label>\\n </ProductExtra>\\n <ProductExtra>\\n <Values>\\n <Value>[\\"Windows\\"]</Value>\\n <Label>适用系统版本</Label>\\n </Values>\\n <Values>\\n <Value>aa</Value>\\n <Label>版本号</Label>\\n </Values>\\n <Values>\\n <Value>应用软件类</Value>\\n <Label>交付方式</Label>\\n </Values>\\n <Key>product_param</Key>\\n <Type>LIST</Type>\\n <Order>15</Order>\\n <Label>产品参数</Label>\\n </ProductExtra>\\n</ProductExtras>\\n<Name>V3【回归】服务类-按周期</Name>\\n<ShortDescription>aaa</ShortDescription>\\n<ShopInfo>\\n <Telephones>\\n <Telephone>1581016*****</Telephone>\\n </Telephones>\\n <Name>****有限公司测试</Name>\\n <Emails>***.dxz@***.com</Emails>\\n <WangWangs>\\n <WangWang>\\n <UserName>凌鲲</UserName>\\n <Remark>凌鲲</Remark>\\n </WangWang>\\n </WangWangs>\\n <Id>1597411</Id>\\n</ShopInfo>\\n<ProductSkus>\\n <ProductSku>\\n <ChargeType>PREPAY</ChargeType>\\n <Name>预付费</Name>\\n <OrderPeriods>\\n <OrderPeriod>\\n <Name>一年</Name>\\n <PeriodType>YEAR</PeriodType>\\n </OrderPeriod>\\n </OrderPeriods>\\n <Modules>\\n <Module>\\n <Name>几号数</Name>\\n <Id>1018040000484633</Id>\\n <Code>AC</Code>\\n <Properties>\\n <Property>\\n <Name>几号数</Name>\\n <Key>AC</Key>\\n <DisplayUnit>个</DisplayUnit>\\n <PropertyValues>\\n <PropertyValue>\\n <Step>1</Step>\\n <Type>range_float</Type>\\n <Max>999</Max>\\n <Min>1</Min>\\n </PropertyValue>\\n <PropertyValue>\\n <Step>1</Step>\\n <Type>range_float</Type>\\n <Max>999999999999999</Max>\\n <Min>999</Min>\\n </PropertyValue>\\n </PropertyValues>\\n <ShowType>number</ShowType>\\n </Property>\\n </Properties>\\n </Module>\\n <Module>\\n <Name>购买个数</Name>\\n <Id>1018040000484634</Id>\\n <Code>order_num</Code>\\n <Properties>\\n <Property>\\n <Name>购买个数</Name>\\n <Key>order_num</Key>\\n <DisplayUnit/>\\n <PropertyValues>\\n <PropertyValue>\\n <Step>1</Step>\\n <Type>range_float</Type>\\n <Max>100</Max>\\n <Min>1</Min>\\n </PropertyValue>\\n </PropertyValues>\\n <ShowType>number</ShowType>\\n </Property>\\n </Properties>\\n </Module>\\n <Module>\\n <Name>购买时长</Name>\\n <Id>1018040000484740</Id>\\n <Code>ord_time</Code>\\n <Properties>\\n <Property>\\n <Name>购买时长</Name>\\n <Key>ord_time</Key>\\n <DisplayUnit/>\\n <PropertyValues>\\n <PropertyValue>\\n <Value>1:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>1个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>2:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>2个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>3:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>3个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>4:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>4个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>5:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>5个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>6:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>6个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>7:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>7个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>8:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>8个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>9:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>9个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>10:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>10个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>11:Month</Value>\\n <Type>single_string</Type>\\n <DisplayName>11个月</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>1:Year</Value>\\n <Type>single_string</Type>\\n <DisplayName>1年</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>2:Year</Value>\\n <Type>single_string</Type>\\n <DisplayName>2年</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>3:Year</Value>\\n <Type>single_string</Type>\\n <DisplayName>3年</DisplayName>\\n </PropertyValue>\\n </PropertyValues>\\n <ShowType>radio</ShowType>\\n </Property>\\n </Properties>\\n </Module>\\n <Module>\\n <Name>套餐配置</Name>\\n <Id>1018040000484632</Id>\\n <Code>package_config</Code>\\n <Properties>\\n <Property>\\n <Name>套餐配置</Name>\\n <Key>package_config</Key>\\n <DisplayUnit/>\\n <PropertyValues>\\n <PropertyValue>\\n <Value>yuncode2138100001</Value>\\n <Type>single_string</Type>\\n <DisplayName>{\\"frontShow\\":true}</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>yuncode2138100002</Value>\\n <Type>single_string</Type>\\n <DisplayName>{\\"frontShow\\":true}</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>yuncode2138100003</Value>\\n <Type>single_string</Type>\\n <DisplayName>{\\"frontShow\\":true}</DisplayName>\\n </PropertyValue>\\n </PropertyValues>\\n <ShowType>string</ShowType>\\n </Property>\\n </Properties>\\n </Module>\\n <Module>\\n <Name>套餐版本</Name>\\n <Id>1018040000484631</Id>\\n <Code>package_version</Code>\\n <Properties>\\n <Property>\\n <Name>套餐版本</Name>\\n <Key>package_version</Key>\\n <DisplayUnit/>\\n <PropertyValues>\\n <PropertyValue>\\n <Value>yuncode2138100001</Value>\\n <Type>single_string</Type>\\n <DisplayName>月版</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>yuncode2138100002</Value>\\n <Type>single_string</Type>\\n <DisplayName>年版</DisplayName>\\n </PropertyValue>\\n <PropertyValue>\\n <Value>yuncode2138100003</Value>\\n <Type>single_string</Type>\\n <DisplayName>年月版</DisplayName>\\n </PropertyValue>\\n </PropertyValues>\\n <ShowType>radio</ShowType>\\n </Property>\\n </Properties>\\n </Module>\\n </Modules>\\n <Constraints>{\\"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\\"]}}}</Constraints>\\n <Hidden>false</Hidden>\\n <Code>cmgj02****-prepay</Code>\\n </ProductSku>\\n</ProductSkus>\\n<Score>0</Score>\\n<SupplierPk>152611111****</SupplierPk>\\n<FrontCategoryId>523617212</FrontCategoryId>\\n</DescribeProductResponse>","errorExample":""}]',
- 'title' => 'DescribeProduct',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeProducts' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Retrieve process information of the current node',
+ 'description' => '**'."\n"
+ .'**.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeCurrentNodeInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeDistributionProducts' => [
+ 'summary' => 'Retrieves a paginated list of promotional products with detailed information.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1563,69 +693,48 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of promotional products per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of filter conditions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'categoryId',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '53366009',
- ],
+ 'Key' => ['description' => 'The search label category. Valid values:'."\n"
+ ."\n"
+ .'- code: the commodity code of the promotional product'."\n"
+ .'- name: the name of the promotional product'."\n"
+ .'- supplierName: the name of the promotion service provider.', 'type' => 'string', 'required' => true, 'example' => 'supplierName', 'title' => ''],
+ 'Value' => ['description' => 'The search tag value:'."\n"
+ ."\n"
+ .'- code: the product code to search for'."\n"
+ .'- name: the product name to search for'."\n"
+ .'- supplierName: the supplier name to search for.', 'type' => 'string', 'required' => true, 'example' => 'cmj0000000', 'title' => ''],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'maxItems' => 5,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1634,170 +743,103 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png',
- ],
- 'WarrantyDate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Tags' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5.0',
- ],
- 'SupplierId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '228399',
- ],
- 'OperationSystem' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'windows',
- ],
- 'ShortDescription' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DeliveryDate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TargetUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '/products/53616009/cmjj02****.html',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmjj02****',
- ],
- 'CategoryId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '53398003',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SuggestedPrice' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SupplierName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of promotional products per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of promotional products that match the search conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'Results' => [
+ 'description' => 'The promotional product information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FirstCategoryName' => ['title' => '', 'description' => 'The first-level category name of the product.', 'type' => 'string', 'example' => 'API市场'],
+ 'SecondCategoryName' => ['title' => '', 'description' => 'The second-level category name of the product.', 'type' => 'string', 'example' => '生活服务'],
+ 'Type' => ['title' => '', 'description' => 'The product type. Valid values:'."\n"
+ .' APP: application'."\n"
+ .' SERVICE: service'."\n"
+ .' CHENGPIN_SITE: ready-made website'."\n"
+ .' SITE_CUSTOM_SERVICE: custom website'."\n"
+ .' SITE_PROMOTION_RUN: website promotion and operations'."\n"
+ .' ENT_APP_SOFT: application software'."\n"
+ .' CLOUD_SERVICE: cloud service'."\n"
+ .' EIF: enterprise information'."\n"
+ .' BASIC_TOOLS: basic tools'."\n"
+ .' BASIC_SERVICES: basic services'."\n"
+ .' JIANZHAN_XITONG: website building system'."\n"
+ .' APP_COUPLES: application companion'."\n"
+ .' MIRRORS_MARKET: image marketplace'."\n"
+ .' MIRRORS_MARKET_BASIC_ENVIRONMENT: basic environment'."\n"
+ .' MIRRORS_MARKET_APPLICATION_SOFTWARE: application software'."\n"
+ .' MIRROR: image'."\n"
+ .' DINGDING: DingTalk'."\n"
+ .' DOWNLOAD: download'."\n"
+ .' EXTENDED: unknown'."\n"
+ .' API_SERVICE: API'."\n"
+ .' ROS: resource orchestration'."\n"
+ .' DOCKER: container'."\n"
+ .' LICENSE: license key'."\n"
+ .' SAAS_WUYING: application software - Wuying application.', 'type' => 'string', 'example' => 'API类'],
+ 'ImageUrl' => ['title' => '', 'description' => 'The URL of the product main image.', 'type' => 'string', 'example' => '//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg'],
+ 'Code' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'cmap*****'],
+ 'Name' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '手机号码在网状态查询'],
+ 'ShortDescription' => ['title' => '', 'description' => 'The brief description of the product.', 'type' => 'string', 'example' => '运营商号码状态查询】精准实时空号检测,手机号在网状态查询,返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。'],
+ 'Price' => ['title' => '', 'description' => 'The price of the default product specification. For example, 100 indicates CNY 100.', 'type' => 'string', 'example' => '100'],
+ 'Score' => ['title' => '', 'description' => 'The user rating of the product.', 'type' => 'string', 'example' => '5'],
+ 'TradeCount' => ['title' => '', 'description' => 'The number of transactions for the product in the last 180 days.', 'type' => 'string', 'example' => '109'],
+ 'UserCommentCount' => ['title' => '', 'description' => 'The number of buyer comments for the product.', 'type' => 'string', 'example' => '55'],
+ 'SubmissionRadio' => ['title' => '', 'description' => 'The commission rebate ratio for the product. For example, 30 indicates 30%.', 'type' => 'string', 'example' => '30'],
+ 'SupplierName' => ['title' => '', 'description' => 'The name of the promotion service provider.', 'type' => 'string', 'example' => '深圳市****有限公司'],
+ 'SupplierUId' => ['title' => '', 'description' => 'The Alibaba Cloud UID of the promotion service provider (product supplier).', 'type' => 'string', 'example' => '1911534921******'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ '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.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'user is not distributor!', 'description' => ''],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request. ', 'description' => ''],
],
],
- '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\\": \\"【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务,应用标准化全自动服务流程体系,帮助企业轻松拥有官方网站。该建站产品与<em>ECS</em>下单时同时购买,<em>ECS</em>最低配置1核1G即可。购买须知:请在购买<em>ECS</em>配置安全组时选择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":"<DescribeProductsResponse>\\n<pageNumber>1</pageNumber>\\n<pageSize>10</pageSize>\\n<productItems>\\n <categoryId>53398003</categoryId>\\n <code>PHP多版本环境(Windows2012 | phpStudy)</code>\\n <code1>PHP多版本环境(Windows2012 | phpStudy)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png</imageUrl>\\n <operationSystem>Windows2008 R2 企业版 64位</operationSystem>\\n <score>5.0</score>\\n <shortDescription>由Websof9提供的phpStudy镜像是一个预安装环境,可在&lt;em&gt;ECS&lt;/em&gt;上一键安装。phpStudy是一个PHP环境集成包,支持php5.2到7.0多个版本切换,同时支持Apache,Nginx,IIS ...</shortDescription>\\n <suggestedPrice>10元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>企业,上云,Windows,Windows server 2012,Apache,Nginx,Windows面板</tags>\\n</productItems>\\n<productItems>\\n <categoryId>56014009</categoryId>\\n <code>Pydio 开源在线文件管理系统(构建企业网盘和云存储系统)</code>\\n <code1>Pydio 开源在线文件管理系统(构建企业网盘和云存储系统)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7049/47bde5de-8610-439f-a160-1eb34aec5505.png</imageUrl>\\n <operationSystem>CentOS7.0 64位</operationSystem>\\n <score>5.0</score>\\n <shortDescription>由Websof9提供的Pydio镜像是一个预安装环境,可在&lt;em&gt;ECS&lt;/em&gt;上一键安装。Pydio是功能强大在线文件管理系统(ECM),用于构建自托管的企业网盘和云存储系统,支持多用户的文档协作、分享、设备同步。 ...</shortDescription>\\n <suggestedPrice>10元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>企业,应用开发,Linux,Centos,PHP,LAMP</tags>\\n</productItems>\\n<productItems>\\n <categoryId>53616009</categoryId>\\n <code>Joomla! 内容管理系统( WAMP )</code>\\n <code1>Joomla! 内容管理系统( WAMP )</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/5280/fab724de-da66-4548-9717-1a1d3ac6f887.png</imageUrl>\\n <operationSystem>Windows2008 64位 标准版</operationSystem>\\n <score>5.0</score>\\n <shortDescription>由Websof9提供的Joomla3.7.5预装环境,可在&lt;em&gt;ECS&lt;/em&gt;上一键安装。Joomla是全球三大开源内容管理系统之一(CMS),比肩WordPress和Drupal,占据全球5%的建站市场。 ...</shortDescription>\\n <suggestedPrice>10元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>开发者,建站,Windows,Windows server 2008,PHP,WAMP,Joomla!</tags>\\n</productItems>\\n<productItems>\\n <categoryId>53690006</categoryId>\\n <code>Ubuntu 16.04 64位(含Webmin中文)</code>\\n <code1>Ubuntu 16.04 64位(含Webmin中文)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/4613/57259fc6-7086-42b8-9619-f688fd3eb310.png</imageUrl>\\n <score>5.0</score>\\n <shortDescription>由Websoft9提供Ubuntu 16.04+Webmin1.881(中文)镜像,可以一键安装到&lt;em&gt;ECS&lt;/em&gt;。Webmin是知名的Linux可视化面板管理工具,100%免费开源,可轻松管理文件、配置域名、修改配置文件、备份数据等 ...</shortDescription>\\n <suggestedPrice>10元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>站长,上云,Linux,Centos,LAMP,Webmin,Linux面板</tags>\\n</productItems>\\n<productItems>\\n <categoryId>53616009</categoryId>\\n <code>云·企业官网尊贵版(ECS)</code>\\n <code1>云·企业官网尊贵版(ECS)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://photogallery.oss.aliyuncs.com/photo/1984723351411381/22286/727fc507-37b5-4b91-b706-8bbc2a765a88.jpg</imageUrl>\\n <operationSystem>windows</operationSystem>\\n <score>5.0</score>\\n <shortDescription>【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务,应用标准化全自动服务流程体系,帮助企业轻松拥有官方网站。该建站产品与&lt;em&gt;ECS&lt;/em&gt;下单时同时购买,&lt;em&gt;ECS&lt;/em&gt;最低配置1核1G即可。购买须知:请在购买&lt;em&gt;ECS&lt;/em&gt;配置安全组时选择HTTP:80端口 ...</shortDescription>\\n <suggestedPrice>998元/月</suggestedPrice>\\n <supplierId>3587828</supplierId>\\n <supplierName>**-云市场自营店</supplierName>\\n <tags>企业,建站</tags>\\n</productItems>\\n<productItems>\\n <categoryId>56014009</categoryId>\\n <code>Zurmo 开源CRM系统(LAMP)</code>\\n <code1>Zurmo 开源CRM系统(LAMP)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7716/6b100770-1f15-43c6-b99f-9b6c53c89e2d.png</imageUrl>\\n <operationSystem>CentOS7.4 64位</operationSystem>\\n <score>5.0</score>\\n <shortDescription>由Websof9提供的Zurmo镜像是一个预安装环境,可在&lt;em&gt;ECS&lt;/em&gt;上一键安装。Zurmo是一个开源的客户关系管理系统(CRM),使用Yii框架、RedBeanPHP和Jquery实现,界面美观,功能全面 ...</shortDescription>\\n <suggestedPrice>20元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>企业,上云,Linux,Centos,PHP,LAMP,ERP</tags>\\n</productItems>\\n<productItems>\\n <categoryId>56014009</categoryId>\\n <code>SuiteCRM,优质开源CRM</code>\\n <code1>SuiteCRM,优质开源CRM</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7760/0db05f1e-aa8a-490d-b8eb-093c43d93f7d.png</imageUrl>\\n <operationSystem>CentOS7.3 64位</operationSystem>\\n <score>5.0</score>\\n <shortDescription>由Websof9提供的EspoCRM预装环境,可在&lt;em&gt;ECS&lt;/em&gt;上一键安装。SuiteCRM是一个国际上屡获殊荣的企业级的、强大的、可定制的,免费的CRM系统。 ...</shortDescription>\\n <suggestedPrice>20元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>企业,移动营销,Linux,Centos,PHP,LAMP,ERP</tags>\\n</productItems>\\n<productItems>\\n <categoryId>55528001</categoryId>\\n <code>Node.JS6 运行环境(Windows2008 | Nginx | Express)</code>\\n <code1>Node.JS6 运行环境(Windows2008 | Nginx | Express)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://photogallery.oss.aliyuncs.com/photo/1904996544835414/7573/e03da499-c7e9-4784-867f-8789539e6a82.png</imageUrl>\\n <score>5.0</score>\\n <shortDescription>Websoft9提供Node.JS镜像,预装了NodeJS 6.14,PM2 2.10,Express框架,Yarn1.7,MySQL5.6,MongoDB4.0,Nginx1.14,任何&lt;em&gt;ECS&lt;/em&gt;用户可以一键获取,用于快速部署Node.JS应用程序。 ...</shortDescription>\\n <suggestedPrice>0元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>企业,上云,Windows,Windows server 2008,Node.js,Nginx,MySQL</tags>\\n</productItems>\\n<productItems>\\n <categoryId>56014009</categoryId>\\n <code>ERPNext 中小企业开源ERP系统(Ubuntu16.04)</code>\\n <code1>ERPNext 中小企业开源ERP系统(Ubuntu16.04)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7259/cdee958f-bcfa-4362-ad2f-543e01140e60.png</imageUrl>\\n <score>5.0</score>\\n <shortDescription>由Websof9提供的Vtiger CRM预装环境,可在&lt;em&gt;ECS&lt;/em&gt;上一键安装。ERPNext是全球化的开源ERP系统,使用Python语言开发,支持70+种语言,拥有150+国家的用户。界面友好,入门简单,包括:财务、采购、销售和库存管理、POS系统、制造管理、资产管理等功能。 ...</shortDescription>\\n <suggestedPrice>10元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>企业,上云,Linux,Ubuntu,Python,ERP</tags>\\n</productItems>\\n<productItems>\\n <categoryId>55530001</categoryId>\\n <code>Gitlab-CE10.1.0 代码托管系统(Ubuntu16)</code>\\n <code1>Gitlab-CE10.1.0 代码托管系统(Ubuntu16)</code1>\\n <deliveryWay>镜像</deliveryWay>\\n <imageUrl>https://oss.aliyuncs.com/photogallery/photo/1904996544835414/17080/cd8053ae-2666-4716-9e4d-1b754f24fbc2.png</imageUrl>\\n <operationSystem>Ubuntu16.04 64位</operationSystem>\\n <score>5.0</score>\\n <shortDescription>由Websof9提供的Omnibus Gitlab镜像是一个预安装环境,可在&lt;em&gt;ECS&lt;/em&gt;上一键安装。Gitlab是一个开源的Git代码仓库系统,用于构建私有代码托管平台,基于Rails开发,速度快、安全稳定 ...</shortDescription>\\n <suggestedPrice>10元/月</suggestedPrice>\\n <supplierId>228399</supplierId>\\n <supplierName>长沙****有限公司</supplierName>\\n <tags>开发者,应用开发,Linux,Ubuntu,Ruby,Nginx,PostgreSQL</tags>\\n</productItems>\\n<requestId>5A85CB8D-EF2F-46DA-91E2-8AF75900F1BF</requestId>\\n<totalCount>75</totalCount>\\n</DescribeProductsResponse>","errorExample":""}]',
- 'title' => 'DescribeProducts',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeOrderForIsv' => [
- 'summary' => '服务商侧查询订单详情',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve a paginated list of promotional products',
+ 'description' => 'Call this operation by using a promotion service provider account.',
+ 'requestParamsDescription' => 'Set code to query a single product, name to search by product name, or supplierName to search by product supplier name.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProducts'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeDistributionProducts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BD09171-MB74-18D8-890E-C70C067527BE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Results\\": [\\n {\\n \\"FirstCategoryName\\": \\"API市场\\",\\n \\"SecondCategoryName\\": \\"生活服务\\",\\n \\"Type\\": \\"API类\\",\\n \\"ImageUrl\\": \\"//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg\\",\\n \\"Code\\": \\"cmap*****\\",\\n \\"Name\\": \\"手机号码在网状态查询\\",\\n \\"ShortDescription\\": \\"运营商号码状态查询】精准实时空号检测,手机号在网状态查询,返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。\\",\\n \\"Price\\": \\"100\\",\\n \\"Score\\": \\"5\\",\\n \\"TradeCount\\": \\"109\\",\\n \\"UserCommentCount\\": \\"55\\",\\n \\"SubmissionRadio\\": \\"30\\",\\n \\"SupplierName\\": \\"深圳市****有限公司\\",\\n \\"SupplierUId\\": \\"1911534921******\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeDistributionProductsLink' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1805,211 +847,98 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OrderId',
+ 'name' => 'Codes',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The collection of product codes. The collection cannot be empty and can contain up to 50 entries.',
+ 'type' => 'array',
+ 'items' => ['description' => 'cmapi*****', 'type' => 'string', 'required' => false, 'example' => 'cmapi******', 'title' => ''],
'required' => true,
'docRequired' => true,
- 'example' => '202*********415',
+ 'minItems' => 1,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'ProductName' => [
- 'title' => '订购商品名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'OriginalPrice' => [
- 'title' => '订单原价(元)',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '10.0',
- ],
- 'AliUid' => [
- 'title' => '阿里云用户唯一标识(aliyunPK)',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'MONTH',
- ],
- 'PayStatus' => [
- 'title' => '付款状态。取值:'."\n"
- .'● PAID 已支付'."\n"
- .'● UNPAID 未支付',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PAID',
- ],
- 'PaymentPrice' => [
- 'title' => '实际支付金额(元)',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.0',
- ],
- 'OrderStatus' => [
- 'title' => '订单状态。取值:'."\n"
- .'● NORMAL 正常'."\n"
- .'● REFUND 退款'."\n"
- .'● DELETE 作废',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- 'ProductSkuCode' => [
- 'title' => '订购商品规格 Code',
- 'description' => '',
- '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' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '202211111111111',
- ],
- 'ProductCode' => [
- 'title' => '商品Code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj02****',
- ],
- 'InstanceIds' => [
- 'title' => '订单关联业务实例 ID',
- 'description' => 'List',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5BD09171-BF4D-18D8-890E-C70C067527BE'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of promoted products.', 'type' => 'integer', 'format' => 'int64', 'example' => '51'],
+ 'Success' => ['title' => '', 'description' => 'The success status indicator.', 'type' => 'boolean', 'example' => 'true'],
+ 'Result' => [
+ 'description' => 'The promotion link information for the promoted products.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => '', 'description' => 'The promotion link for the product. Note: The sample link is a test product link.', 'type' => 'string', 'example' => 'https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D'],
+ 'Code' => ['title' => '', 'description' => 'The code of the promoted product.', 'type' => 'string', 'example' => 'cmapi000****'],
+ 'Name' => ['title' => '', 'description' => 'The name of the promoted product.', 'type' => 'string', 'example' => '测试商品'],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '1597985',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6EF60BEC-****-****-****-270359FB54A7',
- ],
- 'Components' => [
'title' => '',
- 'description' => '',
- 'type' => 'any',
'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
- ],
- ],
500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
+ ['errorCode' => 'Forbidden!', 'errorMessage' => 'user is not distributor!', 'description' => ''],
+ ['errorCode' => 'ProductCodes', 'errorMessage' => 'productCodes is empty!', 'description' => ''],
+ ['errorCode' => 'codeSizeError', 'errorMessage' => 'productCodes size should less than 50!', 'description' => ''],
+ ['errorCode' => 'CodeError', 'errorMessage' => 'codes is not correct!', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve promotion links for products',
+ 'summary' => 'Retrieves promotion links for promoted products.',
+ 'description' => 'Call this operation by using a promotion service provider account. Calls from non-promotion service provider accounts will fail.',
+ 'requestParamsDescription' => 'The array of product codes for promotion cannot be empty, and the array size cannot exceed 50.',
+ 'changeSet' => [
+ ['createdAt' => '2023-06-01T02:25:39.000Z', 'description' => 'Response parameters changed'],
],
- '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":"<DescribeOrderForIsvResponse>\\n <ProductName>saas服务产品</ProductName>\\n <OriginalPrice>10</OriginalPrice>\\n <CouponPrice>0</CouponPrice>\\n <AccountQuantity>0</AccountQuantity>\\n <PeriodType>MONTH</PeriodType>\\n <PayStatus>PAID</PayStatus>\\n <PaymentPrice>0</PaymentPrice>\\n <OrderStatus>NORMAL</OrderStatus>\\n <ProductSkuCode>cmgj02****-prepay</ProductSkuCode>\\n <PaidOn>1531191675000</PaidOn>\\n <CreatedOn>1531191564000</CreatedOn>\\n <OrderType>NEW</OrderType>\\n <TotalPrice>0</TotalPrice>\\n <Quantity>1</Quantity>\\n <OrderId>202211111111111</OrderId>\\n <ProductCode>cmgj02****</ProductCode>\\n <InstanceIds>1597985</InstanceIds>\\n <RequestId>6EF60BEC-****-****-****-270359FB54A7</RequestId>\\n</DescribeOrderForIsvResponse>","errorExample":""}]',
- ],
- 'CreateOrder' => [
- 'summary' => '创建订单',
- 'methods' => [
- 'post',
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProductsLink'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeDistributionProductsLink',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BD09171-BF4D-18D8-890E-C70C067527BE\\",\\n \\"TotalCount\\": 51,\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"Url\\": \\"https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D\\",\\n \\"Code\\": \\"cmapi000****\\",\\n \\"Name\\": \\"测试商品\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeFailedNotifications' => [
+ 'summary' => 'Queries the list of failed subscription notifications. After Alibaba Cloud Marketplace fails to call a service provider\'s message SPI, the service provider can use this operation to proactively query the failed notification information.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2017,116 +946,86 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'OrderType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'INSTANCE_BUY',
- ],
- ],
- [
- 'name' => 'Commodity',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'OrderSouce',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abc',
- ],
- ],
- [
- 'name' => 'PaymentType',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HAND',
- ],
+ 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2709c68a-d569-4819-9c5d-1222ed2ee924',
- ],
+ 'schema' => ['description' => 'The number of instances per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '202********0117',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed',
- ],
- 'InstanceIds' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'InstanceId' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5604018',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
+ 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of instances per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'NotificationList' => [
+ 'description' => 'The notification list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The Notification Recipient.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NotificationRequestId' => ['description' => 'The notification request ID (generated by UUID), used for idempotence.', 'type' => 'string', 'example' => 'deab3673236843a3b378c7d8d25c5f01', 'title' => ''],
+ 'Message' => ['description' => 'The notification message body in JSON format.', 'type' => 'string', 'example' => '{"productCode":"cmgj00001","orderId":"123456","orderBizId":"111222","action":"orderPay","aliUid":"12211222211","skuId":"cmgj00001-prepay"}', 'title' => ''],
+ 'Action' => ['description' => 'The operation event.', 'type' => 'string', 'example' => 'orderPay', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1665988512000', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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":"<CreateOrderResponse>\\n<RequestId>4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed</RequestId>\\n<InstanceIds>\\n <InstanceId>5604018</InstanceId>\\n</InstanceIds>\\n<OrderId>202********0117</OrderId>\\n</CreateOrderResponse>","errorExample":"<?xml version=\'1.0\' encoding=\'UTF-8\'?><Error><RequestId>904A07C3-D30A-4E2C-93B2-DDECAE4B66E8</RequestId><HostId>market.aliyuncs.com</HostId><Code>UnknownError</Code><Message>The request processing has failed due to some unknown error.</Message></Error>\\n"}]',
- 'title' => 'CreateOrder',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeOrder' => [
- 'summary' => '查询订单',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query failed subscription notifications',
+ 'description' => 'Queries the information about failed subscription notifications for a service provider.'."\n"
+ ."\n"
+ .'- If no unconfirmed failed notifications exist, TotalCount returns 0.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeFailedNotifications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'DescribeInstance' => [
+ 'summary' => 'Calls the DescribeInstance operation to query instance information.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2134,22 +1033,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OrderId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '202*********415',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '155****11', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The order type. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'NEW', 'title' => ''],
],
],
'responses' => [
@@ -2157,171 +1051,206 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SupplierCompanyName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'OriginalPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '10.0',
- ],
- 'AliUid' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'MONTH',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
- ],
- 'PayStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PAID',
- ],
- 'PaymentPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.0',
- ],
- 'OrderStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- 'ProductSkuCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj02****-prepay',
- ],
- 'PaidOn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1531191675000',
- ],
- 'Components' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '',
- ],
- 'CreatedOn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1531191564000',
- ],
- 'OrderType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NEW',
- ],
- 'TotalPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.0',
- ],
- 'Quantity' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '202211111111111',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj02****',
- ],
- 'SupplierTelephones' => [
+ 'Status' => ['description' => 'The business status. The value varies based on the product type.'."\n"
+ ."\n"
+ .'If ProductType is set to MIRROR:'."\n"
+ .'- PRODUCE: being provisioned.'."\n"
+ .'- USING: in use.'."\n"
+ .'- UNUSED: not used.'."\n"
+ .'- EXPIRED: expired.'."\n"
+ .'- CLOSED: released.'."\n"
+ ."\n"
+ .'If ProductType is set to SERVICE:'."\n"
+ .'- READYING: not started.'."\n"
+ .'- STARTED: in service.'."\n"
+ .'- CONFIRM: completed.'."\n"
+ .'- EXPIRED: expired.'."\n"
+ .'- CLOSED: released.'."\n"
+ ."\n"
+ .'If ProductType is set to APP, DOWNLOAD, API_SERVICE, or DOCKER:'."\n"
+ .'- OPENING: being activated.'."\n"
+ .'- OPENED: activated.'."\n"
+ .'- EXPIRED: expired.'."\n"
+ .'- CLOSED: released.', 'type' => 'string', 'example' => 'OPENED', 'title' => ''],
+ 'AppJson' => ['description' => 'The application information. The metric description of the parameters in the example is as follows:'."\n"
+ ."\n"
+ .'- username: the username.'."\n"
+ .'- passowrd: the password.'."\n"
+ .'- frontEndUrl: the frontend URL.'."\n"
+ .'- adminUrl: the management URL.', 'type' => 'string', 'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}', 'title' => ''],
+ 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => '***协同办公', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1551111111', 'title' => ''],
+ 'ExtendJson' => ['description' => 'The extended information.', 'type' => 'string', 'example' => '{"说明": "如有使用问题,请联系..."}', 'title' => ''],
+ 'IsTrial' => ['description' => 'Indicates whether the instance is a trial instance.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'BeganOn' => ['description' => 'The time when the instance was activated (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000', 'title' => ''],
+ 'ComponentJson' => ['description' => 'The business module.'."\n"
+ ."\n"
+ .'The metric description of the parameters in the example is as follows:'."\n"
+ ."\n"
+ .'- package_version: the version.', 'type' => 'string', 'example' => '{"package_version":"yuncode000111"}', 'title' => ''],
+ 'Constraints' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'ProductType' => ['description' => 'The product type. Valid values:'."\n"
+ ."\n"
+ .'- APP: application.'."\n"
+ .'- SERVIC: service.'."\n"
+ .'- MIRROR: image.'."\n"
+ .'- DOWNLOAD: download.'."\n"
+ .'- API_SERVICE: API.'."\n"
+ .'- DOCKER: Docker.', 'type' => 'string', 'example' => 'APP', 'title' => ''],
+ 'HostJson' => ['description' => 'The host information. The metric description of the parameters in the example is as follows:'."\n"
+ ."\n"
+ .'- username: the username.'."\n"
+ .'- passowrd: the password.'."\n"
+ .'- ip: the host IP address.'."\n"
+ .'- innerIp: the internal network IP address of the host.', 'type' => 'string', 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}', 'title' => ''],
+ 'ProductSkuCode' => ['description' => 'The SKU code.', 'type' => 'string', 'example' => 'cmgj00**11-prepay', 'title' => ''],
+ 'CreatedOn' => ['description' => 'The creation time (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634018000', 'title' => ''],
+ 'EndOn' => ['description' => 'The expiration time (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1602259200000', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '204211111111111', 'title' => ''],
+ 'ProductCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmgj00**11', 'title' => ''],
+ 'SupplierName' => ['description' => 'The service provider name.', 'type' => 'string', 'example' => '*****有限公司', 'title' => ''],
+ 'RelationalData' => [
+ 'description' => 'The relational information.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Telephone' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{139*****950, 139*****831}',
- ],
- ],
+ 'ServiceStatus' => ['description' => 'The service status. Valid values:'."\n"
+ ."\n"
+ .'- READYING: not started.'."\n"
+ .'- STARTED: in service.'."\n"
+ .'- CONFIRM: completed.'."\n"
+ .'- EXPIRED: expired.'."\n"
+ .'- CLOSED: released.', 'type' => 'string', 'example' => 'STARTED', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'InstanceIds' => [
+ 'Modules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'InstanceId' => [
- 'description' => '',
+ 'Module' => [
+ 'description' => 'The product module information. This parameter is deprecated.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{1597985, 1227195}',
+ 'description' => 'This parameter is deprecated.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'package_config', 'title' => ''],
+ 'Name' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '套餐配置', 'title' => ''],
+ 'Id' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '101*********026', 'title' => ''],
+ 'Properties' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Property' => [
+ 'description' => 'This parameter is deprecated.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'This parameter is deprecated.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'ShowType' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'Name' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'DisplayUnit' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'PropertyValues' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PropertyValue' => [
+ 'description' => 'This parameter is deprecated.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'This parameter is deprecated.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DisplayName' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'Type' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'Step' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'Value' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'Max' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'Remark' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'Min' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'AutoRenewal' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ActiveAddress' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LicenseCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
],
],
- '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":"<DescribeOrderResponse>\\n <PaidOn>1531191675000</PaidOn>\\n <PeriodType>MONTH</PeriodType>\\n <CouponPrice>0.0</CouponPrice>\\n <PayStatus>PAID</PayStatus>\\n <OriginalPrice>10.0</OriginalPrice>\\n <ProductName>saas服务产品</ProductName>\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n <ProductCode>cmgj02****</ProductCode>\\n <SupplierCompanyName>**科技股份有限公司</SupplierCompanyName>\\n <Quantity>1</Quantity>\\n <OrderId>202211111111111</OrderId>\\n <SupplierTelephones>\\n <Telephone>{139*****950, 139*****831}</Telephone>\\n </SupplierTelephones>\\n <Components>{ \\"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\\" } }</Components>\\n <OrderStatus>NORMAL</OrderStatus>\\n <OrderType>NEW</OrderType>\\n <TotalPrice>0.0</TotalPrice>\\n <ProductSkuCode>cmgj02****-prepay</ProductSkuCode>\\n <CreatedOn>1531191564000</CreatedOn>\\n <PaymentPrice>0.0</PaymentPrice>\\n <InstanceIds>\\n <InstanceId>{1597985, 1227195}</InstanceId>\\n </InstanceIds>\\n <AccountQuantity>0</AccountQuantity>\\n <AliUid>190311111111****</AliUid>\\n</DescribeOrderResponse>","errorExample":""}]',
- 'title' => 'DescribeOrder',
- ],
- 'DescribeProjectMessages' => [
- 'summary' => '查询项目留言信息',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Query instance information',
+ 'changeSet' => [
+ ['createdAt' => '2024-03-14T01:57:29.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeInstanceForIsv' => [
+ 'summary' => 'Queries instance information from the service provider side.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2329,157 +1258,178 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
- ],
- [
- 'name' => 'PageIndex',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '155****11', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1589015560000',
- ],
- 'Operator' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '452611111****',
- ],
- 'OperatorRole' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Provider',
- ],
- 'Content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'OperatorName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
+ 'Status' => ['title' => '', 'description' => 'The business status. Different values are set based on the product type.'."\n"
+ ."\n"
+ .'When ProductType is set to MIRROR:'."\n"
+ .'* PRODUCE: being provisioned.'."\n"
+ .'* USING: in use.'."\n"
+ .'* UNUSED: not in use.'."\n"
+ .'* EXPIRED: expired.'."\n"
+ .'* CLOSED: released.'."\n"
+ ."\n"
+ .'When ProductType is set to SERVICE:'."\n"
+ .'* READYING: not started.'."\n"
+ .'* STARTED: in service.'."\n"
+ .'* CONFIRM: completed.'."\n"
+ .'* EXPIRED: expired.'."\n"
+ .'* CLOSED: released.'."\n"
+ ."\n"
+ .'When ProductType is set to APP, DOWNLOAD, API_SERVICE, or DOCKER:'."\n"
+ .'* OPENING: being activated.'."\n"
+ .'* OPENED: activated.'."\n"
+ .'* EXPIRED: expired.'."\n"
+ .'* CLOSED: released.', 'type' => 'string', 'example' => 'OPENED'],
+ 'AppJson' => ['title' => '', 'description' => 'The application information. The metric description of the parameters in the example is as follows:'."\n"
+ ."\n"
+ .'username: the username.'."\n"
+ .'passowrd: the password.'."\n"
+ .'frontEndUrl: the frontend URL.'."\n"
+ .'adminUrl: the administration URL.', 'type' => 'string', 'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}'],
+ 'ProductName' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '***协同办公'],
+ 'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1551111111'],
+ 'ExtendJson' => ['title' => '', 'description' => 'The extended information.', 'type' => 'string', 'example' => '{"说明": "如有使用问题,请联系..."}'],
+ 'IsTrial' => ['title' => '', 'description' => 'Indicates whether the instance is a trial instance.', 'type' => 'boolean', 'example' => 'true'],
+ 'BeganOn' => ['title' => '', 'description' => 'The time when the instance was activated (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000'],
+ 'ComponentJson' => ['title' => '', 'description' => 'The business module. The metric description of the parameters in the example is as follows:'."\n"
+ .'* package_version: the version.', 'type' => 'string', 'example' => '{"package_version":"yuncode000111"}'],
+ 'ProductType' => ['title' => '', 'description' => 'The product type. Valid values:'."\n"
+ .'* APP: application.'."\n"
+ .'* SERVIC: service.'."\n"
+ .'* MIRROR: image.'."\n"
+ .'* DOWNLOAD: download.'."\n"
+ .'* API_SERVICE: API.'."\n"
+ .'* DOCKER: Docker.', 'type' => 'string', 'example' => 'APP'],
+ 'HostJson' => ['title' => '', 'description' => 'The host information. The metric description of the parameters in the example is as follows:'."\n"
+ ."\n"
+ .'username: the username.'."\n"
+ .'passowrd: the password.'."\n"
+ .'ip: the host IP address.'."\n"
+ .'innerIp: the internal network IP address of the host.', 'type' => 'string', 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}'],
+ 'ProductSkuCode' => ['title' => '', 'description' => 'The SKU code.', 'type' => 'string', 'example' => 'cmgj00**11-prepay'],
+ 'CreatedOn' => ['title' => '', 'description' => 'The creation time (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634018000'],
+ 'EndOn' => ['title' => '', 'description' => 'The expiration time (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1602259200000'],
+ 'OrderId' => ['title' => '', 'description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '204211111111111'],
+ 'ProductCode' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmgj00**11'],
+ 'SupplierName' => ['title' => '', 'description' => 'The service provider name.', 'type' => 'string', 'example' => '*****有限公司'],
+ 'RelationalData' => [
+ 'title' => '',
+ 'description' => 'The relational information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceStatus' => ['title' => '', 'description' => 'The service status. Valid values:'."\n"
+ .'* READYING: not started.'."\n"
+ .'* STARTED: in service.'."\n"
+ .'* CONFIRM: completed.'."\n"
+ .'* EXPIRED: expired.'."\n"
+ .'* CLOSED: released.', 'type' => 'string', 'example' => 'STARTED'],
],
+ 'example' => '',
],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-****-****-****-270359FB54A7'],
+ 'AutoRenewal' => ['title' => '', 'description' => 'The automatic payment information for epoch-based products. A non-empty value indicates that you enable auto-renewal.'."\n"
+ .'autoRenewCycle: Day, Month, or Year.'."\n"
+ .'autoRenewDuration: the renewal epoch.', 'type' => 'string', 'example' => '{"autoRenewCycle":"Year","autoRenewDuration":1}'],
+ 'ActiveAddress' => ['title' => '', 'description' => 'The activation URL.', 'type' => 'string', 'example' => 'https://*****.com'],
+ 'LicenseCode' => ['title' => '', 'description' => 'The activation code.', 'type' => 'string', 'example' => 'xxxxxx'],
+ 'ImageJson' => ['title' => '', 'description' => 'The image instance information.'."\n"
+ .'imageId: the image ID.'."\n"
+ .'instanceId: the instance ID.'."\n"
+ .'ecsInstanceId: the ECS instance ID.', 'type' => 'string', 'example' => '{"imageId":"m-*******","instanceId":********}'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'Illegal request.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'Illegal parameter %s.',
- ],
- [
- 'errorCode' => 'IllegalResult',
- 'errorMessage' => 'Illegal result.',
- ],
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
- ],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
],
],
- '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":"<DescribeProjectMessagesResponse>\\n <TotalCount>21</TotalCount>\\n <RequestId>00eb4de1-6cff-4f56-833e-7b1e070e398d</RequestId>\\n <Success>true</Success>\\n <Result>\\n <Operator>452611111****</Operator>\\n <OperatorName>***科技技术有限公司</OperatorName>\\n <GmtCreate>1589015560000</GmtCreate>\\n <OperatorRole>Provider</OperatorRole>\\n <Content>尊敬的客户您好,我们已经为您上传了方案,请您查阅,然后尽快将您的意见反馈给我们。</Content>\\n </Result>\\n</DescribeProjectMessagesResponse>","errorExample":""}]',
- 'title' => 'DescribeProjectMessages',
- ],
- 'DescribeProjectNodes' => [
- 'summary' => '查询项目流程节点list',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query instance information from the service provider side',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-17T09:25:32.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInstanceForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
+ 'schema' => ['description' => 'The commodity type. Valid values:'."\n"
+ .'- APP: application'."\n"
+ .'- SERVICE: service'."\n"
+ .'- MIRROR: image'."\n"
+ .'- DOWNLOAD: download'."\n"
+ .'- API_SERVICE: API'."\n"
+ .'- ROS: resource orchestration'."\n"
+ .'- DOCKER: container'."\n"
+ .'- IOT: IoT.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Codes',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The commodity codes. Separate multiple codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'cmgj000112,cmgj000113', 'title' => ''],
+ ],
+ [
+ 'name' => 'ExceptCodes',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The commodity codes to exclude. This parameter cannot be specified together with the Codes parameter. Separate multiple codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'cmgj000114,cmgj000115', 'title' => ''],
],
],
'responses' => [
@@ -2487,162 +1437,132 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '937fee1f-26bb-4b6e-8def-977a6bdaa1e5',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'NextNodeId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8470',
- ],
- 'ParentNodeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'GmtExpired' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1588834325000',
- ],
- 'OperatorRole' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'System',
- ],
- 'GmtStart' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1588834325000',
- ],
- 'NodeStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Finish',
- ],
- 'NodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'GmtFinished' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1588834325000',
- ],
- 'AllowRollbackNode' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'TemplateForm' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '54C22FB9-0CB1-5629-97A8-653FC7990F00', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''],
+ 'InstanceItems' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'InstanceItem' => [
+ 'description' => 'The list of instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The service status.'."\n"
+ .'- If ProductType is set to MIRROR:'."\n"
+ .' - PRODUCE: being provisioned'."\n"
+ .' - USING: in use'."\n"
+ .' - UNUSED: not in use'."\n"
+ .' - EXPIRED: expired'."\n"
+ .' - CLOSED: released'."\n"
+ ."\n"
+ .'- If ProductType is set to SERVICE:'."\n"
+ .' - READYING: not started'."\n"
+ .' - STARTED: in service'."\n"
+ .' - CONFIRM: completed'."\n"
+ .' - EXPIRED: expired'."\n"
+ .' - CLOSED: released'."\n"
+ ."\n"
+ .'- If ProductType is set to APP, DOWNLOAD, API_SERVICE, or DOCKER:'."\n"
+ .' - OPENING: being activated'."\n"
+ .' - OPENED: activated'."\n"
+ .' - EXPIRED: expired'."\n"
+ .' - CLOSED: released.', 'type' => 'string', 'example' => 'OPENED', 'title' => ''],
+ 'AppJson' => ['description' => 'The application information.'."\n"
+ ."\n"
+ .'The parameter description in the example is as follows:'."\n"
+ .'- username: the username.'."\n"
+ .'- passowrd: the password.'."\n"
+ .'- frontEndUrl: the frontend URL.'."\n"
+ .'- adminUrl: the administration URL.'."\n"
+ .'- authUrl: the SSO URL.', 'type' => 'string', 'example' => '{"frontEndUrl":"https://***.aliyun.com","password":"Sjtv***","adminUrl":"https://***.aiiyun.com","username":"aliyun***"}', 'title' => ''],
+ 'ApiJson' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''],
+ 'ProductName' => ['description' => 'The commodity name.', 'type' => 'string', 'example' => '***协同办公', 'title' => ''],
+ 'ImageJson' => ['description' => 'The image information.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1551111111', 'title' => ''],
+ 'ExtendJson' => ['description' => 'The extended information.', 'type' => 'string', 'example' => '{"说明": "如有使用问题,请联系..."}', 'title' => ''],
+ 'BeganOn' => ['description' => 'The activation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000', 'title' => ''],
+ 'ProductType' => ['description' => 'The commodity type. Valid values:'."\n"
+ .'- APP: application'."\n"
+ .'- SERVIC: service'."\n"
+ .'- MIRROR: image'."\n"
+ .'- DOWNLOAD: download'."\n"
+ .'- API_SERVICE: API'."\n"
+ .'- DOCKER: DOCKER.', 'type' => 'string', 'example' => 'APP', 'title' => ''],
+ 'HostJson' => ['description' => 'The host information.'."\n"
+ ."\n"
+ .'The parameter description in the example is as follows:'."\n"
+ .'- username: the username.'."\n"
+ .'- passowrd: the password.'."\n"
+ .'- ip: the host IP address.'."\n"
+ .'- innerIp: the internal network IP address of the host.', 'type' => 'string', 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}', 'title' => ''],
+ 'ProductSkuCode' => ['description' => 'The SKU code.', 'type' => 'string', 'example' => 'cmgj00**11-prepay', 'title' => ''],
+ 'CreatedOn' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000', 'title' => ''],
+ 'IdaasJson' => ['description' => 'The IDaaS information. This parameter is deprecated.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'EndOn' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570644021000', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '204211111111111', 'title' => ''],
+ 'ProductCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmgj00**11', 'title' => ''],
+ 'SupplierName' => ['description' => 'The service provider name.', 'type' => 'string', 'example' => '阿里巴巴技术有限公司', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'NeedAttachment' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'NodeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8471',
- ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ '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.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
],
],
- '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":"<DescribeProjectNodesResponse>\\n <Success>true</Success>\\n <RequestId>937fee1f-26bb-4b6e-8def-977a6bdaa1e5</RequestId>\\n <Result>\\n <NextNodeId>8472</NextNodeId>\\n <StepNo>2</StepNo>\\n <AutoFinishNode>false</AutoFinishNode>\\n <FinalStepNo>4</FinalStepNo>\\n <PreviousNodeId>8470</PreviousNodeId>\\n <ParentNodeId>0</ParentNodeId>\\n <GmtExpired>1588834325000</GmtExpired>\\n <OperatorRole>System</OperatorRole>\\n <GmtStart>1588834325000</GmtStart>\\n <NodeStatus>Finish</NodeStatus>\\n <NodeName>分配服务商节点</NodeName>\\n <GmtFinished>1588834325000</GmtFinished>\\n <AllowRollbackNode>false</AllowRollbackNode>\\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\\"}]</TemplateForm>\\n <NeedAttachment>false</NeedAttachment>\\n <NodeId>8471</NodeId>\\n </Result>\\n</DescribeProjectNodesResponse>","errorExample":""}]',
- 'title' => 'DescribeProjectNodes',
- 'description' => '**'."\n"
- .'**',
+ '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' => 'Query service list',
+ 'summary' => 'Queries the list of services purchased by the user.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeProjectOperateLogs' => [
- 'summary' => '查询项目操作记录列表',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-29T09:32:23.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstances'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeInvoiceForIsv' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2650,121 +1570,237 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
+ 'schema' => ['title' => '', 'description' => 'The current invoice status. Valid values:'."\n"
+ .'- 0: processing'."\n"
+ .'- 1: completed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The invoice type. If this parameter is left empty, all types are queried by default. Valid values:'."\n"
+ .'- 2: digital electronic general invoice'."\n"
+ .'- 3: digital electronic special invoice.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'InvoiceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The invoice application ID. This value corresponds to Result.Id in the response of the DescribeInvoiceForIsv operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4072040****'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of instances per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The Alibaba Cloud user ID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '174452687724****'],
+ ],
+ [
+ 'name' => 'CreateTimeEnd',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The end time. The time 23:59:59 is appended to the date by default.', 'type' => 'string', 'required' => false, 'example' => '2025-01-01 00:00:00'],
+ ],
+ [
+ 'name' => 'CreateTimeStart',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The start time. The time 00:00:00 is appended to the date by default.', 'type' => 'string', 'required' => false, 'example' => '2025-01-31 23:59:59'],
+ ],
+ [
+ 'name' => 'PageIndex',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of entries per page for a paged query. Maximum value: 50. Default value: 10. (This parameter is not enabled.).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The pagination token returned by this call. (This parameter is not enabled.).', 'type' => 'string', 'required' => false, 'example' => '3v3mzZN1QdVsTPNiT0OkD9v+MeV8LSqSQDSuTTVFCUMMWShmnj/LXRMScqm242bB', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'e6037e86-657f-4194-bb6a-7b26973aec8d',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of instances per page.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Count' => ['description' => 'The total count.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'Code' => ['description' => 'The commodity code corresponding to the product.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'The result indicator.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Result' => [
- 'description' => '',
+ 'description' => 'The process node information upon success.',
'type' => 'array',
'items' => [
+ 'description' => 'The returned results.',
'type' => 'object',
'properties' => [
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1587624497000',
- ],
- 'Operator' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
+ 'AliyunPk' => ['description' => 'The Alibaba Cloud user ID of the customer.', 'type' => 'string', 'example' => '102277855749****', 'title' => ''],
+ 'CreateTimeStr' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-01-01 00:00:00'."\n", 'title' => ''],
+ 'EvaluateList' => [
+ 'description' => 'The order, bill, or contract numbers.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The modification time.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Agent' => ['title' => '', 'description' => 'Indicates whether the invoice is issued by an agent.', 'type' => 'boolean', 'example' => 'false'],
+ 'Amount' => ['title' => '', 'description' => 'The amount, in CNY.', 'type' => 'string', 'example' => '1'],
+ 'BizTimeStr' => ['description' => 'The time when the business transaction occurred.', 'type' => 'string', 'example' => '2025-01-01 00:00:00'."\n", 'title' => ''],
+ 'Id' => ['title' => '', 'description' => 'The ID of the invoicing object.', 'type' => 'string', 'example' => '9540765'],
+ 'OrderType' => ['title' => '', 'description' => 'The order or bill type. Valid values:'."\n"
+ ."\n"
+ .'- 0: order'."\n"
+ ."\n"
+ .'- 1: bill.', 'type' => 'string', 'example' => '0'],
+ 'OutBizId' => ['title' => '', 'description' => 'The order ID.', 'type' => 'string', 'example' => '2024091610072000****'],
+ 'RealAliyunPk' => ['title' => '', 'description' => 'The account to which the order belongs.', 'type' => 'string', 'example' => '102277855749****'."\n"],
+ 'RealAliyunId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => 'example@alibaba-inc.com', 'title' => ''],
+ 'ProductCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmapi00067***', 'title' => ''],
+ 'ProductName' => ['description' => 'The product name. (Deprecated.).', 'type' => 'string', 'example' => '图像识别OCR***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'OperatorRole' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'System',
+ 'Id' => ['description' => 'The invoice application ID. This value corresponds to the InvoiceId parameter used when calling the ModifyInvoiceForIsv operation.', 'type' => 'string', 'example' => '4072040****'."\n", 'title' => ''],
+ 'InvoiceId' => ['description' => 'The ID of the invoice object.', 'type' => 'string', 'example' => '4072040****'."\n", 'title' => ''],
+ 'InvoiceList' => [
+ 'description' => 'The invoice subcollection. (Deprecated.).',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The invoice subcollection. (Deprecated.).',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the invoice object.', 'type' => 'string', 'example' => '4072040****'."\n", 'title' => ''],
+ 'InvoiceAmount' => ['description' => 'The invoiced amount, in CNY.', 'type' => 'string', 'example' => '99.99', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
+ 'MaterialType' => ['title' => '', 'description' => 'The invoice issuance type. Valid values:'."\n"
+ .'- 0: paper'."\n"
+ .'- 1: electronic.', 'type' => 'string', 'example' => '1'],
+ 'ModifiedTime' => ['description' => 'The time when the order status was modified, in GMT.', 'type' => 'string', 'example' => '2025-03-04T09:43:18+08:00', 'title' => ''],
+ 'Price' => ['title' => '', 'description' => 'The total invoice amount, in CNY.', 'type' => 'string', 'example' => '99.99'],
+ 'Status' => ['title' => '', 'description' => 'The invoice status. Valid values: 0: pending invoicing. 1: invoiced.', 'type' => 'string', 'example' => 'Success'],
+ 'Title' => ['title' => '', 'description' => 'The invoice title.', 'type' => 'string', 'example' => '阿里云计算有限公司'],
+ 'Type' => ['title' => '', 'description' => 'The invoice type. Valid values:'."\n"
+ .'- 2: digital electronic general invoice'."\n"
+ .'- 3: digital electronic special invoice.', 'type' => 'string', 'example' => '2'],
+ 'UserAddressDto' => [
+ 'description' => 'The address information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AliyunPk' => ['description' => 'The Alibaba Cloud user ID of the customer.', 'type' => 'string', 'example' => '174452687724****'."\n", 'title' => ''],
+ 'BizType' => ['description' => 'Deprecated.', 'type' => 'string', 'example' => '******', 'title' => ''],
+ 'Emails' => ['description' => 'The email address.', 'type' => 'string', 'example' => '******', 'title' => ''],
+ 'Addressee' => ['description' => 'The recipient.', 'type' => 'string', 'example' => '***', 'title' => ''],
+ 'DeliveryAddress' => ['description' => 'The delivery address.', 'type' => 'string', 'example' => '杭州市****'."\n", 'title' => ''],
+ 'Phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '130********', 'title' => ''],
+ 'PostalCode' => ['description' => 'The postal code.', 'type' => 'string', 'example' => '******', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
- 'OperatorName' => [
- 'description' => '',
- 'type' => 'string',
+ 'ModifiedTimeStr' => ['description' => 'The invoice modification time.', 'type' => 'string', 'example' => '2025-01-01 00:00:00'."\n", 'title' => ''],
+ 'ReceiptUserInfoDto' => [
+ 'description' => 'The user information of the invoice applicant.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaxNumber' => ['description' => 'The unified social credit code of the enterprise.', 'type' => 'string', 'example' => '91420100MA49L5****', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
+ 'UserNotice' => ['title' => '', 'description' => 'The user remarks on the invoice.', 'type' => 'string', 'example' => '无'],
+ 'CheckNotice' => ['title' => '', 'description' => 'The supplier remarks on the invoice.', 'type' => 'string', 'example' => '无'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => '3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+', 'title' => ''],
+ 'MaxResults' => ['description' => 'The maximum number of entries per page for a paged query. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
+ 'example' => '',
],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'Illegal request.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'Illegal parameter %s.',
- ],
- [
- 'errorCode' => 'IllegalResult',
- 'errorMessage' => 'Illegal result.',
- ],
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
+ 403 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'PageSize' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'PageNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Version' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'Count' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Fatal' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query invoice information of an Alibaba Cloud marketplace supplier store',
+ 'summary' => 'Queries the invoice information of an Alibaba Cloud Marketplace supplier store.',
+ 'description' => 'Queries business information based on an authorization code. The system first verifies whether the authorization code is valid.'."\n"
+ ."\n"
+ .'- If the authorization code is invalid, an error message is returned.'."\n"
+ ."\n"
+ .'- If the authorization code is valid, the authorization information is returned.',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-14T14:39:17.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInvoiceForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<DescribeProjectOperateLogsResponse>\\n <Success>true</Success>\\n <RequestId>e6037e86-657f-4194-bb6a-7b26973aec8d</RequestId>\\n <Result>\\n <GmtCreate>1587624497000</GmtCreate>\\n <Operator>0</Operator>\\n <OperatorRole>System</OperatorRole>\\n <Description>进入分配服务商操作人</Description>\\n <OperatorName>系统</OperatorName>\\n </Result>\\n</DescribeProjectOperateLogsResponse>","errorExample":""}]',
- 'title' => 'DescribeProjectOperateLogs',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ '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"}]',
],
- 'DescribeCurrentNodeInfo' => [
- 'summary' => '工作流当前节点信息',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeLicense' => [
+ 'summary' => 'Calls DescribeLicense to query license information.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2772,22 +1808,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'LicenseCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
+ 'schema' => ['description' => 'The activation code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxxxxx', 'title' => ''],
],
],
'responses' => [
@@ -2795,331 +1821,395 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d',
- ],
- 'Result' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''],
+ 'License' => [
+ 'description' => 'The license object.',
'type' => 'object',
'properties' => [
- 'NextNodeId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8471',
- ],
- 'ParentNodeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'GmtExpired' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1588920725000',
- ],
- 'OperatorRole' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Provider',
- ],
- 'GmtStart' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1588834325000',
- ],
- 'NodeStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Starting',
- ],
- 'NodeName' => [
+ 'ActivateTime' => ['description' => 'The activation time.', 'type' => 'string', 'example' => '2019-05-25 09:00:00', 'title' => ''],
+ 'LicenseStatus' => ['description' => 'The license status.'."\n"
+ .'- ACTIVATED'."\n"
+ .'- INACTIVATED', 'type' => 'string', 'example' => 'ACTIVATED', 'title' => ''],
+ 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => 'LNMP环境', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2019-06-25 09:00:00', 'title' => ''],
+ 'ProductSkuId' => ['description' => 'The product SKU ID.', 'type' => 'string', 'example' => 'cmgj02****-prepay', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2019-05-25 09:00:00', 'title' => ''],
+ 'LicenseCode' => ['description' => 'The activation code.', 'type' => 'string', 'example' => '-', 'title' => ''],
+ 'InstanceId' => ['description' => 'The business instance ID.', 'type' => 'string', 'example' => '1551111111', 'title' => ''],
+ 'SupplierName' => ['description' => 'The supplier name.', 'type' => 'string', 'example' => '**科技股份有限公司', 'title' => ''],
+ 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'cmgj02****', 'title' => ''],
+ 'ExtendArray' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'LicenseAttribute' => [
+ 'description' => 'The array of extended attribute objects.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The attribute code.', 'type' => 'string', 'example' => 'package_version:对应商品规格code;orderBizId:云市场实例ID;activeAddress:激活地址;orderId:包含新购和续费订单ID,逗号分割;aliUid:用户阿里云Uid;expiresTime:授权码过期时间;', 'title' => ''],
+ 'Value' => ['description' => 'The attribute value.', 'type' => 'string', 'example' => '-', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'GmtFinished' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1588920725000',
- ],
- 'AllowRollbackNode' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'TemplateForm' => [
- 'description' => '',
- 'type' => 'string',
+ 'ExtendInfo' => [
+ 'description' => 'The extended information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AliUid' => ['description' => 'The Alibaba Cloud UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190311111111****', 'title' => ''],
+ 'AccountQuantity' => ['description' => 'The account information.', 'type' => 'integer', 'format' => 'int64', 'example' => '-', 'title' => ''],
+ 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'id***@**.com', 'title' => ''],
+ 'Mobile' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '129****1111', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
- 'NeedAttachment' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'NodeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8472',
- ],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'Illegal request.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'Illegal parameter %s.',
- ],
- [
- 'errorCode' => 'IllegalResult',
- 'errorMessage' => 'Illegal result.',
- ],
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
- ],
+ ['errorCode' => 'Auth.SubAccount.Error', 'errorMessage' => 'The specified AccessKey information does not belong to the RAM user.', 'description' => 'The specified AccessKey information does not belong to the RAM user.'],
+ ['errorCode' => 'License.Invalid', 'errorMessage' => 'The specified license is invalid.', 'description' => 'The specified license is invalid.'],
+ ['errorCode' => 'License.Expired', 'errorMessage' => 'The specified license has expired.', 'description' => 'The specified license has expired.'],
+ ['errorCode' => 'License.Discard', 'errorMessage' => 'The specified license has been discarded.', 'description' => 'The specified license has been discarded.'],
+ ['errorCode' => 'License.NotFound', 'errorMessage' => 'The specified license does not exist.', 'description' => 'The specified license does not exist.'],
+ ['errorCode' => 'Auth.ISV.Error', 'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.', 'description' => '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.', 'description' => '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.', 'description' => 'The specified RAM user is not authorized.'],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Query license information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeLicense',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<DescribeCurrentNodeInfoResponse>\\n <Success>true</Success>\\n <RequestId>00eb4de1-6cff-4f56-833e-7b1e070e398d</RequestId>\\n <Result>\\n <NextNodeId>8473</NextNodeId>\\n <StepNo>3</StepNo>\\n <AutoFinishNode>false</AutoFinishNode>\\n <FinalStepNo>4</FinalStepNo>\\n <PreviousNodeId>8471</PreviousNodeId>\\n <ParentNodeId>0</ParentNodeId>\\n <GmtExpired>1588920725000</GmtExpired>\\n <OperatorRole>Provider</OperatorRole>\\n <GmtStart>1588834325000</GmtStart>\\n <NodeStatus>Starting</NodeStatus>\\n <NodeName>等待服务开通</NodeName>\\n <GmtFinished>1588920725000</GmtFinished>\\n <AllowRollbackNode>false</AllowRollbackNode>\\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\\"}]</TemplateForm>\\n <NeedAttachment>false</NeedAttachment>\\n <NodeId>8472</NodeId>\\n </Result>\\n</DescribeCurrentNodeInfoResponse>","errorExample":""}]',
- 'title' => 'DescribeCurrentNodeInfo',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
],
- 'FinishCurrentProjectNode' => [
- 'summary' => '完成当前流程节点',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeOrder' => [
+ 'summary' => 'Queries the details of a specified order.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'OrderId',
'in' => 'query',
+ 'schema' => ['description' => 'The order ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '202*********415', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductName' => ['description' => 'The name of the subscribed product.', 'type' => 'string', 'example' => 'saas服务产品', 'title' => ''],
+ 'SupplierCompanyName' => ['description' => 'The company name of the seller.', 'type' => 'string', 'example' => '**科技股份有限公司', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'The original price of the order, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '10.0', 'title' => ''],
+ 'AliUid' => ['description' => 'The unique identifier of the Alibaba Cloud user (aliyunPK).', 'type' => 'integer', 'format' => 'int64', 'example' => '190311111111****', 'title' => ''],
+ 'CouponPrice' => ['description' => 'The amount of vouchers used, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''],
+ 'AccountQuantity' => ['description' => 'The number of accounts.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'PeriodType' => ['description' => 'The time unit for prepaid orders. Valid values:'."\n"
+ ."\n"
+ .'- MONTH: one month'."\n"
+ .'- SEASON: one quarter'."\n"
+ .'- HALFYEAR: half a year'."\n"
+ .'- YEAR: one year'."\n"
+ .'- TWOYEARS: two years'."\n"
+ .'- ONCE: one-time.', 'type' => 'string', 'example' => 'MONTH', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''],
+ 'PayStatus' => ['description' => 'The payment status. Valid values:'."\n"
+ ."\n"
+ .'- PAID: Paid.'."\n"
+ .'- UNPAID: Unpaid.', 'type' => 'string', 'example' => 'PAID', 'title' => ''],
+ 'PaymentPrice' => ['description' => 'The actual payment amount, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''],
+ 'OrderStatus' => ['description' => 'The order status. Valid values:'."\n"
+ ."\n"
+ .'- NORMAL: Normal.'."\n"
+ .'- REFUND: Refunded.'."\n"
+ .'- DELETE: Voided.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
+ 'ProductSkuCode' => ['description' => 'The specification code of the subscribed product.', 'type' => 'string', 'example' => 'cmgj02****-prepay', 'title' => ''],
+ 'PaidOn' => ['description' => 'The payment time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191675000', 'title' => ''],
+ 'Components' => ['description' => 'The order component information. The metric description for the parameters in the example is as follows:'."\n"
+ ."\n"
+ .'- package_quantity: the number of usage times (a component specific to API products)'."\n"
+ .'- package_version: the version'."\n"
+ .'- ord_time: the duration'."\n"
+ .'- order_num: the quantity'."\n"
+ .'- code: the component code'."\n"
+ .'- globarKey: the component key'."\n"
+ .'- name: the component name'."\n"
+ .'- value: the component 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" } }', 'title' => ''],
+ 'CreatedOn' => ['description' => 'The time when the order was placed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191564000', 'title' => ''],
+ 'OrderType' => ['description' => 'The order type. Valid values:'."\n"
+ ."\n"
+ .'- NEW: New purchase order.'."\n"
+ .'- RENEW: Renewal order.'."\n"
+ .'- TRIAL: Trial order.', 'type' => 'string', 'example' => 'NEW', 'title' => ''],
+ 'TotalPrice' => ['description' => 'The total payable amount of the order, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''],
+ 'Quantity' => ['description' => 'The quantity of the subscribed product.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202211111111111', 'title' => ''],
+ 'ProductCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmgj02****', 'title' => ''],
+ 'SupplierTelephones' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Telephone' => [
+ 'description' => 'The customer service hotline of the seller.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The customer service hotline of the seller.', 'type' => 'string', 'example' => '{139*****950, 139*****831}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'InstanceIds' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'InstanceId' => [
+ 'description' => 'The business instances associated with the order.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the business instance associated with the order.', 'type' => 'string', 'example' => '{1597985, 1227195}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
+ ],
+ ],
+ 'title' => 'Query order details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOrder'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'NodeId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1924',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeOrderForIsv' => [
+ 'summary' => 'Queries order details from the service provider side.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TemplateForm',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'Remark',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The order ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '202*********415', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'ProductName' => ['title' => '', 'description' => 'The name of the subscribed product.', 'type' => 'string', 'example' => 'saas服务产品'],
+ 'OriginalPrice' => ['title' => '', 'description' => 'The original price of the order, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '10.0'],
+ 'AliUid' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud user (aliyunPK).', 'type' => 'integer', 'format' => 'int64', 'example' => '190311111111****'],
+ 'CouponPrice' => ['title' => '', 'description' => 'The amount of vouchers used, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '0.0'],
+ 'AccountQuantity' => ['title' => '', 'description' => 'The number of accounts.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'PeriodType' => ['title' => '', 'description' => 'The time unit for prepaid orders. Valid values:'."\n"
+ .'- MONTH: one month'."\n"
+ .'- SEASON: one quarter'."\n"
+ .'- HALFYEAR: half a year'."\n"
+ .'- YEAR: one year'."\n"
+ .'- TWOYEARS: two years'."\n"
+ .'- ONCE: one-time.', 'type' => 'string', 'example' => 'MONTH'],
+ 'PayStatus' => ['title' => '', 'description' => 'The payment status. Valid values:'."\n"
+ .'- PAID: Paid.'."\n"
+ .'- UNPAID: Unpaid.', 'type' => 'string', 'example' => 'PAID'],
+ 'PaymentPrice' => ['title' => '', 'description' => 'The actual payment amount, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '0.0'],
+ 'OrderStatus' => ['title' => '', 'description' => 'The order status. Valid values:'."\n"
+ .'- NORMAL: Normal.'."\n"
+ .'- REFUND: Refunded.'."\n"
+ .'- DELETE: Voided.', 'type' => 'string', 'example' => 'NORMAL'],
+ 'ProductSkuCode' => ['title' => '', 'description' => 'The SKU code of the subscribed product.', 'type' => 'string', 'example' => 'cmgj02****-prepay'],
+ 'PaidOn' => ['title' => '', 'description' => 'The payment time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191675000'],
+ 'CreatedOn' => ['title' => '', 'description' => 'The time when the order was placed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191564000'],
+ 'OrderType' => ['title' => '', 'description' => 'The order type. Valid values:'."\n"
+ .'- NEW: New purchase order.'."\n"
+ .'- RENEW: Renewal order.'."\n"
+ .'- TRIAL: Trial order.'."\n"
+ .'- UPGRADE: Upgrade order.'."\n"
+ .'- DOWNGRADE: Downgrade order.'."\n"
+ .'- PURCHASE: Conversion order.', 'type' => 'string', 'example' => 'NEW'],
+ 'TotalPrice' => ['title' => '', 'description' => 'The total receivable amount of the order, in CNY.', 'type' => 'number', 'format' => 'float', 'example' => '0.0'],
+ 'Quantity' => ['title' => '', 'description' => 'The quantity of the order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'OrderId' => ['title' => '', 'description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202211111111111'],
+ 'ProductCode' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmgj02****'],
+ 'InstanceIds' => [
+ 'title' => '',
+ 'description' => 'List',
+ 'type' => 'array',
+ 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '1597985', 'title' => ''],
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID. This ID is used for troubleshooting when an error occurs.', 'type' => 'string', 'example' => '6EF60BEC-****-****-****-270359FB54A7', 'title' => ''],
+ 'Components' => ['description' => 'The order module information. The metric description for the parameters in the example is as follows:'."\n"
+ .'- package_quantity: the number of usage times (a module specific to API products)'."\n"
+ .'- package_version: the version'."\n"
+ .'- ord_time: the duration'."\n"
+ .'- order_num: the quantity'."\n"
+ .'- code: the module code'."\n"
+ .'- globarKey: the module key'."\n"
+ .'- name: the module name'."\n"
+ .'- value: the module 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"}}', 'title' => ''],
],
+ 'example' => '',
],
],
],
'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' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<FinishCurrentProjectNodeResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</FinishCurrentProjectNodeResponse>","errorExample":""}]',
- 'title' => 'FinishCurrentProjectNode',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'RollbackCurrentProjectNode' => [
- 'summary' => '当前流程节点回滚到上一步',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query order details from the service provider side',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-13T01:38:22.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeOrderForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribePrice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'OrderType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
+ 'schema' => ['description' => 'Order type. Valid values:'."\n"
+ ."\n"
+ .'INSTANCE_BUY: Product purchase'."\n"
+ .'INSTANCE_RENEW: Instance renewal'."\n"
+ .'INSTANCE_UPGRADE: Instance upgrade'."\n"
+ .'Note: For renewal-type price inquiries, you must pass InstanceId in the Commodity parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_BUY', 'title' => ''],
],
[
- 'name' => 'NodeId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1925',
- ],
- ],
- [
- 'name' => 'Remark',
+ 'name' => 'Commodity',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Serialized commodity information based on the specified OrderType. The CommodityType corresponding to each OrderType is as follows:'."\n"
+ ."\n"
+ .'INSTANCE_BUY: InstanceBuyCommodity'."\n"
+ .'INSTANCE_RENEW: InstanceRenewCommodity'."\n"
+ .'INSTANCE_UPGRADE: InstanceUpgradeCommodity'."\n"
+ .'The parameters in the example are described as follows:'."\n"
+ ."\n"
+ .'productCode: The product code.'."\n"
+ .'skuCode: The product specification code. For non-image products: prepay for subscription, postpay for pay-as-you-go. For image products: ECS for pay-as-you-go, Package for subscription.'."\n"
+ .'components: Specification modules. The version package_version is required, and other modules depend on the product settings.'."\n"
+ .'duration: Number of cycles, such as 1, 2, 3...'."\n"
+ .'pricingCycle: Cycle unit. Day, Month, or Year.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"components":{"package_version":"yuncode12928000016"},"duration":1,"pricingCycle":"YEAR","productCode":"cmgj01**28","quantity":1,"skuCode":"prepay"}', 'title' => ''],
],
],
'responses' => [
@@ -3127,79 +2217,127 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
- ],
- 'Result' => [
+ 'ExpressionCode' => ['description' => 'Purchase restriction code', 'type' => 'string', 'example' => 'ORDER.NO_REAL_NAME_AUTHENTICATION', 'title' => ''],
+ 'Cuxiao' => ['description' => 'Indicates whether a promotion is available', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'Discount amount (original price minus trade price), in CNY', 'type' => 'number', 'format' => 'float', 'example' => '178.20', 'title' => ''],
+ 'Cycle' => ['description' => 'Cycle unit'."\n"
+ ."\n"
+ .'DAY: Day'."\n"
+ .'MONTH: Month'."\n"
+ .'YEAR: Year', 'type' => 'string', 'example' => 'MONTH', 'title' => ''],
+ 'TradePrice' => ['description' => 'Trade price (actual price), in CNY', 'type' => 'number', 'format' => 'float', 'example' => '19.80', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'Original price, in CNY', 'type' => 'number', 'format' => 'float', 'example' => '198.00', 'title' => ''],
+ 'Duration' => ['description' => 'Number of cycles, such as 1, 2, 3...', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Currency' => ['description' => 'Currency'."\n"
+ ."\n"
+ .'CNY: Chinese Yuan'."\n"
+ .'USD: US Dollar'."\n"
+ .'JPY: Japanese Yen', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'ExpressionMessage' => ['description' => 'Purchase restriction description', 'type' => 'string', 'example' => '企业用户才能购买', 'title' => ''],
+ 'InfoTitle' => ['description' => 'Promotion name', 'type' => 'string', 'example' => '新年特惠', 'title' => ''],
+ 'ProductCode' => ['description' => 'Product code', 'type' => 'string', 'example' => 'cmgj01****', 'title' => ''],
+ 'PromotionRules' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PromotionRule' => [
+ 'description' => 'Promotion information',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['description' => 'Promotion title', 'type' => 'string', 'example' => '展示型首年19.8元', 'title' => ''],
+ 'Name' => ['description' => 'Promotion content', 'type' => 'string', 'example' => '展示型首年19.8元', 'title' => ''],
+ 'RuleId' => ['description' => 'Promotion ID', 'type' => 'string', 'example' => '102112', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
- 'Success' => [
+ 'Coupons' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Coupon' => [
+ 'description' => 'Coupon information',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CouponOptionCode' => ['description' => 'Coupon type', 'type' => 'string', 'example' => 'ActiveCoupon', 'title' => ''],
+ 'CouponOptionNo' => ['description' => 'Coupon number', 'type' => 'string', 'example' => '3874923111', 'title' => ''],
+ 'CouponName' => ['description' => 'Coupon name', 'type' => 'string', 'example' => '促销', 'title' => ''],
+ 'CouponDesc' => ['description' => 'Coupon description', 'type' => 'string', 'example' => '促销', 'title' => ''],
+ 'IsSelected' => ['description' => 'Indicates whether the coupon is selected', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'CanPromFee' => ['description' => 'Discount amount applicable', 'type' => 'number', 'format' => 'float', 'example' => '100.00', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
+ ],
+ [
+ ['errorCode' => 'DownstreamError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
+ ],
+ [
+ ['errorCode' => 'ReturnNull', 'errorMessage' => 'No results found.', 'description' => 'No results found.'],
+ ],
+ 999999 => [
+ ['errorCode' => 'IgnoreError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RollbackCurrentProjectNodeResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</RollbackCurrentProjectNodeResponse>","errorExample":""}]',
- 'title' => 'RollbackCurrentProjectNode',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeInstance' => [
- 'summary' => '查询实例',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Query the price information of the corresponding product',
+ 'summary' => 'Calls DescribePrice to query the price information of the corresponding product.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeProduct' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3207,32 +2345,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'AliUid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '155****11',
- ],
+ 'schema' => ['description' => 'AliUid.', 'type' => 'string', 'required' => false, 'example' => '190********569', 'title' => ''],
],
[
- 'name' => 'OrderType',
+ 'name' => 'Code',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NEW',
- ],
+ 'schema' => ['description' => 'The commodity code of the product.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cmjj01**45', 'title' => ''],
+ ],
+ [
+ 'name' => 'QueryDraft',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to query the product draft. In most cases, you do not need to query the product draft. Product drafts are used to query product information before the product is officially listed for sale.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
@@ -3240,568 +2368,453 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OPENED',
- ],
- 'AppJson' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}',
- ],
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'InstanceId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '{"package_version":"yuncode000111"}',
- ],
- 'Constraints' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'ProductType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'APP',
- ],
- 'HostJson' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}',
- ],
- 'ProductSkuCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj00**11-prepay',
- ],
- 'CreatedOn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1570634018000',
- ],
- 'EndOn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1602259200000',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '204211111111111',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj00**11',
- ],
- 'SupplierName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RelationalData' => [
- 'description' => '',
+ 'FrontCategoryId' => ['description' => 'The product category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '523617212', 'title' => ''],
+ 'Status' => ['description' => 'Deprecated.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Type' => ['description' => 'The product type. Valid values:'."\n"
+ ."\n"
+ .'* APP: application'."\n"
+ .'* DOWNLOAD: download'."\n"
+ .'* MIRROR: image'."\n"
+ .'* SERVICE: service'."\n"
+ .'* API_SERVICE: API service.', 'type' => 'string', 'example' => 'MIRROR', 'title' => ''],
+ 'PicUrl' => ['description' => 'The URL of the product image.', 'type' => 'string', 'example' => 'https://oss.aliyuncs.com/photogallery/photo/1930532890589852/6245/495d5f19-03e4-4c2e-9c4e-bef9ab6af1e1.png', 'title' => ''],
+ 'Score' => ['description' => 'The product rating.', 'type' => 'number', 'format' => 'float', 'example' => '5.0', 'title' => ''],
+ 'UseCount' => ['description' => 'The usage count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'GmtModified' => ['description' => 'The time when the product was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578931200000', 'title' => ''],
+ 'SupplierPk' => ['description' => 'The UID of the service provider.', 'type' => 'integer', 'format' => 'int64', 'example' => '1526111111****', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The time when the product was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578931200000', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''],
+ 'ShortDescription' => ['description' => 'The short description of the product.', 'type' => 'string', 'example' => '该镜像为LNMP(Ubuntu16.04 64位+Nginx+MySQL5.6+PHP5.3)', 'title' => ''],
+ 'Description' => ['description' => 'The detailed description of the product. HTML is supported.', 'type' => 'string', 'example' => '<div>基于阿里云(Ubuntu16.04 64位)系统源码安装,安全、稳定、高效!</div>', 'title' => ''],
+ 'Code' => ['description' => 'The commodity code of the product.', 'type' => 'string', 'example' => 'cmjj01**45', 'title' => ''],
+ 'AuditFailMsg' => ['description' => 'The reason for the audit failure. This parameter is returned when QueryDraft is set to true.', 'type' => 'string', 'example' => '功能验收不通过', 'title' => ''],
+ 'Name' => ['description' => 'The product name.', 'type' => 'string', 'example' => 'LNMP环境(Ubuntu16.04 Nginx PHP5.3)', 'title' => ''],
+ 'AuditTime' => ['description' => 'The audit time. This parameter is returned when QueryDraft is set to true.', 'type' => 'integer', 'format' => 'int64', 'example' => '1581609600000', 'title' => ''],
+ 'AuditStatus' => ['description' => 'The audit status. This parameter is returned when QueryDraft is set to true. Valid values:'."\n"
+ .'- draft: not submitted'."\n"
+ .'- security_ing: security audit in progress'."\n"
+ .'- security_fail: security audit failed'."\n"
+ .'- function_ing: functional audit in progress'."\n"
+ .'- function_fail: functional audit failed'."\n"
+ .'- info_ing: product information audit in progress'."\n"
+ .'- info_fail: product information audit failed'."\n"
+ .'- success: succeeded.', 'type' => 'string', 'example' => 'function_fail', 'title' => ''],
+ 'ShopInfo' => [
+ 'description' => 'The shop information.',
'type' => 'object',
'properties' => [
- 'ServiceStatus' => [
+ 'Name' => ['description' => 'The shop name.', 'type' => 'string', 'example' => '**科学公司', 'title' => ''],
+ 'Emails' => ['description' => 'The email address.', 'type' => 'string', 'example' => '46**41@example.com', 'title' => ''],
+ 'Id' => ['description' => 'The shop ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'WangWangs' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'WangWang' => [
+ 'description' => 'The TradeManager information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'UserName' => ['description' => 'The TradeManager username.', 'type' => 'string', 'example' => 'ABC', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Telephones' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Telephone' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '{1386658****, 1386658****}', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'STARTED',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'Modules' => [
+ 'ProductSkus' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Module' => [
- 'description' => '',
+ 'ProductSku' => [
+ 'description' => 'The product SKU information.',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'package_config',
- ],
- 'Name' => [
+ 'Hidden' => ['description' => 'Indicates whether the SKU is hidden.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The SKU code.', 'type' => 'string', 'example' => 'cmjj01****-Package', 'title' => ''],
+ 'Constraints' => ['description' => 'The SKU module constraints in JSON format.', 'type' => 'string', 'example' => '{\\"img_id\\":{\\"img_version|img_region\\":{\\"V1.7|cn-shenzhen-st3-a01\\":[\\"m-wz9ho4hmos0lpxcldqoq\\"]}}', 'title' => ''],
+ 'Name' => ['description' => 'The SKU name.', 'type' => 'string', 'example' => '21', 'title' => ''],
+ 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'* POSTPAY: pay-as-you-go'."\n"
+ .'* PREPAY: subscription.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''],
+ 'OrderPeriods' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OrderPeriod' => [
+ 'description' => 'The available order periods.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The name of the order period.', 'type' => 'string', 'example' => '小时', 'title' => ''],
+ 'PeriodType' => ['description' => 'The time unit for subscription.', 'type' => 'string', 'example' => 'HOUR', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '101*********026',
- ],
- 'Properties' => [
+ 'Modules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Property' => [
- 'description' => '',
+ 'Module' => [
+ 'description' => 'The SKU module information.',
'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' => [
+ 'Code' => ['description' => 'The module code.', 'type' => 'string', 'example' => 'img_id', 'title' => ''],
+ 'Name' => ['description' => 'The module name.', 'type' => 'string', 'example' => '镜像ID', 'title' => ''],
+ 'Id' => ['description' => 'The module ID.', 'type' => 'string', 'example' => '248220', 'title' => ''],
+ 'Properties' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'PropertyValue' => [
- 'description' => '',
+ 'Property' => [
+ 'description' => 'The available values for the module.',
'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' => [
+ 'Key' => ['description' => 'The English name.', 'type' => 'string', 'example' => 'img_id', 'title' => ''],
+ 'ShowType' => ['description' => 'The display style type. Valid values:'."\n"
+ .'- number: number'."\n"
+ .'- string: string'."\n"
+ .'- radio: radio button.', 'type' => 'string', 'example' => 'number', 'title' => ''],
+ 'Name' => ['description' => 'The Chinese name.', 'type' => 'string', 'example' => '镜像ID', 'title' => ''],
+ 'DisplayUnit' => ['description' => 'The display unit.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'PropertyValues' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PropertyValue' => [
+ 'description' => 'The property value.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => '华北 1_V1.1', 'title' => ''],
+ 'Type' => ['description' => 'The property value type.', 'type' => 'string', 'example' => 'single_string', 'title' => ''],
+ 'Step' => ['description' => 'The step value.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Value' => ['description' => 'The property value.', 'type' => 'string', 'example' => 'm-28e213e7t', 'title' => ''],
+ 'Max' => ['description' => 'The maximum value.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => 'abc', 'title' => ''],
+ 'Min' => ['description' => 'The minimum value.', 'type' => 'string', 'example' => '11', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '12',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- '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":"<DescribeInstanceResponse>\\n <BeganOn>1570634021000</BeganOn>\\n <ProductCode>cmgj00**11</ProductCode>\\n <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>\\n <OrderId>204605827111111</OrderId>\\n <InstanceId>15581111</InstanceId>\\n <EndOn>1602259200000</EndOn>\\n <Status>OPENED</Status>\\n <AppJson>{\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}</AppJson>\\n <ProductType>APP</ProductType>\\n <CreatedOn>1570634018000</CreatedOn>\\n <RelationalData>\\n <ServiceStatus>READYING</ServiceStatus>\\n </RelationalData>\\n <ProductName>***协同办公</ProductName>\\n <ComponentJson>{\\"package_version\\":\\"yuncode000111\\"}</ComponentJson>\\n <SupplierName>阿里巴巴技术有限公司</SupplierName>\\n</DescribeInstanceResponse>","errorExample":""}]',
- 'title' => 'DescribeInstance',
- ],
- '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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'OPENED',
- ],
- 'AppJson' => [
- 'title' => '应用信息,示例中的参数说明如下:'."\n"
- ."\n"
- .'username:用户名'."\n"
- .'passowrd:密码'."\n"
- .'frontEndUrl:前台地址'."\n"
- .'adminUrl:管理地址',
- 'type' => 'string',
- ],
- 'ProductName' => [
- 'title' => '商品名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'InstanceId' => [
- 'title' => '实例ID',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '{"package_version":"yuncode000111"}',
- ],
- 'ProductType' => [
- 'title' => '商品类型,取值:'."\n"
- .'● APP:应用类'."\n"
- .'● SERVIC:服务类'."\n"
- .'● MIRROR:镜像类'."\n"
- .'● DOWNLOAD:下载类'."\n"
- .'● API_SERVICE:API类'."\n"
- .'● DOCKER:DOCKER类',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'APP',
- ],
- 'HostJson' => [
- 'title' => '主机信息,示例中的参数说明如下:'."\n"
- ."\n"
- .'username:用户名'."\n"
- .'passowrd:密码'."\n"
- .'ip:主机 IP'."\n"
- .'innerIp:主机内网 IP',
- 'type' => 'string',
- ],
- 'ProductSkuCode' => [
- 'title' => '规格Code',
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '204211111111111',
- ],
- 'ProductCode' => [
- 'title' => '商品Code',
'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj00**11',
- ],
- 'SupplierName' => [
- 'title' => '服务商名称',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'RelationalData' => [
- 'title' => '关联信息',
- 'description' => '',
+ 'ProductExtras' => [
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'ServiceStatus' => [
- 'title' => '服务状态'."\n"
- .'● READYING:未开始'."\n"
- .'● STARTED: 服务中'."\n"
- .'● CONFIRM:已完成'."\n"
- .'● EXPIRED: 已过期'."\n"
- .'● CLOSED: 已释放',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'STARTED',
+ 'ProductExtra' => [
+ 'description' => 'The additional product information:'."\n"
+ ."\n"
+ .'* product_advantage: product highlights'."\n"
+ .'* product_shot: product screenshots'."\n"
+ .'* product_guide: user guide'."\n"
+ .'* product_support: after-sales support scope'."\n"
+ .'* product_aptitude: product qualifications'."\n"
+ .'* product_direction: product description'."\n"
+ .'* product_case: customer use cases.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The extension type. Valid values:'."\n"
+ ."\n"
+ .'* HTML'."\n"
+ .'* LIST'."\n"
+ .'* JSON'."\n"
+ .'* SLIDER'."\n"
+ .'* LINK'."\n"
+ .'* IMG.', 'type' => 'string', 'example' => 'HTML', 'title' => ''],
+ 'Key' => ['description' => 'The English identifier of the extension.', 'type' => 'string', 'example' => 'product_advantage', 'title' => ''],
+ 'Label' => ['description' => 'The Chinese identifier of the extension.', 'type' => 'string', 'example' => '产品亮点', 'title' => ''],
+ 'Order' => ['description' => 'The sort order.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Values' => ['description' => 'The data values of the extension.', 'type' => 'string', 'example' => '\\"1. 基于阿里云(Ubuntu16.04 64位)系统源码安装,安全、稳定、高效!\\"', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'RequestId' => [
'description' => '',
- 'type' => 'string',
- 'example' => '6EF60BEC-****-****-****-270359FB54A7',
- 'title' => 'requestId',
- ],
- 'AutoRenewal' => [
- 'title' => '周期类商品自动付费,不为空时表示已开通自动续费'."\n"
- .'autoRenewCycle:Day(日),Month(月),Year(年)'."\n"
- .'autoRenewDuration:续费周期',
- 'type' => 'string',
- ],
- 'ActiveAddress' => [
- 'title' => '激活地址',
- 'type' => 'string',
- ],
- 'LicenseCode' => [
- 'title' => '激活码',
- 'type' => 'string',
- ],
- 'ImageJson' => [
- 'title' => '镜像实例信息'."\n"
- .'imageId:镜像id'."\n"
- .'instanceId: 实例id'."\n"
- .'ecsInstanceId: ecs id',
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
- ],
+ ['errorCode' => 'DeniedModify', 'errorMessage' => 'You are not authorized to call the specified API operation.', 'description' => 'You are not authorized to call the specified API operation.'],
],
500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
],
],
- '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":"<DescribeInstanceForIsvResponse>\\n <Status>OPENED</Status>\\n <AppJson>{\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}</AppJson>\\n <ProductName>***协同办公</ProductName>\\n <InstanceId>1551111111</InstanceId>\\n <ExtendJson>{\\"说明\\": \\"如有使用问题,请联系...\\"}</ExtendJson>\\n <IsTrial>true</IsTrial>\\n <BeganOn>1570634021000</BeganOn>\\n <ComponentJson>{\\"package_version\\":\\"yuncode000111\\"}</ComponentJson>\\n <ProductType>APP</ProductType>\\n <HostJson>{\\"password\\":\\"***\\",\\"ip\\":\\"118.31.***.41\\",\\"innerIp\\":\\"118.31.***.41\\",\\"region\\":\\"\\",\\"username\\":\\"***\\",\\"beianInfo\\":\\"\\"}</HostJson>\\n <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>\\n <CreatedOn>1570634018000</CreatedOn>\\n <EndOn>1602259200000</EndOn>\\n <OrderId>204211111111111</OrderId>\\n <ProductCode>cmgj00**11</ProductCode>\\n <SupplierName>*****有限公司</SupplierName>\\n <RelationalData>\\n <ServiceStatus>STARTED</ServiceStatus>\\n </RelationalData>\\n <RequestId>6EF60BEC-****-****-****-270359FB54A7</RequestId>\\n <AutoRenewal>{\\"autoRenewCycle\\":\\"Year\\",\\"autoRenewDuration\\":1}</AutoRenewal>\\n <ActiveAddress>https://*****.com</ActiveAddress>\\n <LicenseCode>xxxxxx</LicenseCode>\\n <ImageJson>{\\"imageId\\":\\"m-*******\\",\\"instanceId\\":********}</ImageJson>\\n</DescribeInstanceForIsvResponse>","errorExample":""}]',
- ],
- 'DescribeInstances' => [
- 'summary' => '查询实例列表',
- 'methods' => [
- 'post',
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","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\\": \\"<div>基于阿里云(Ubuntu16.04 64位)系统源码安装,安全、稳定、高效!</div>\\",\\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}","type":"json"}]',
+ 'title' => 'Query details of a specified product',
+ 'summary' => 'Queries the details of a specified product by calling DescribeProduct.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProduct'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'DescribeProducts' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ProductType',
+ 'name' => 'SearchTerm',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => '镜像', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
- 'title' => '分页参数,当前页码',
- ],
+ 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- 'title' => '分页参数,每页数量',
- ],
+ 'schema' => ['description' => 'The number of products to display per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'Codes',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cmgj000112,cmgj000113',
- ],
- ],
- [
- 'name' => 'ExceptCodes',
+ 'name' => 'Filter',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of filter conditions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The category of the search tag. Valid values:'."\n"
+ ."\n"
+ .'* sort: the sorting method'."\n"
+ .'* categoryId: the category ID'."\n"
+ .'* productType: the product type'."\n"
+ .'* aliyunUid: the Alibaba Cloud account ID of the service provider that owns the product.', 'type' => 'string', 'required' => false, 'example' => 'categoryId', 'title' => ''],
+ 'Value' => ['description' => 'The value of the search label:'."\n"
+ ."\n\n"
+ .'- sort'."\n"
+ .' - user_count-desc: number of transactions in the last 180 days'."\n"
+ .' - created_on-desc: creation time'."\n"
+ .' - price-desc: price'."\n"
+ .' - score-desc: rating'."\n"
+ ."\n"
+ .'- categoryId '."\n"
+ .' - Software Marketplace 53366009'."\n"
+ .' + Runtime Environment 53448001'."\n"
+ .' - Management & Monitoring 53690006'."\n"
+ .' - Website Building System 53616009'."\n"
+ .' - Application Development 55530001'."\n"
+ .' - Database 56024006'."\n"
+ .' - Server Software 56014009'."\n"
+ .' - Network Feature Software 56368007'."\n"
+ .' - Operating System 57742013'."\n"
+ .' - Service Marketplace 52734001'."\n"
+ .' - Data Migration 52738004'."\n"
+ .' - Environment Configuration 52746001'."\n"
+ .' - Troubleshooting 52740002'."\n"
+ .' - Security O&M 52732002'."\n"
+ .' - Custom Development 56082003'."\n"
+ .' - Training & Certification 57252001'."\n"
+ .' - Dedicated Line Access 57392001'."\n"
+ .' - Enterprise Services 56838014'."\n"
+ .' - Security Services 57004003'."\n"
+ .' - Website Building Marketplace 52738001'."\n"
+ .' - Enterprise Display 52738005'."\n"
+ .' - E-commerce 52750001'."\n"
+ .' - Mobile Website 52752001'."\n"
+ .' - Design 52732003'."\n"
+ .' - Information Portal 52744002'."\n"
+ .' - After-sales Service 52744003'."\n"
+ .' - Community Forum 55586021'."\n"
+ .' - Mobile Marketing 55514022'."\n"
+ .' - Template Website 56598032'."\n"
+ .' - Website Hosting 57342011'."\n"
+ .' - Cloud Security Marketplace 56764045'."\n"
+ .' + Host Security 56832023'."\n"
+ .' + Application Security 56846020'."\n"
+ .' + Data Security 56824015'."\n"
+ .' + Security Management 56830014'."\n"
+ .' + Network Security 56820014'."\n"
+ .' - Enterprise Applications 56832009'."\n"
+ .' - Office Management 56778013'."\n"
+ .' - Financial Management 56764034'."\n"
+ .' - HR Management 56780006'."\n"
+ .' - Sales Management 56842010'."\n"
+ .' - Advertising & Marketing 56842011'."\n"
+ .' - Foreign Trade 56790007'."\n"
+ .' - Cloud Communications 57602001'."\n"
+ .' - Supply Chain Management 57604001'."\n"
+ .' - Data Services 57606001'."\n"
+ .' - Solutions 56848023'."\n"
+ .' - E-commerce 56848024'."\n"
+ .' - Finance 56820017'."\n"
+ .' - Logistics 56776025'."\n"
+ .' - Government 56842031'."\n"
+ .' - Multimedia 56784018'."\n"
+ .' - IoT 56794026'."\n"
+ .' - Big Data 56792022'."\n"
+ .' - API Marketplace 56956004'."\n"
+ .' - E-commerce 56928004'."\n"
+ .' - Finance & Investment 57000002'."\n"
+ .' - Transportation & Geography 57002002'."\n"
+ .' - Enterprise Management 56928005'."\n"
+ .' - Public Affairs 57002003'."\n"
+ .' - Meteorology & Water Resources 57096001'."\n"
+ .' - Artificial Intelligence 57124001'."\n"
+ .' - Lifestyle Services 57126001'."\n"
+ .' - IoT Marketplace 201194001'."\n"
+ .' - Integrated Systems 201196001'."\n"
+ .' - Smart Hardware 201198001'."\n"
+ .' - Modules 201200001'."\n"
+ .' - Sensors 201192002'."\n"
+ .' - Chips 201202001'."\n"
+ .' - IoT Applications 201196002'."\n"
+ .' - IoT Services 201196003'."\n"
+ .' - Data Intelligence 201204005'."\n"
+ .' - Data Analytics & Visualization 201190008'."\n"
+ .' - Public Opinion Analysis 201198004'."\n"
+ .' - E-commerce & Marketing 201202006'."\n"
+ .' - Artificial Intelligence 201204006'."\n"
+ .' - Meteorology & Transportation 201214006'."\n"
+ .' - Finance & Accounting 201208013'."\n"
+ .'- productType:'."\n"
+ .' - APP: application'."\n"
+ .' - SERVICE: service'."\n"
+ .' - MIRROR: image'."\n"
+ .' - DOWNLOAD: download'."\n"
+ .' - API_SERVICE: API.', 'type' => 'string', 'required' => false, 'example' => '53366009', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'cmgj000114,cmgj000115',
+ 'maxItems' => 5,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -3810,284 +2823,296 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- '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' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of products displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of products that match the search conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '75', 'title' => ''],
+ 'ProductItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'InstanceItem' => [
- 'description' => '',
+ 'ProductItem' => [
+ 'description' => 'The product information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OPENED',
- ],
- 'AppJson' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1551111111',
- ],
- 'ExtendJson' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'BeganOn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1570634021000',
- ],
- 'ProductType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'APP',
- ],
- 'HostJson' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}',
- ],
- 'ProductSkuCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj00**11-prepay',
- ],
- 'CreatedOn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1570634021000',
- ],
- 'IdaasJson' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'EndOn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1570644021000',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '204211111111111',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj00**11',
- ],
- 'SupplierName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'PriceInfo' => ['description' => 'The price information.', 'type' => 'string', 'example' => '{\'DiscountPrice\': 0.0, \'TradePrice\': 15750.0, \'Currency\': \'CNY\', \'OriginalPrice\': 15750.0, \'RuleIds\': {\'RuleId\': []}, \'Coupons\': {\'Coupon\': []}}', 'title' => ''],
+ 'DeliveryWay' => ['description' => 'The delivery method.', 'type' => 'string', 'example' => '镜像', 'title' => ''],
+ 'ImageUrl' => ['description' => 'The image URL.', 'type' => 'string', 'example' => 'https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png', 'title' => ''],
+ 'WarrantyDate' => ['description' => 'The warranty period.', 'type' => 'string', 'example' => '1天', 'title' => ''],
+ 'Tags' => ['description' => 'The product tags.', 'type' => 'string', 'example' => '企业,上云,Windows,Windows server 2012,Apache,Nginx,Windows面板', 'title' => ''],
+ 'Score' => ['description' => 'The rating.', 'type' => 'string', 'example' => '5.0', 'title' => ''],
+ 'SupplierId' => ['description' => 'The supplier ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '228399', 'title' => ''],
+ 'OperationSystem' => ['description' => 'The delivery time.', 'type' => 'string', 'example' => 'windows', 'title' => ''],
+ 'ShortDescription' => ['description' => 'The short description of the product.', 'type' => 'string', 'example' => '【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务,应用标准化全自动服务流程体系,帮助企业轻松拥有官方网站。该建站产品与<em>ECS</em>下单时同时购买,<em>ECS</em>最低配置1核1G即可。购买须知:请在购买<em>ECS</em>配置安全组时选择HTTP:80端口 ...', 'title' => ''],
+ 'DeliveryDate' => ['description' => 'The delivery time.', 'type' => 'string', 'example' => '1天', 'title' => ''],
+ 'TargetUrl' => ['description' => 'The URL of the product page.', 'type' => 'string', 'example' => '/products/53616009/cmjj02****.html', 'title' => ''],
+ 'Code' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'cmjj02****', 'title' => ''],
+ 'CategoryId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '53398003', 'title' => ''],
+ 'Name' => ['description' => 'The product name.', 'type' => 'string', 'example' => 'PHP多版本环境(Windows2012 | phpStudy)', 'title' => ''],
+ 'SuggestedPrice' => ['description' => 'The suggested price.', 'type' => 'string', 'example' => '10元/月', 'title' => ''],
+ 'SupplierName' => ['description' => 'The supplier name.', 'type' => 'string', 'example' => '长沙****有限公司', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
+ ['errorCode' => 'Invalid.CategoryId', 'errorMessage' => 'The specified CategoryId is invalid.', 'description' => 'The specified CategoryId is invalid.'],
+ ['errorCode' => 'Invalid.Sort', 'errorMessage' => 'The specified Sort is invalid.', 'description' => 'The specified Sort is invalid.'],
+ ['errorCode' => 'Invalid.Param', 'errorMessage' => 'The specified Filter key is invalid.', 'description' => 'The specified Filter key is invalid.'],
],
],
- '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"}]',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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\\": \\"【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务,应用标准化全自动服务流程体系,帮助企业轻松拥有官方网站。该建站产品与<em>ECS</em>下单时同时购买,<em>ECS</em>最低配置1核1G即可。购买须知:请在购买<em>ECS</em>配置安全组时选择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}","type":"json"}]',
+ 'title' => 'DescribeProducts',
+ 'summary' => 'Retrieves a list of products that meet the specified conditions along with their details.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'AutoRenewInstance' => [
- 'summary' => '设置自动续费',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'DescribeProjectAttachments' => [
+ 'summary' => 'Calls DescribeProjectAttachments to retrieve the list of project attachments.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Type',
- 'in' => 'formData',
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace business.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '开通open,关闭close,必传',
- 'type' => 'string',
- 'required' => true,
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['description' => 'The success status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'e03a9f78-7b40-4fb3-a015-350913e37e3f', 'title' => ''],
+ 'Result' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FileLinkGmtExpired' => ['description' => 'The expiration time of the file URL (UNIX timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1589334682404', 'title' => ''],
+ 'StepNo' => ['description' => 'The sequence number of the process node.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'AttachmentToken' => ['description' => 'The MD5 hash of the attachment.', 'type' => 'string', 'example' => 'Mzc4NDAtODQ3MjY4MzI=', 'title' => ''],
+ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'f8-test-perview.jpeg', 'title' => ''],
+ 'OperatorRole' => ['description' => 'The role of the operator.', 'type' => 'string', 'example' => 'Provider', 'title' => ''],
+ 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'example' => '等待服务开通', 'title' => ''],
+ 'OperatorName' => ['description' => 'The name of the operator.', 'type' => 'string', 'example' => '**科技技术有限公司', 'title' => ''],
+ 'FileLink' => ['description' => 'The file access URL.', 'type' => 'string', 'example' => 'http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r*********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The time when the attachment was uploaded (UNIX timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1587968858000', 'title' => ''],
+ 'FileSuffix' => ['description' => 'The file name extension.', 'type' => 'string', 'example' => 'jpg', 'title' => ''],
+ 'Operator' => ['description' => 'The Alibaba Cloud UID of the operator.', 'type' => 'integer', 'format' => 'int64', 'example' => '45261111****', 'title' => ''],
+ 'Content' => ['description' => 'The content text.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'NodeId' => ['description' => 'The ID of the process node where the attachment was uploaded.', 'type' => 'integer', 'format' => 'int64', 'example' => '8472', 'title' => ''],
+ 'AttachmentType' => ['description' => 'The attachment type.', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'FileSize' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '109124', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Retrieve project attachments',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'OrderBizId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '云市场实例id,必传',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectAttachments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeProjectInfo' => [
+ 'summary' => 'Calls DescribeProjectInfo to query project information.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'AutoRenewCycle',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '周期单位,开通时必传。Day(日),Month(月),Year(年)',
- 'type' => 'string',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'AutoRenewDuration',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '续费周期,开通时必传',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The business instance ID in Cloud Marketplace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ResponseDTO<Boolean>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'Data' => [
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'type' => 'string',
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ee3e1b3b-6c38-4bcf-be40-5a946cfda761', 'title' => ''],
+ 'Result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductName' => ['description' => 'The name of the Cloud Marketplace product.', 'type' => 'string', 'example' => '公司宝****记账', 'title' => ''],
+ 'ProjectStatus' => ['description' => 'The execution status of the project. Valid values:'."\n"
+ ."\n"
+ .'- Starting: In progress.'."\n"
+ .'- Cancel: Canceled.'."\n"
+ .'- Pause: Paused.'."\n"
+ .'- Finish: Completed.', 'type' => 'string', 'example' => 'Starting', 'title' => ''],
+ 'CustomerAliUid' => ['description' => 'The Alibaba Cloud UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '27291111****', 'title' => ''],
+ 'TemplateType' => ['description' => 'The template type of the project. Valid values:'."\n"
+ ."\n"
+ .'- Public: Public template.'."\n"
+ .'- Private: Private template.', 'type' => 'string', 'example' => 'Public', 'title' => ''],
+ 'InstanceId' => ['description' => 'The business instance ID in Cloud Marketplace.', 'type' => 'string', 'example' => '4****89', 'title' => ''],
+ 'ProductSkuName' => ['description' => 'The name of the Cloud Marketplace product SKU.', 'type' => 'string', 'example' => '小***纳税人', 'title' => ''],
+ 'FinalStepNo' => ['description' => 'The sequence number of the last step.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'CurrentStepNo' => ['description' => 'The current step in the process.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'GmtExpired' => ['description' => 'The expiration time of the project. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620403200000', 'title' => ''],
+ 'GmtFinished' => ['description' => 'The completion time of the project. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620403200000', 'title' => ''],
+ 'ProductSkuCode' => ['description' => 'The code of the Cloud Marketplace product SKU.', 'type' => 'string', 'example' => 'yuncode****500001', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time of the project. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834324000', 'title' => ''],
+ 'SupplierAliUid' => ['description' => 'The UID of the supplier to which the project belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '45121111****', 'title' => ''],
+ 'FinishType' => ['description' => 'The completion method of the project. Valid values:'."\n"
+ ."\n"
+ .'- null: The default value for unfinished projects.'."\n"
+ .'- CustomerConfirm: Manually confirmed by the customer.'."\n"
+ .'- SystemAutoConfirm: Automatically confirmed by the system due to timeout.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'TemplateId' => ['description' => 'The ID of the process template to which the project belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '410', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2059111111111', 'title' => ''],
+ 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'cmgj***055', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => null,
- ],
- 'PauseProject' => [
- 'summary' => '暂停项目',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Query Project Information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeProjectMessages' => [
+ 'summary' => 'Calls DescribeProjectMessages to retrieve the list of project workflow messages.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
- ],
- [
- 'name' => 'NodeId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1922',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace business instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The page number of the query. Each page contains 20 entries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
@@ -4095,79 +3120,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of messages.', 'type' => 'integer', 'format' => 'int64', 'example' => '28', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Result' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'GmtCreate' => ['description' => 'The time when the message was created, in UNIX timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589015560000', 'title' => ''],
+ 'Operator' => ['description' => 'The Alibaba Cloud UID of the user who left the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '452611111****', 'title' => ''],
+ 'OperatorRole' => ['description' => 'The role of the operator. Valid values:'."\n"
+ ."\n"
+ .'- System: system.'."\n"
+ .'- Custom: customer.'."\n"
+ .'- Provider: service provider.', 'type' => 'string', 'example' => 'Provider', 'title' => ''],
+ 'Content' => ['description' => 'The content of the message.', 'type' => 'string', 'example' => '尊敬的客户您好,我们已经为您上传了方案,请您查阅,然后尽快将您的意见反馈给我们。', 'title' => ''],
+ 'OperatorName' => ['description' => 'The name of the user who left the message.', 'type' => 'string', 'example' => '***科技技术有限公司', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PauseProjectResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</PauseProjectResponse>","errorExample":""}]',
- 'title' => 'PauseProject',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeProjectAttachments' => [
- 'summary' => '附件信息',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Retrieve project workflow message list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectMessages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeProjectNodes' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4175,22 +3194,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace order.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
],
'responses' => [
@@ -4198,148 +3207,91 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'e03a9f78-7b40-4fb3-a015-350913e37e3f',
- ],
+ 'Success' => ['description' => 'The success status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '937fee1f-26bb-4b6e-8def-977a6bdaa1e5', 'title' => ''],
'Result' => [
+ 'description' => 'None.',
'type' => 'array',
'items' => [
+ 'description' => 'The node execution result.',
'type' => 'object',
'properties' => [
- 'FileLinkGmtExpired' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1589334682404',
- ],
- 'StepNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'AttachmentToken' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1587968858000',
- ],
- 'FileSuffix' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'jpg',
- ],
- 'Operator' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '45261111****',
- ],
- 'Content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'NodeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8472',
- ],
- 'AttachmentType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'File',
- ],
- 'FileSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '109124',
- ],
+ 'NextNodeId' => ['description' => 'The ID of the next flow node.', 'type' => 'integer', 'format' => 'int64', 'example' => '8472', 'title' => ''],
+ 'StepNo' => ['description' => 'The sequence number of the flow node.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'AutoFinishNode' => ['description' => 'Indicates whether the node automatically completes upon timeout.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'FinalStepNo' => ['description' => 'The sequence number of the final flow node.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'PreviousNodeId' => ['description' => 'The ID of the previous flow node.', 'type' => 'integer', 'format' => 'int64', 'example' => '8470', 'title' => ''],
+ 'ParentNodeId' => ['description' => 'The ID of the parent flow node.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'GmtExpired' => ['description' => 'The timeout time of the flow node (UNIX timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000', 'title' => ''],
+ 'OperatorRole' => ['description' => 'The role of the operator. Valid values:'."\n"
+ ."\n"
+ .'- System: system.'."\n"
+ .'- Custom: customer.'."\n"
+ .'- Provider: service provider.', 'type' => 'string', 'example' => 'System', 'title' => ''],
+ 'GmtStart' => ['description' => 'The start time of the flow node (UNIX timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000', 'title' => ''],
+ 'NodeStatus' => ['description' => 'The execution status of the node. Valid values:'."\n"
+ .'- NotStart: not started.'."\n"
+ .'- Starting: in progress.'."\n"
+ .'- Cancel: canceled.'."\n"
+ .'- Finish: completed.', 'type' => 'string', 'example' => 'Finish', 'title' => ''],
+ 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'example' => '分配服务商节点', 'title' => ''],
+ 'GmtFinished' => ['description' => 'The completion time of the flow node (UNIX timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000', 'title' => ''],
+ 'AllowRollbackNode' => ['description' => 'Indicates whether rollback to the previous flow node is allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'TemplateForm' => ['description' => 'The form content of the flow node.', '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"}]', 'title' => ''],
+ 'NeedAttachment' => ['description' => 'Indicates whether uploading an attachment is mandatory.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'NodeId' => ['description' => 'The flow node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8471', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'Illegal request.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'Illegal parameter %s.',
- ],
- [
- 'errorCode' => 'IllegalResult',
- 'errorMessage' => 'Illegal result.',
- ],
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- '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":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DescribeProjectAttachmentsResponse>\\n <requestId>e03a9f78-7b40-4fb3-a015-350913e37e3f</requestId>\\n <result>\\n <attachmentToken>Mzc4NDAtODQ3MjY4MzI=</attachmentToken>\\n <attachmentType>File</attachmentType>\\n <content />\\n <fileLink>http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D</fileLink>\\n <fileLinkGmtExpired>1589334682404</fileLinkGmtExpired>\\n <fileName>f8-test-perview.jpeg</fileName>\\n <fileSize>109124</fileSize>\\n <fileSuffix>jpg</fileSuffix>\\n <gmtCreate>1587968858000</gmtCreate>\\n <nodeId>8472</nodeId>\\n <nodeName>等待服务开通</nodeName>\\n <operator>45261111****</operator>\\n <operatorName>**科技技术有限公司</operatorName>\\n <operatorRole>Provider</operatorRole>\\n <stepNo>3</stepNo>\\n </result>\\n <success>true</success>\\n</DescribeProjectAttachmentsResponse>","errorExample":""}]',
- 'title' => 'DescribeProjectAttachments',
- ],
- 'DescribeProjectInfo' => [
- 'summary' => '项目信息',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Retrieve project flow node list',
+ 'summary' => 'Queries the list of project flow nodes by calling DescribeProjectNodes.',
+ 'description' => '**'."\n"
+ .'**.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectNodes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'DescribeProjectOperateLogs' => [
+ 'summary' => 'Calls DescribeProjectOperateLogs to retrieve the operation logs of a project flow.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4347,22 +3299,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace order.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
],
'responses' => [
@@ -4370,158 +3312,74 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ee3e1b3b-6c38-4bcf-be40-5a946cfda761',
- ],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'e6037e86-657f-4194-bb6a-7b26973aec8d', 'title' => ''],
'Result' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ProjectStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Starting',
- ],
- 'CustomerAliUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '27291111****',
- ],
- 'TemplateType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Public',
- ],
- 'InstanceId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1620403200000',
- ],
- 'GmtFinished' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1620403200000',
- ],
- 'ProductSkuCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yuncode****500001',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1588834324000',
- ],
- 'SupplierAliUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '45121111****',
- ],
- 'FinishType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'TemplateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '410',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2059111111111',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj***055',
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'GmtCreate' => ['description' => 'The operation time (UNIX timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1587624497000', 'title' => ''],
+ 'Operator' => ['description' => 'The Alibaba Cloud UID of the operator.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'OperatorRole' => ['description' => 'The role of the operator. Valid values:'."\n"
+ .'- System: system.'."\n"
+ .'- Custom: customer.'."\n"
+ .'- Provider: service provider.', 'type' => 'string', 'example' => 'System', 'title' => ''],
+ 'Description' => ['description' => 'The description of the operation.', 'type' => 'string', 'example' => '进入分配服务商操作人', 'title' => ''],
+ 'OperatorName' => ['description' => 'The name of the operator.', 'type' => 'string', 'example' => '系统', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'Illegal request.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'Illegal parameter %s.',
- ],
- [
- 'errorCode' => 'IllegalResult',
- 'errorMessage' => 'Illegal result.',
- ],
- [
- 'errorCode' => 'IllegalPermission',
- 'errorMessage' => 'Permission Denied.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- '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":"<DescribeProjectInfoResponse>\\n <requestId>ee3e1b3b-6c38-4bcf-be40-5a946cfda761</requestId>\\n <result>\\n <currentStepNo>3</currentStepNo>\\n <customerAliUid>27291111****</customerAliUid>\\n <finalStepNo>4</finalStepNo>\\n <finishType/>\\n <gmtCreate>1588834324000</gmtCreate>\\n <gmtExpired>1620403200000</gmtExpired>\\n <gmtFinished/>\\n <instanceId>4****89</instanceId>\\n <orderId>2059111111111</orderId>\\n <productCode>cmgj***055</productCode>\\n <productName>公司宝****记账</productName>\\n <productSkuCode>yuncode****500001</productSkuCode>\\n <productSkuName>小***纳税人</productSkuName>\\n <projectStatus>Starting</projectStatus>\\n <supplierAliUid>45121111****</supplierAliUid>\\n <templateId>410</templateId>\\n <templateType>Public</templateType>\\n </result>\\n <success>true</success>\\n</DescribeProjectInfoResponse>","errorExample":""}]',
- 'title' => 'DescribeProjectInfo',
- ],
- 'ResumeProject' => [
- 'summary' => '恢复已暂停的项目',
- 'methods' => [
- 'post',
+ 'title' => 'Retrieve project flow operation logs',
+ 'description' => '**'."\n"
+ .'**.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectOperateLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'FinishCurrentProjectNode' => [
+ 'summary' => 'Completes the current process by calling FinishCurrentProjectNode.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4529,44 +3387,27 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4****89',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace order.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
[
'name' => 'NodeId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1922',
- ],
+ 'schema' => ['description' => 'The ID of the process node.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1924', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateForm',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The form content to submit, in JSON format. Example: {"TFD0":"mr.go","TFD1":"1330010xxxx","TFD2":"Chaoyang District, Wangjing Street, Block x, No. y"}.', 'type' => 'string', 'required' => false, 'example' => '{"TFD0": "Mr.Go","TFD1": "1330010xxxx","TFD2": "北京市朝阳区望京街道X区Y号" }', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => '收货地址已提交,请尽快安排发货。', 'title' => ''],
],
],
'responses' => [
@@ -4574,280 +3415,145 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', 'title' => ''],
+ 'Result' => ['description' => 'The response result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''],
+ ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ResumeProjectResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</ResumeProjectResponse>","errorExample":""}]',
- 'title' => 'ResumeProject',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeLicense' => [
- 'summary' => '获取License',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Complete current process',
+ 'description' => '**'."\n"
+ .'**.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:FinishCurrentProjectNode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ModifyInvoiceForIsv' => [
+ 'summary' => 'Processes invoice acceptance requests.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'LicenseCode',
+ 'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxxxxx',
- ],
+ 'schema' => ['title' => '', 'description' => 'The type of the current invoice. Valid values:'."\n"
+ .'- 2: digital electronic general invoice.'."\n"
+ .'- 3: digital electronic special invoice.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'ElectronUrl',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The electronic invoicing URL, used for customers to download the invoice.', 'type' => 'string', 'required' => false, 'example' => 'https://oss.aliyuncs.com/xxxx.png'],
+ ],
+ [
+ 'name' => 'InvoiceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The invoice application ID. This corresponds to the Result.Id field in the response of the DescribeInvoiceForIsv operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4072040****'],
+ ],
+ [
+ 'name' => 'OperateType',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The operation to perform on the current invoice. Valid values:'."\n"
+ .'- 0: issue the invoice.'."\n"
+ .'- 1: reject the invoice.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'],
+ ],
+ [
+ 'name' => 'CheckNotice',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The remarks on the invoice from the service provider.', 'type' => 'string', 'required' => false, 'example' => '******'],
+ ],
+ [
+ 'name' => 'Number',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The invoice number.', 'type' => 'string', 'required' => false, 'example' => '1897702****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'ACTIVATED',
- ],
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ExpiredTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-06-25 09:00:00',
- ],
- 'ProductSkuId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj02****-prepay',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-05-25 09:00:00',
- ],
- 'LicenseCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1551111111',
- ],
- 'SupplierName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmgj02****',
- ],
- 'ExtendArray' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'LicenseAttribute' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ExtendInfo' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AliUid' => [
- 'description' => '',
- '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',
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => 'cmjj01**45', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"成功"', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Result' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Accept invoices for Alibaba Cloud marketplace stores',
+ 'description' => 'Queries information about failed subscription notifications for merchants.'."\n"
+ ."\n"
+ .'- If no unconfirmed notification failure information exists, TotalCount returns 0.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ModifyInvoiceForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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":"<DescribeLicenseResponse>\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n <License>\\n <ActivateTime>2019-05-25 09:00:00</ActivateTime>\\n <LicenseStatus>ACTIVATED</LicenseStatus>\\n <ProductName>LNMP环境</ProductName>\\n <ExpiredTime>2019-06-25 09:00:00</ExpiredTime>\\n <ProductSkuId>cmgj02****-prepay</ProductSkuId>\\n <CreateTime>2019-05-25 09:00:00</CreateTime>\\n <LicenseCode>-</LicenseCode>\\n <InstanceId>1551111111</InstanceId>\\n <SupplierName>**科技股份有限公司</SupplierName>\\n <ProductCode>cmgj02****</ProductCode>\\n <ExtendArray>\\n <Code>-</Code>\\n <Value>-</Value>\\n </ExtendArray>\\n <ExtendInfo>\\n <Email>id***@**.com</Email>\\n <Mobile>129****1111</Mobile>\\n </ExtendInfo>\\n </License>\\n</DescribeLicenseResponse>","errorExample":""}]',
- 'title' => 'DescribeLicense',
+ '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"}]',
],
- 'ActivateLicense' => [
- 'summary' => '增加STS支持',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'PauseProject' => [
+ 'summary' => 'Calls PauseProject to pause a project.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4855,32 +3561,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'LicenseCode',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'APSEDH8TA5CSGK-********_6CNTACBH9EQPOATFXJQL4B2COE7M43VVQ7GUGKAA',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace order.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
[
- 'name' => 'Identification',
+ 'name' => 'NodeId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '129****1111',
- ],
+ 'schema' => ['description' => 'The ID of the current operation flow node.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1922', 'title' => ''],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The reason for the remark.', 'type' => 'string', 'required' => false, 'example' => '等待与仓库确认库存,目前库存显示异常。', 'title' => ''],
],
],
'responses' => [
@@ -4888,75 +3584,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', 'title' => ''],
+ 'Result' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Success' => ['description' => 'The success status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''],
+ ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''],
+ ['errorCode' => 'IllegalProjectStatus', 'errorMessage' => 'Illegal project status.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => 'Pause a project',
+ 'description' => '**'."\n"
+ .'**.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<ActivateLicenseResponse>\\n<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n<Success>true</Success>\\n</ActivateLicenseResponse>","errorExample":""}]',
- 'title' => 'ActivateLicense',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:PauseProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'PushMeteringData' => [
- 'summary' => '云市场计量推送接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Call PushMeteringData to push metering data.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4964,21 +3641,56 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Metering',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]',
- ],
+ 'schema' => ['description' => 'The parameters in the example are described as follows:'."\n"
+ ."\n"
+ .'- InstanceId: The cloud marketplace instance ID. The parameter type is String.'."\n"
+ .'- StartTime: The metering start time. Unit: seconds (in Unix timestamp format, e.g., 1723771200). The parameter type is Long.'."\n"
+ .'- EndTime: The metering end time. Unit: seconds (in Unix timestamp format, e.g., 1723771800). The parameter type is Long.'."\n"
+ .'- Entities: The metering entity objects. The parameter type is List<Map>.'."\n"
+ .' - Key: The name of the metering item attribute. The parameter type is String.'."\n"
+ .' - Frequency: The number of uses (count).'."\n"
+ .' - Period: The usage duration in hours (seconds).'."\n"
+ .' Note: The duration unit in the request parameter is seconds, while the billing unit is hours. Therefore, the value is converted to hours during billing. For example, if you push usage of 1800 for the period 19:00-20:00 and the billing price is 1 CNY/hour, the hourly bill for that period is 1800 / 3600 x 1 = 0.5 CNY. If the amount is a decimal, it is rounded to two decimal places with any digits beyond two truncated.'."\n"
+ ."\n"
+ .' - Storage: The storage space used (Byte).'."\n"
+ ."\n"
+ .' Note: The unit in the request parameter is Byte, while the billing unit is MB. Therefore, the value is converted to MB during billing. For example, if you push usage of 524288 for the period 19:00-20:00 and the billing price is 1 CNY/MB, the hourly bill for that period is 524288 / 1024 / 1024 x 1 = 0.5 CNY. If the amount is a decimal, it is rounded to two decimal places with any digits beyond two truncated.'."\n"
+ ."\n"
+ .' - NetworkOut: The outbound traffic used (Bit).'."\n"
+ ."\n"
+ .' Note: The unit in the request parameter is Bit, while the billing unit is Mb. Therefore, the value is converted to Mb during billing. For example, if you push usage of 524288 for the period 19:00-20:00 and the billing price is 1 CNY/Mb, the hourly bill for that period is 524288 / 1024 / 1024 x 1 = 0.5 CNY. If the amount is a decimal, it is rounded to two decimal places with any digits beyond two truncated.'."\n"
+ ."\n"
+ .' - NetworkIn: The inbound traffic used (Bit).'."\n"
+ ."\n"
+ .' Note: The unit in the request parameter is Bit, while the billing unit is Mb. Therefore, the value is converted to Mb during billing. For example, if you push usage of 524288 for the period 19:00-20:00 and the billing price is 1 CNY/Mb, the hourly bill for that period is 524288 / 1024 / 1024 x 1 = 0.5 CNY. If the amount is a decimal, it is rounded to two decimal places with any digits beyond two truncated.'."\n"
+ ."\n"
+ .' - Character: The number of characters (count).'."\n"
+ .' - DailyActiveUser: The number of daily active users (DAU).'."\n"
+ .' - PeriodMin: The usage duration in minutes (minutes).'."\n"
+ .' - VirtualCpu: The number of virtual CPU cores.'."\n"
+ .' - Unit: Unit (count).'."\n"
+ .' - Memory: Memory (GB).'."\n"
+ .' - KTokens: The number of tokens used (token).'."\n"
+ .' Note: The unit of KTokens in the request parameter is token. You do not need to convert the value to thousands of tokens. The billing unit is thousands of tokens. Therefore, the token value in the pushed metering parameter is converted to thousands of tokens during billing. For example, if you push usage of 1500 tokens for the period 19:00-20:00, example: {"Key":"KTokens","Value":"1500","meteringAssit":"cmapi00071246-KTokens-1"}, and the billing price is 1 CNY/thousand tokens, the hourly bill for that period is 1500 / 1000 x 1 = 1.5 CNY. If the amount is a decimal, it is rounded to two decimal places with any digits beyond two truncated.'."\n"
+ .' - Suit: Suit (set). Note that the value passed in the parameter is in sets.'."\n"
+ .' - StorageGigaByte: StorageGigaByte (storage space in GB). Note that the unit of the value passed in the parameter is directly GB, without needing to convert to Byte or other units.'."\n"
+ .' - Value: The metering value (value >= 0). The parameter type is Integer.'."\n"
+ .' - meteringAssit: The multi-dimensional metering item ID. The parameter type is String. This billing item ID can be found in the product publishing backend. Billing items such as Frequency may have one or more of these values. When pushing metering data for newly published products, this parameter must be included.'."\n"
+ .' - SerialNo: Specific to large model invocation scenarios. When using HTTP calls, set this to the requestId. When using WebSocket, set this to the uid of the single task. This parameter is only required when the product is billed by the minute. It is not required in other cases.'."\n"
+ ."\n"
+ .'**Note**:'."\n"
+ .'- Multi-dimensional metering capability: For the billing items mentioned above such as Frequency (count), Period (usage duration), PeriodMin, etc., multiple items can be supported when publishing a product. For example, a product can have multiple PeriodMin billing items, and each PeriodMin billing item generates a unique ID to identify the billing item. This billing item is generated when the product is published, and the format is like (cmapi00060317-PeriodMin-3, cmapi00060317-PeriodMin-4). When pushing metering data, the above ID must be included to enable the corresponding billing deduction. The metering data format for newly published products is as follows:'."\n"
+ .'[{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}].'."\n"
+ .'- The pushed metering parameters should follow the example. All parameters in the example are required. Missing data will cause the metering push to fail.', 'type' => 'string', 'required' => false, 'example' => '按小时/按天推量时:'."\n"
+ .'[{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]'."\n"
+ ."\n\n"
+ .'大模型场景实时推量时:'."\n"
+ .'[{"InstanceId":"1000001","SerialNo":"210f470417561055092582279ea052","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]', 'title' => ''],
],
],
'responses' => [
@@ -4986,361 +3698,180 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7',
- ],
+ 'Success' => ['description' => 'The success status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Invalid.Parameter.Metering',
- 'errorMessage' => 'meteringAssit is empty',
- ],
- [
- 'errorCode' => 'Invalid.Parameter',
- 'errorMessage' => 'The specified parameter is invalid.',
- ],
+ ['errorCode' => 'Invalid.Parameter.Metering', 'errorMessage' => 'meteringAssit is empty', 'description' => ''],
+ ['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'],
],
500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- [
- 'errorCode' => 'Service.Flow.Control',
- 'errorMessage' => 'The rate throttling threshold has been exceeded.',
- ],
- [
- 'errorCode' => 'Invalid.Parameter.Instance',
- 'errorMessage' => 'The specified Instance parameter is invalid.',
- ],
- [
- 'errorCode' => 'Invalid.Parameter.Metering',
- 'errorMessage' => 'The specified Metering parameter is invalid.',
- ],
- [
- 'errorCode' => 'Metering.Data.Exceeded',
- 'errorMessage' => 'The number of metering entities must not exceed 100.',
- ],
- [
- 'errorCode' => 'Permission.Denied',
- 'errorMessage' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<PushMeteringDataResponse>\\n<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n<Success>true</Success>\\n</PushMeteringDataResponse>","errorExample":""}]',
- 'title' => 'PushMeteringData',
+ ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An unknown error occurred.'],
+ ['errorCode' => 'Service.Flow.Control', 'errorMessage' => 'The rate throttling threshold has been exceeded.', 'description' => 'The rate throttling threshold has been exceeded.'],
+ ['errorCode' => 'Invalid.Parameter.Instance', 'errorMessage' => 'The specified Instance parameter is invalid.', 'description' => 'The specified Instance parameter is invalid.'],
+ ['errorCode' => 'Invalid.Parameter.Metering', 'errorMessage' => 'The specified Metering parameter is invalid.', 'description' => 'The specified Metering parameter is invalid.'],
+ ['errorCode' => 'Metering.Data.Exceeded', 'errorMessage' => 'The number of metering entities must not exceed 100.', 'description' => 'The number of metering entities must not exceed 100.'],
+ ['errorCode' => 'Permission.Denied', 'errorMessage' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.', 'description' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","type":"json"}]',
+ 'title' => 'Push Metering Data',
+ 'description' => '### Encoding and Format Requirements'."\n"
+ .'- All request parameters must be URLEncoded.'."\n"
+ .'- The Metering field in the parameters must strictly follow the format in the example in this document. It has been found that many submissions are not valid JSON. Please verify the format with a JSON formatting tool before submission, otherwise the API call will fail.'."\n"
+ .'### Request Frequency and Single Write Volume Limits'."\n"
+ .'- For hourly/daily metering: Cloud Marketplace limits requests for each InstanceId to once per 60 seconds, and each request supports writing up to 100 metering data entries.'."\n"
+ .'- For real-time metering (for large model usage scenarios): Cloud Marketplace has no frequency limit for each InstanceId, and each request supports writing up to 10 metering data entries.'."\n"
+ .'### Batch Push Limits for Metering Data'."\n"
+ .'- Cross-product InstanceId batch pushing is not supported. When batch pushing, ensure all InstanceIds belong to the same product.'."\n"
+ .'- When batch pushing metering data, the "InstanceId" attribute must belong to instances generated by the same product. Pushing instances from multiple products simultaneously is currently not supported.'."\n"
+ .'### Time Requirements for Metering Data Push'."\n"
+ .'- For products billed by the hour, the billing deadline is the next hour, and metering data must be pushed on time. For example, if the metering data is for 8:10-08:20, it must be pushed before 9:59, otherwise billing will not occur. The rule for daily billing is similar: the previous day\'s data must be pushed before 1:59 of the next day, otherwise the metering push will return an error and billing will not occur.'."\n"
+ .'- For products billed by the minute, real-time pushed data is aggregated by the minute and billed by the minute.'."\n"
+ .'- If the product is set to real-time billing, StartTime and EndTime can have any time span, but EndTime must be greater than StartTime.'."\n"
+ .'- If the product is set to non-real-time billing (i.e., hourly, daily, etc.), the interval between StartTime and EndTime must be greater than 5 minutes.'."\n"
+ .'### Timeliness of Pushing and Billing'."\n"
+ .'- If the instance status has expired, metering data pushed after the instance expiration will not be billed. For example, if the instance expired at 2025-07-09 12:20:00, metering data pushed for the period 2025-07-09 13:00:00-2025-07-09 14:00:00 will not be billed. Metering data for the period 2025-07-09 12:00:00-2025-07-09 13:00:00 can still be billed normally.'."\n"
+ .'- After pushing metering data, billing does not occur immediately. For hourly billing, bills are generated in the next time interval. For example, for hourly billing, the bill for 8:00-9:00 is generated after 10:00. For daily billing, bills are generated the next day. After billing, customers can view the bills in [Alibaba Cloud Bill Details](https://billing-cost.console.aliyun.com/finance/expense-report/expense-detail-by-instance).'."\n"
+ .'### Amount Rounding to Zero'."\n"
+ .'- If the bill amount is too small and the single bill amount is less than 0.01 CNY, the bill amount on the buyer\'s side will be 0. For example, if the product unit price is 0.001 CNY/count and is billed by the minute with 9 uses per minute, the bill amount per minute is 0. If billed by the hour and the single hourly bill amount is less than 0.01, the buyer\'s bill amount will be 0. The probability of minute-level billing amounts being rounded to zero may be higher than that of hourly billing.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CrossAccountVerifyToken' => [
- 'summary' => '跨账号角色授权,根据token获取用户信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'changeSet' => [
+ ['createdAt' => '2025-12-15T03:16:22.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-07-10T00:48:28.000Z', 'description' => 'Error codes changed'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'Token',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '跨账号角色授权成功返回的token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'C19D103FEA2D50A584410267CE9FBA56',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ResultDTO<ServiceRoleVerifyTokenDTO>',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '用户展示名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'marketplace_wangxiao_test',
- ],
- 'Uid' => [
- 'title' => '用户阿里云uid',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1744526877246715',
- ],
- 'AuthTime' => [
- 'title' => '授权时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1676974108866',
- ],
- 'AuthRoles' => [
- 'title' => '授权角色',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'VendorCrossAccountXIAOYUNACCESSSMSRole',
- ],
- ],
- ],
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'RequestId',
- 'type' => 'string',
- 'example' => 'C19D103F-EA2D-50A5-8441-0267CE9FBA56',
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'acm:PushMeteringData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"Name\\": \\"marketplace_wangxiao_test\\",\\n \\"Uid\\": \\"1744526877246715\\",\\n \\"AuthTime\\": 1676974108866,\\n \\"AuthRoles\\": [\\n \\"VendorCrossAccountXIAOYUNACCESSSMSRole\\"\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C19D103F-EA2D-50A5-8441-0267CE9FBA56\\"\\n}","type":"json"}]',
],
- 'DescribeDistributionProductsLink' => [
- 'summary' => '获取并生成推广商品-链接',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'PushTimesUsage' => [
+ 'summary' => '',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'Codes',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '商品code集合,不能为空集合,集合大小最多50条',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => 'cmapi*****',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cmapi******',
- ],
- 'required' => true,
- 'docRequired' => true,
- 'minItems' => 1,
- ],
+ 'schema' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '1000001'],
+ ],
+ [
+ 'name' => 'Times',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'title' => '', 'description' => '', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => '6dff6c70-3484-4a39-b725-164e3ad9b20d'],
],
],
'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' => '5BD09171-BF4D-18D8-890E-C70C067527BE',
- ],
- 'TotalCount' => [
- 'title' => '推广商品总数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'Success' => [
- 'title' => '成功状态标识',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'title' => '商品推广链接',
- 'type' => 'string',
- ],
- 'Code' => [
- 'title' => '推广商品code',
- 'type' => 'string',
- ],
- 'Name' => [
- 'title' => '推广商品名称',
- 'type' => 'string',
- ],
- ],
- ],
- ],
+ 'Result' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''],
+ 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'example' => '200', 'title' => ''],
+ 'Message' => ['type' => 'string', 'description' => '', 'example' => 'success', 'title' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''],
+ 'HttpStateCode' => ['type' => 'string', 'description' => '', 'example' => '200', 'title' => ''],
+ 'ForceFatal' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''],
],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- [
- 'errorCode' => 'Forbidden!',
- 'errorMessage' => 'user is not distributor!',
- ],
- [
- 'errorCode' => 'ProductCodes',
- 'errorMessage' => 'productCodes is empty!',
- ],
- [
- 'errorCode' => 'codeSizeError',
- 'errorMessage' => 'productCodes size should less than 50!',
- ],
- [
- 'errorCode' => 'CodeError',
- 'errorMessage' => 'codes is not correct!',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BD09171-BF4D-18D8-890E-C70C067527BE\\",\\n \\"TotalCount\\": 51,\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"Url\\": \\"https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D\\",\\n \\"Code\\": \\"cmapi000****\\",\\n \\"Name\\": \\"测试商品\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDistributionProductsLinkResponse>\\n <RequestId>5BD09171-BF4D-18D8-890E-C70C067527BE</RequestId>\\n <TotalCount>51</TotalCount>\\n <Success>true</Success>\\n <Result>\\n <Url>https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D</Url>\\n <Code>cmapi000****</Code>\\n <Name>测试商品</Name>\\n </Result>\\n</DescribeDistributionProductsLinkResponse>","errorExample":""}]',
+ 400 => [
+ ['errorCode' => 'DuplicateClientToken', 'errorMessage' => 'clientToken Duplicate Submission (PROCESSING Status).', 'description' => 'clientToken Duplicate Submission (PROCESSING Status)'],
+ ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instance does not exist.', 'description' => 'The instance does not exist.'],
+ ['errorCode' => 'SupplierNotFound', 'errorMessage' => 'Service provider does not exist.', 'description' => 'Service provider does not exist'],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Permission verification failed.', 'description' => 'Permission verification failed'],
+ ['errorCode' => 'Throttling', 'errorMessage' => 'Distributed lock acquisition failure (concurrency limit).', 'description' => 'Distributed lock acquisition failure (concurrency limit)'],
+ ['errorCode' => 'UnknownResult', 'errorMessage' => 'Update result unknown, please contact cloud market.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'description' => '## 请求说明'."\n"
+ .'- 该接口适用于预付费按次计费的商品,通过此接口服务商可以将用户的使用次数推送给云市场进行扣减。'."\n"
+ .'- 接口采用强制更新模式,直接扣减指定次数,调用方需自行判断用户使用量是否超出。'."\n"
+ .'- 所有请求参数必须进行URLEncode编码。'."\n"
+ .'- 使用`ClientToken`参数实现幂等性控制,在24小时内相同的`ClientToken`不允许重复提交。'."\n"
+ .'- 同一笔扣减操作的重试必须使用相同的`ClientToken`;新的业务操作应使用新的`ClientToken`。'."\n"
+ .'- 如果上一次请求已成功(即使因网关超时未收到响应),使用相同`ClientToken`重试会幂等返回成功,不会重复扣减。'."\n"
+ .'- 如果上一次请求结果未确定(处于PROCESSING状态),使用相同`ClientToken`重试会返回`DuplicateClientToken`错误,请稍后重试或联系云市场确认推送状态。'."\n"
+ .'- 同一个`InstanceId`同一时刻只允许一个操作执行,并发请求会返回`Throttling`错误,请稍后重试。'."\n"
+ .'- 可以在[OpenAPI Explorer](https://api.aliyun.com/#product=Market&api=PushTimesUsage&type=RPC&version=2015-11-01)中直接运行该接口,免去计算签名的困扰。'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"HttpStateCode\\": \\"200\\",\\n \\"ForceFatal\\": false,\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]',
],
- 'DescribeDistributionProducts' => [
- 'summary' => '分页获取推广商品',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ResumeProject' => [
+ 'summary' => 'Calls ResumeProject to resume a paused project.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'PageNumber',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '分页-当前页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace order.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'NodeId',
'in' => 'query',
- 'schema' => [
- 'title' => '每页的推广商品数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The ID of the operation flow node.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1922', 'title' => ''],
],
[
- 'name' => 'Filter',
+ 'name' => 'Remark',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'supplierName',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cmj0000000',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The reason for the remark.', 'type' => 'string', 'required' => false, 'example' => '仓库库存已补充,可安排发货。', 'title' => ''],
],
],
'responses' => [
@@ -5348,426 +3879,686 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'Results' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'FirstCategoryName' => [
- 'title' => '商品类目,一级类目名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SecondCategoryName' => [
- 'title' => '商品类目,二级类目名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Type' => [
- 'title' => '商品类型'."\n"
- .' APP 应用类'."\n"
- .' SERVICE 服务类'."\n"
- .' CHENGPIN_SITE 成品网站'."\n"
- .' SITE_CUSTOM_SERVICE 定制网站'."\n"
- .' SITE_PROMOTION_RUN 网站推广运营'."\n"
- .' ENT_APP_SOFT 应用软件'."\n"
- .' CLOUD_SERVICE 云服务'."\n"
- .' EIF 企信宝'."\n"
- .' BASIC_TOOLS 基础工具'."\n"
- .' BASIC_SERVICES 基础服务'."\n"
- .' JIANZHAN_XITONG 建站系统'."\n"
- .' APP_COUPLES 应用伴侣'."\n"
- .' MIRRORS_MARKET 镜像市场'."\n"
- .' MIRRORS_MARKET_BASIC_ENVIRONMENT 基础环境'."\n"
- .' MIRRORS_MARKET_APPLICATION_SOFTWARE 应用软件'."\n"
- .' MIRROR 镜像类'."\n"
- .' DINGDING 钉钉类'."\n"
- .' DOWNLOAD 下载类'."\n"
- .' EXTENDED 未知类'."\n"
- .' API_SERVICE API类'."\n"
- .' ROS 资源编排类'."\n"
- .' DOCKER 容器类'."\n"
- .' LICENSE 授权码类'."\n"
- .' SAAS_WUYING 应用软件-无影应用',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ImageUrl' => [
- 'title' => '商品主图url',
- 'description' => '',
- 'type' => 'string',
- 'example' => '//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg',
- ],
- 'Code' => [
- 'title' => '商品code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmap*****',
- ],
- 'Name' => [
- 'title' => '商品名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ShortDescription' => [
- 'title' => '商品简介',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Price' => [
- 'title' => '商品默认规格价格',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'Score' => [
- 'title' => '商品用户评分',
- 'description' => '',
- 'type' => 'string',
- 'example' => '5',
- ],
- 'TradeCount' => [
- 'title' => '商品近180天成交',
- 'description' => '',
- 'type' => 'string',
- 'example' => '109',
- ],
- 'UserCommentCount' => [
- 'title' => '商品买家评论数',
- 'description' => '',
- 'type' => 'string',
- 'example' => '55',
- ],
- 'SubmissionRadio' => [
- 'title' => '商品返佣比例',
- 'description' => '',
- 'type' => 'string',
- 'example' => '30',
- ],
- 'SupplierName' => [
- 'title' => '推广服务商名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SupplierUId' => [
- 'title' => '推广服务商(商品供应商)阿里云UID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1911534921******',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', 'title' => ''],
+ 'Result' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Success' => ['description' => 'The success status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''],
+ ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''],
+ ['errorCode' => 'IllegalProjectStatus', 'errorMessage' => 'Illegal project status.', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'user is not distributor!',
- ],
- [
- 'errorCode' => 'UnknownError',
- 'errorMessage' => 'An error occurred while processing your request. ',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BD09171-MB74-18D8-890E-C70C067527BE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Results\\": [\\n {\\n \\"FirstCategoryName\\": \\"API市场\\",\\n \\"SecondCategoryName\\": \\"生活服务\\",\\n \\"Type\\": \\"API类\\",\\n \\"ImageUrl\\": \\"//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg\\",\\n \\"Code\\": \\"cmap*****\\",\\n \\"Name\\": \\"手机号码在网状态查询\\",\\n \\"ShortDescription\\": \\"运营商号码状态查询】精准实时空号检测,手机号在网状态查询,返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。\\",\\n \\"Price\\": \\"100\\",\\n \\"Score\\": \\"5\\",\\n \\"TradeCount\\": \\"109\\",\\n \\"UserCommentCount\\": \\"55\\",\\n \\"SubmissionRadio\\": \\"30\\",\\n \\"SupplierName\\": \\"深圳市****有限公司\\",\\n \\"SupplierUId\\": \\"1911534921******\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDistributionProductsResponse>\\n <RequestId>5BD09171-MB74-18D8-890E-C70C067527BE</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>50</TotalCount>\\n <Results>\\n <FirstCategoryName>API市场</FirstCategoryName>\\n <SecondCategoryName>生活服务</SecondCategoryName>\\n <Type>API类</Type>\\n <ImageUrl>//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg</ImageUrl>\\n <Code>cmap*****</Code>\\n <Name>手机号码在网状态查询</Name>\\n <ShortDescription>运营商号码状态查询】精准实时空号检测,手机号在网状态查询,返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。</ShortDescription>\\n <Price>100</Price>\\n <Score>5</Score>\\n <TradeCount>109</TradeCount>\\n <UserCommentCount>55</UserCommentCount>\\n <SubmissionRadio>30</SubmissionRadio>\\n <SupplierName>深圳市****有限公司</SupplierName>\\n <SupplierUId>1911534921******</SupplierUId>\\n </Results>\\n</DescribeDistributionProductsResponse>","errorExample":""}]',
- ],
- 'DescribeApiMetering' => [
- 'summary' => '查询API用量',
- 'methods' => [
- 'get',
+ 'title' => 'Resume a paused project',
+ 'description' => '**'."\n"
+ .'**.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ResumeProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'RollbackCurrentProjectNode' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'productCode',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cmapi0004****',
- ],
+ 'schema' => ['description' => 'The instance ID of the Alibaba Cloud Marketplace order.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89', 'title' => ''],
],
[
- 'name' => 'type',
+ 'name' => 'NodeId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the current process node.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1925', 'title' => ''],
],
[
- 'name' => 'pageNum',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The remarks for the rejection reason.', 'type' => 'string', 'required' => false, 'example' => '尊敬的顾客您好,您提交的收货地址存在多个匹配结果,请您核对后再重新提交。', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '62FC432C55A1A63534A6CB34',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AliyunPk' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '102277855749****',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmapi0004****',
- ],
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TotalQuota' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '98',
- ],
- 'TotalUsage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '220',
- ],
- 'TotalCapacity' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Unit' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Version' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'Fatal' => [
- 'description' => 'fatal',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', 'title' => ''],
+ 'Result' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Success' => ['description' => 'The success status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"62FC432C55A1A63534A6CB34\\",\\n \\"Code\\": \\"200\\",\\n \\"Result\\": [\\n {\\n \\"AliyunPk\\": 0,\\n \\"ProductCode\\": \\"cmapi0004****\\",\\n \\"ProductName\\": \\"身份证实名认证-身份证实名\\",\\n \\"TotalQuota\\": 98,\\n \\"TotalUsage\\": 220,\\n \\"TotalCapacity\\": 0,\\n \\"Unit\\": \\"次\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"Success\\": true,\\n \\"Count\\": 100,\\n \\"PageSize\\": 20,\\n \\"Message\\": \\"\\\\\\"成功\\\\\\"\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Fatal\\": false\\n}","errorExample":""},{"type":"xml","example":"<DescribeApiMeteringResponse>\\n <RequestId>62FC432C55A1A63534A6CB34</RequestId>\\n <Code>200</Code>\\n <Result>\\n <ProductCode>cmapi0004****</ProductCode>\\n <ProductName>身份证实名认证-身份证实名</ProductName>\\n <TotalQuota>98</TotalQuota>\\n <TotalUsage>220</TotalUsage>\\n <Unit>次</Unit>\\n </Result>\\n <PageNumber>1</PageNumber>\\n <Success>true</Success>\\n <Count>100</Count>\\n <PageSize>20</PageSize>\\n <Message>\\"成功\\"</Message>\\n <Version>1.0</Version>\\n <Fatal>false</Fatal>\\n</DescribeApiMeteringResponse>","errorExample":""}]',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''],
+ ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => 'Results abnormal'],
+ ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''],
+ ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''],
+ ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''],
+ ['errorCode' => 'IllegalProjectStatus', 'errorMessage' => 'Illegal project status.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Trigger current process rejection',
+ 'summary' => 'Triggers a rejection of the current process node by calling RollbackCurrentProjectNode.',
+ 'description' => '**'."\n"
+ .'**.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:RollbackCurrentProjectNode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => 'market.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Auth.Authorized', 'message' => 'The specified RAM user is not authorized.', 'http_code' => 400, 'description' => 'The specified RAM user is not authorized.'],
+ ['code' => 'Auth.CallerType', 'message' => 'RAM users or STS tokens are not supported.', 'http_code' => 400, 'description' => 'RAM users or STS tokens are not supported.'],
+ ['code' => 'Auth.ISV', 'message' => 'Only ISV accounts are allowed to call the specified API operation.', 'http_code' => 400, 'description' => 'Only ISV accounts are allowed to call the specified API operation.'],
+ ['code' => 'Auth.ISV.Error', 'message' => 'Only ISV accounts are allowed to call the specified API operation.', 'http_code' => 400, 'description' => 'Only ISV accounts are allowed to call the specified API operation.'],
+ ['code' => 'Auth.Match', 'message' => 'The product to be enabled by the specified license does not belong to the ISV.', 'http_code' => 400, 'description' => 'The product to be enabled by the specified license does not belong to the ISV.'],
+ ['code' => 'Auth.SubAccount.Error', 'message' => 'The specified AccessKey information does not belong to the RAM user.', 'http_code' => 400, 'description' => 'The specified AccessKey information does not belong to the RAM user.'],
+ ['code' => 'DeniedModify', 'message' => 'You are not authorized to call the specified API operation.', 'http_code' => 400, 'description' => 'You are not authorized to call the specified API operation.'],
+ ['code' => 'DownstreamError', 'message' => 'An error occurred while processing your request.', 'http_code' => 501, 'description' => 'An error occurred while processing your request.'],
+ ['code' => 'IgnoreError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
+ ['code' => 'IllegalResult', 'message' => 'Illegal result.', 'http_code' => 400, 'description' => 'Results abnormal'],
+ ['code' => 'INAVLIDPARAM.CALLERTYPE', 'message' => 'The specified callerType is invalid.', 'http_code' => 400, 'description' => 'The specified callerType is invalid.'],
+ ['code' => 'INAVLIDPARAM.OWNERID', 'message' => 'The partner ownerId parameter must be specified.', 'http_code' => 400, 'description' => 'The partner ownerId parameter must be specified.'],
+ ['code' => 'Invalid.CategoryId', 'message' => 'The specified CategoryId is invalid.', 'http_code' => 500, 'description' => 'The specified CategoryId is invalid.'],
+ ['code' => 'Invalid.Param', 'message' => 'The specified Filter key is invalid.', 'http_code' => 500, 'description' => 'The specified Filter key is invalid.'],
+ ['code' => 'Invalid.Parameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
+ ['code' => 'Invalid.Parameter.Instance', 'message' => 'The specified Instance parameter is invalid.', 'http_code' => 500, 'description' => 'The specified Instance parameter is invalid.'],
+ ['code' => 'Invalid.Parameter.Metering', 'message' => 'The specified Metering parameter is invalid.', 'http_code' => 500, 'description' => 'The specified Metering parameter is invalid.'],
+ ['code' => 'Invalid.Parameter.Metering', 'message' => 'meteringAssit is empty', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Invalid.Parameter.OrderId', 'message' => 'orderId is not correct.', 'http_code' => 400, 'description' => 'Incorrect parameter'],
+ ['code' => 'Invalid.Sort', 'message' => 'The specified Sort is invalid.', 'http_code' => 500, 'description' => 'The specified Sort is invalid.'],
+ ['code' => 'INVALIDPARAM.BIDOWNERBID', 'message' => 'The owner does not belong to the partner specified by the BID.', 'http_code' => 400, 'description' => 'The owner does not belong to the partner specified by the BID.'],
+ ['code' => 'INVALIDPARAM.BIDTYPE', 'message' => 'You must specify both callerBid and callerType.', 'http_code' => 400, 'description' => 'You must specify both callerBid and callerType.'],
+ ['code' => 'INVALIDPARAM.CALLERBID', 'message' => 'The specified callerBid is invalid.', 'http_code' => 400, 'description' => 'The specified callerBid is invalid.'],
+ ['code' => 'INVALIDPARAM.PARTNERBID', 'message' => 'The specified partner BID is invalid.', 'http_code' => 400, 'description' => 'The specified partner BID is invalid.'],
+ ['code' => 'License.Discard', 'message' => 'The specified license has been discarded.', 'http_code' => 400, 'description' => 'The specified license has been discarded.'],
+ ['code' => 'License.Expired', 'message' => 'The specified license has expired.', 'http_code' => 400, 'description' => 'The specified license has expired.'],
+ ['code' => 'License.Invalid', 'message' => 'The specified license is invalid.', 'http_code' => 400, 'description' => 'The specified license is invalid.'],
+ ['code' => 'License.NotFound', 'message' => 'The specified license does not exist.', 'http_code' => 400, 'description' => 'The specified license does not exist.'],
+ ['code' => 'Metering.Data.Exceeded', 'message' => 'The number of metering entities must not exceed 100.', 'http_code' => 500, 'description' => 'The number of metering entities must not exceed 100.'],
+ ['code' => 'PAY.ACCOUNT_BOOK_NOT_EXIST', 'message' => 'The specified subscription does not exist.', 'http_code' => 400, 'description' => 'The specified subscription does not exist.'],
+ ['code' => 'Permission.Denied', 'message' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.', 'http_code' => 500, 'description' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.'],
+ ['code' => 'ReturnNull', 'message' => 'No results found.', 'http_code' => 502, 'description' => 'No results found.'],
+ ['code' => 'Service.Flow.Control', 'message' => 'The rate throttling threshold has been exceeded.', 'http_code' => 500, 'description' => 'The rate throttling threshold has been exceeded.'],
+ ['code' => 'UnknownError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An unknown error occurred.'],
+ ['code' => 'UnknownError', 'message' => 'execute oms post error', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InstanceNotFound', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => 'The instance does not exist.'],
+ ['code' => 'DuplicateClientToken', 'message' => 'clientToken Duplicate Submission (PROCESSING Status).', 'http_code' => 400, 'description' => 'clientToken Duplicate Submission (PROCESSING Status)'],
+ ['code' => 'SupplierNotFound', 'message' => 'Service provider does not exist.', 'http_code' => 400, 'description' => 'Service provider does not exist'],
+ ['code' => 'Forbidden', 'message' => 'Permission verification failed.', 'http_code' => 400, 'description' => 'Permission verification failed'],
+ ['code' => 'Throttling', 'message' => 'Distributed lock acquisition failure (concurrency limit).', 'http_code' => 400, 'description' => 'Distributed lock acquisition failure (concurrency limit)'],
+ ['code' => 'UnknownResult', 'message' => 'Update result unknown, please contact cloud market.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'market.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'market.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'market.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'market.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'market.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'market.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'market.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'market.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'PushMeteringData'],
+ ],
+ 'createdAt' => '2025-12-15T03:16:31.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'market.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DescribeInstances'],
+ ],
+ 'createdAt' => '2024-08-29T09:32:41.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribeApiMetering'],
+ ],
+ 'createdAt' => '2024-07-29T06:21:14.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'CrossAccountVerifyToken'],
+ ],
+ 'createdAt' => '2024-04-03T01:36:19.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'me-east-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateOrder'],
+ ],
+ 'createdAt' => '2024-03-28T06:49:13.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'us-east-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'],
+ ],
+ 'createdAt' => '2024-03-14T01:57:36.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'us-west-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DescribeApiMetering'],
+ ],
+ 'createdAt' => '2023-12-25T03:49:16.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'market.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'PushMeteringData'],
+ ],
+ 'createdAt' => '2023-07-10T00:48:42.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'market.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribeDistributionProductsLink'],
+ ],
+ 'createdAt' => '2023-06-01T02:25:41.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'market.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'AutoRenewInstance'],
+ ],
+ 'createdAt' => '2022-11-23T01:55:38.000Z',
+ 'description' => '增加对周期类商品自动续费的支持',
],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'market.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProducts'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOrder'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateOrder'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProductsLink'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProduct'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiMetering'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstances'],
],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'market.ap-southeast-1.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'Market',
+ 'productName' => 'Market',
+ 'ramCodes' => ['acm'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DescribeOrderForIsv',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeOrderForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfirmNotification',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ConfirmNotification',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeProjectMessages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectMessages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeApiMetering',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeApiMetering',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDistributionProductsLink',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeDistributionProductsLink',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResumeProject',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ResumeProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribePrice',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeFailedNotifications',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeFailedNotifications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeProjectNodes',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectNodes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PauseProject',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:PauseProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CrossAccountVerifyToken',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:CrossAccountVerifyToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDistributionProducts',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeDistributionProducts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeLicense',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeLicense',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInvoiceForIsv',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInvoiceForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PushTimesUsage',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:PushTimesUsage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCurrentNodeInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeCurrentNodeInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstance',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeProjectAttachments',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectAttachments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeProjectInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceForIsv',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeInstanceForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeOrder',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RollbackCurrentProjectNode',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:RollbackCurrentProjectNode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AutoRenewInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:AutoRenewInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FinishCurrentProjectNode',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:FinishCurrentProjectNode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInvoiceForIsv',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ModifyInvoiceForIsv',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ActivateLicense',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'acm:ActivateLicense',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PushMeteringData',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'acm:PushMeteringData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateOrder',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'acm:CreateOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeProjectOperateLogs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'acm:DescribeProjectOperateLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Market', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];