summaryrefslogtreecommitdiff
path: root/data/zh_cn/brain-industrial
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/brain-industrial')
-rw-r--r--data/zh_cn/brain-industrial/2020-09-20/api-docs.php4325
1 files changed, 1521 insertions, 2804 deletions
diff --git a/data/zh_cn/brain-industrial/2020-09-20/api-docs.php b/data/zh_cn/brain-industrial/2020-09-20/api-docs.php
index 887a043..155fb25 100644
--- a/data/zh_cn/brain-industrial/2020-09-20/api-docs.php
+++ b/data/zh_cn/brain-industrial/2020-09-20/api-docs.php
@@ -1,59 +1,34 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'brain-industrial',
- 'version' => '2020-09-20',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'brain-industrial', 'version' => '2020-09-20'],
'directories' => [
[
- 'id' => 204312,
- 'title' => 'AICS',
+ 'children' => ['AicsOpenApiInvoke'],
'type' => 'directory',
- 'children' => [
- 'AicsOpenApiInvoke',
- ],
+ 'title' => 'AICS',
+ 'id' => 335558,
],
[
- 'id' => 203126,
- 'title' => '授权和激活',
+ 'children' => ['ListUserResources', 'ListLicenses', 'GetLicense', 'ActivateLicense', 'UpdateLicenseDescription'],
'type' => 'directory',
- 'children' => [
- 'ListUserResources',
- 'ListLicenses',
- 'GetLicense',
- 'ActivateLicense',
- 'UpdateLicenseDescription',
- ],
+ 'title' => '授权和激活',
+ 'id' => 335544,
],
[
- 'id' => 203127,
- 'title' => '虚拟电厂API',
+ 'children' => ['ListAivppResources', 'CreateLoadForecastJob', 'CreatePowerForecastJob', 'CreateEssOptJob', 'CreateLoadForecastByFileUrlJob', 'CreatePowerForecastByFileUrlJob', 'GetAivppAlgoJob'],
'type' => 'directory',
- 'children' => [
- 'ListAivppResources',
- 'CreateLoadForecastJob',
- 'CreateLoadForecastJob',
- 'CreatePowerForecastJob',
- 'CreateEssOptJob',
- 'CreateLoadForecastByFileUrlJob',
- 'CreatePowerForecastByFileUrlJob',
- 'GetAivppAlgoJob',
- ],
+ 'title' => '虚拟电厂API',
+ 'id' => 335550,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'AicsOpenApiInvoke' => [
- 'summary' => '调用aics openapi。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ActivateLicense' => [
+ 'summary' => '激活License。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -62,76 +37,33 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
+ 'operationType' => 'update',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrialQ3LUJC',
- 'FEATUREbrainindustrialWZ1RY1',
- ],
+ 'abilityTreeNodes' => ['FEATUREbrainindustrialGARA6B'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ServiceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'openapi的service id',
- 'description' => 'openapi的service id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ae5f9884c9914ed7af72b07e6c1616f9',
- ],
- ],
- [
- 'name' => 'NodeId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '类型',
- 'description' => '节点id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '119397',
- ],
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'description' => '类型',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NODE' => 'NODE',
- 'EXPERIMENT' => 'EXPERIMENT',
- ],
- 'example' => 'EXPERIMENT',
- 'default' => 'EXPERIMENT',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => '12bea6b4489fsde7b903fe05934a0adx'],
],
[
- 'name' => 'Param',
+ 'name' => 'Fingerprint',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '输入参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{"a":1}',
- ],
+ 'schema' => ['description' => '机器指纹', 'type' => 'string', 'required' => false, 'example' => 'XXX'],
],
[
- 'name' => 'JobId',
- 'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'title' => 'jobId,查询异步调用画布结果时使用',
- 'description' => 'jobId,查询异步调用画布结果时使用',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bd20e071eee74faabbe1fd12b82e1358',
- ],
+ 'name' => 'OrderId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '订单ID。', 'type' => 'string', 'required' => false, 'example' => 'XXX'],
],
],
'responses' => [
@@ -141,105 +73,142 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'Success' => [
- 'title' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'description' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '65308A66-8764-53EE-8D4A-201E86CA88C5'],
+ 'Success' => ['title' => '资源ID,如ECS实例的创建接口CreateInstance应返回InstanceId。', 'description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '返回结果',
- 'type' => 'any',
- 'example' => '{"c":2}',
+ 'description' => '返回的结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'Id', 'type' => 'string', 'example' => '1'],
+ 'LicenseSpecName' => ['description' => 'license类型名称', 'type' => 'string', 'example' => '边缘端1000型运行节点授权'],
+ 'BuyTime' => ['description' => '购买时间', 'type' => 'string', 'example' => '2024-04-29 15:00:15'],
+ 'ActivateTime' => ['description' => '激活时间。', 'type' => 'string', 'example' => '2024-04-29 15:03:12'],
+ 'Fingerprint' => ['description' => '机器指纹', 'type' => 'string', 'example' => 'XXXX'],
+ 'LicenseCode' => ['description' => '授权码。', 'type' => 'string', 'example' => 'XXX'],
+ 'EffectTime' => ['description' => '生效时间', 'type' => 'string', 'example' => '2024-05-01 00:00:00'],
+ 'ExpireTime' => ['description' => '过期时间', 'type' => 'string', 'example' => '2025-05-01 00:00:00'],
+ 'Duration' => ['description' => '已激活剩余时长', 'type' => 'string', 'example' => '2个月9天'],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'activated'],
+ 'CpuLimit' => ['description' => '限制的CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '72'],
+ 'MemoryLimit' => ['description' => 'memory 上限(GB)', 'type' => 'integer', 'format' => 'int32', 'example' => '256'],
+ 'InstanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'c39128fcb74e482546a72de90cdsaba3'],
+ 'AllDuration' => ['description' => '已激活总时长', 'type' => 'string', 'example' => '1年'],
+ 'ApplicableSpecs' => ['description' => '适用规格', 'type' => 'string', 'example' => '72核256G'],
+ 'Description' => ['description' => '描述', 'type' => 'string', 'example' => '""'],
+ 'UnActivateAllDuration' => ['description' => '未激活时长', 'type' => 'string', 'example' => '1个月'],
+ 'ActivateRecord' => [
+ 'description' => '激活记录',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => 'XXX'],
+ 'BuyTime' => ['description' => '购买时间。', 'type' => 'string', 'example' => '2024-04-29 15:01:15'],
+ 'ActivateTime' => ['description' => '激活时间', 'type' => 'string', 'example' => '2024-04-29 15:03:12'],
+ 'ExpireTime' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2025-05-01 00:00:00'],
+ 'Duration' => ['description' => '时长', 'type' => 'string', 'example' => '1年'],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'activated'],
+ 'LicenseCode' => ['description' => '激活码', 'type' => 'string', 'example' => 'XXX'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情', 'type' => 'string', 'example' => '{}'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65308A66-8764-53EE-8D4A-201E86CA88C5\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Id\\": \\"1\\",\\n \\"LicenseSpecName\\": \\"边缘端1000型运行节点授权\\",\\n \\"BuyTime\\": \\"2024-04-29 15:00:15\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\",\\n \\"Fingerprint\\": \\"XXXX\\",\\n \\"LicenseCode\\": \\"XXX\\",\\n \\"EffectTime\\": \\"2024-05-01 00:00:00\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\",\\n \\"Duration\\": \\"2个月9天\\",\\n \\"Status\\": \\"activated\\",\\n \\"CpuLimit\\": 72,\\n \\"MemoryLimit\\": 256,\\n \\"InstanceId\\": \\"c39128fcb74e482546a72de90cdsaba3\\",\\n \\"AllDuration\\": \\"1年\\",\\n \\"ApplicableSpecs\\": \\"72核256G\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"UnActivateAllDuration\\": \\"1个月\\",\\n \\"ActivateRecord\\": [\\n {\\n \\"OrderId\\": \\"XXX\\",\\n \\"BuyTime\\": \\"2024-04-29 15:01:15\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\",\\n \\"Duration\\": \\"1年\\",\\n \\"Status\\": \\"activated\\",\\n \\"LicenseCode\\": \\"XXX\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]',
+ 'title' => '激活授权',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ActivateLicense',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"{\\\\\\"c\\\\\\":2}\\"\\n}","type":"json"}]',
- 'title' => 'AICS OpenApi调用',
],
- 'ListUserResources' => [
- 'summary' => '获取用户资源列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AicsOpenApiInvoke' => [
+ 'summary' => '调用aics openapi。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrialGARA6B',
- ],
+ 'abilityTreeNodes' => ['FEATUREbrainindustrialQ3LUJC', 'FEATUREbrainindustrialWZ1RY1'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'CommodityCode',
- 'in' => 'formData',
+ 'name' => 'ServiceId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'openapi的service id', 'description' => 'openapi的service id', 'type' => 'string', 'required' => true, 'example' => 'ae5f9884c9914ed7af72b07e6c1616f9'],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => ['title' => '类型', 'description' => '节点id', 'type' => 'string', 'required' => false, 'example' => '119397'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
'schema' => [
- 'title' => '产品CODE',
- 'description' => '产品CODE',
+ 'description' => '类型',
'type' => 'string',
'required' => false,
- 'example' => 'BrainIndustrial',
+ 'enumValueTitles' => ['NODE' => 'NODE', 'EXPERIMENT' => 'EXPERIMENT'],
+ 'example' => 'EXPERIMENT',
+ 'default' => 'EXPERIMENT',
],
],
+ [
+ 'name' => 'Param',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => '输入参数', 'type' => 'object', 'required' => false, 'example' => '{"a":1}'],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['title' => 'jobId,查询异步调用画布结果时使用', 'description' => 'jobId,查询异步调用画布结果时使用', 'type' => 'string', 'required' => false, 'example' => 'bd20e071eee74faabbe1fd12b82e1358'],
+ ],
],
'responses' => [
200 => [
@@ -248,715 +217,239 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '65308A66-8764-53EE-8D4A-201E86CA88C5',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '资源列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源实例',
- 'type' => 'object',
- 'properties' => [
- 'startDate' => [
- 'description' => '开始时间',
- 'type' => 'string',
- 'example' => '20240902',
- ],
- 'endDate' => [
- 'description' => '结束时间',
- 'type' => 'string',
- 'example' => '2024-12-21',
- ],
- 'region' => [
- 'description' => '地域',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'status' => [
- 'description' => '状态。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'instanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => '12345ea3cff446e8837078c2baffbe83',
- ],
- 'chargeType' => [
- 'description' => '付费类型',
- 'type' => 'string',
- 'example' => 'PREPAY',
- ],
- 'commodityCode' => [
- 'description' => '商品代码。',
- 'type' => 'string',
- 'example' => 'brainindustrial_simupostpaid_public_cn',
- ],
- 'statusMsg' => [
- 'description' => '状态信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息;只有RAM校验失败才会返回此字段。',
- 'type' => 'string',
- 'example' => 'None',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
+ 'Success' => ['title' => '是否调用成功。'."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'description' => '是否调用成功。'."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'type' => 'string', 'example' => 'True'],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['description' => '返回结果', 'type' => 'any', 'example' => '{"c":2}'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"{\\\\\\"c\\\\\\":2}\\"\\n}","type":"json"}]',
+ 'title' => 'AICS OpenApi调用',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-20T08:41:21.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:AicsOpenApiInvoke',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65308A66-8764-53EE-8D4A-201E86CA88C5\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"startDate\\": \\"20240902\\",\\n \\"endDate\\": \\"2024-12-21\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"instanceId\\": \\"12345ea3cff446e8837078c2baffbe83\\",\\n \\"chargeType\\": \\"PREPAY\\",\\n \\"commodityCode\\": \\"brainindustrial_simupostpaid_public_cn\\",\\n \\"statusMsg\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
- 'title' => '查询资源列表',
],
- 'ListLicenses' => [
- 'summary' => 'License列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateEssOptJob' => [
+ 'summary' => '创建储能运行优化任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrialGARA6B',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREbrainindustrial1ZR6M2'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'CurrentPage',
+ 'name' => 'Freq',
'in' => 'formData',
'schema' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '默认15min;需要与historyData的数据频率一致;枚举值:'."\n"
+ .'FIFTEEN_MIN: 15分钟'."\n"
+ .'FIVE_MIN: 5分钟'."\n"
+ .'ONE_HOUR: 1小时'."\n"
+ .'ONE_DAY: 1天',
+ 'description' => '默认15min;需要与historyData的数据频率一致;枚举值:'."\n"
+ ."\n"
+ .'- FIFTEEN_MIN: 15分钟'."\n"
+ .'- FIVE_MIN: 5分钟'."\n"
+ .'- ONE_HOUR: 1小时'."\n"
+ .'- ONE_DAY: 1天',
+ 'type' => 'string',
'required' => false,
- 'example' => '1',
+ 'example' => 'FIFTEEN_MIN',
+ 'enum' => ['FIFTEEN_MIN', 'FIVE_MIN', 'ONE_HOUR', 'ONE_DAY'],
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Duration',
'in' => 'formData',
- 'schema' => [
- 'description' => '每页显示条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '12',
- ],
+ 'schema' => ['title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
+ .'非必填,默认1天', 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
+ ."\n"
+ .'非必填,默认1天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'QueryStr',
+ 'name' => 'RunDate',
'in' => 'formData',
- 'schema' => [
- 'description' => '商品名称关键字,可根据该关键字模糊搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '边缘端1000型',
- ],
+ 'schema' => ['title' => '运行日,精确到天,“yyyy-MM-dd”格式', 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。', 'type' => 'string', 'required' => false, 'example' => '2025-02-12'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '42',
- ],
- 'RequestId' => [
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'FAC892CE-5A94-5616-91DC-629B09CC6792',
- ],
- 'Message' => [
- 'description' => '信息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => '每页显示条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'CurrentPage' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalPage' => [
- 'description' => '总页数',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'TotalPageCount' => [
- 'description' => '总分页数',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'Code' => [
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'LicenseList' => [
- 'description' => '授权列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '授权信息',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '授权ID',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'LicenseSpecName' => [
- 'description' => 'license规格名',
- 'type' => 'string',
- 'example' => '边缘端1000型运行节点授权',
- ],
- 'LicenseSpecType' => [
- 'description' => 'license商品类型',
- 'type' => 'string',
- 'example' => 'brainindustrial_aicsruntime_public_cn',
- ],
- 'LicenseSpecCode' => [
- 'description' => '授权商品code',
- 'type' => 'string',
- 'example' => 'aics_1000',
- ],
- 'BuyTime' => [
- 'description' => '购买时间。',
- 'type' => 'string',
- 'example' => '2024-10-14 13:17:20',
- ],
- 'ActivateTime' => [
- 'description' => '激活时间',
- 'type' => 'string',
- 'example' => '2024-10-14 14:15:45',
- ],
- 'EffectTime' => [
- 'description' => '生效时间',
- 'type' => 'string',
- 'example' => '2024-10-14 14:15:45',
- ],
- 'ExpireTime' => [
- 'description' => '过期时间',
- 'type' => 'string',
- 'example' => '2025-10-14 14:15:45',
- ],
- 'Duration' => [
- 'description' => '已激活剩余时长',
- 'type' => 'string',
- 'example' => '7个月23天',
- ],
- 'AdaptiveMachine' => [
- 'description' => '授权机型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'activated',
- ],
- 'MemoryLimit' => [
- 'description' => 'memory 上限(GB)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '256',
- ],
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => '451f14ee73604aesdfe4da606764ce09',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'AllDuration' => [
- 'description' => '已激活总时长',
- 'type' => 'string',
- 'example' => '1年',
- ],
- 'CpuLimit' => [
- 'description' => '限制的CPU核数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '72',
- ],
- 'UnActivateAllDuration' => [
- 'description' => '未激活时长',
- 'type' => 'string',
- 'example' => '1个月',
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 42,\\n \\"RequestId\\": \\"FAC892CE-5A94-5616-91DC-629B09CC6792\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 12,\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": \\"4\\",\\n \\"TotalPageCount\\": \\"4\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"LicenseList\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"LicenseSpecName\\": \\"边缘端1000型运行节点授权\\",\\n \\"LicenseSpecType\\": \\"brainindustrial_aicsruntime_public_cn\\",\\n \\"LicenseSpecCode\\": \\"aics_1000\\",\\n \\"BuyTime\\": \\"2024-10-14 13:17:20\\",\\n \\"ActivateTime\\": \\"2024-10-14 14:15:45\\",\\n \\"EffectTime\\": \\"2024-10-14 14:15:45\\",\\n \\"ExpireTime\\": \\"2025-10-14 14:15:45\\",\\n \\"Duration\\": \\"7个月23天\\",\\n \\"AdaptiveMachine\\": 1,\\n \\"Status\\": \\"activated\\",\\n \\"MemoryLimit\\": 256,\\n \\"InstanceId\\": \\"451f14ee73604aesdfe4da606764ce09\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AllDuration\\": \\"1年\\",\\n \\"CpuLimit\\": 72,\\n \\"UnActivateAllDuration\\": \\"1个月\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => '查询授权列表',
- ],
- 'GetLicense' => [
- 'summary' => 'License详情。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrialGARA6B',
+ 'name' => 'TimeZone',
+ 'in' => 'formData',
+ 'schema' => ['title' => '时区,默认上海时区:Asia/Shanghai', 'description' => '时区,默认上海时区:Asia/Shanghai。', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'Id',
+ 'name' => 'ModelVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本', 'description' => '模型对应的版本号,默认为latest。', 'type' => 'string', 'required' => false, 'example' => 'latest'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'TopoType',
'in' => 'formData',
'schema' => [
- 'description' => '实例ID。',
+ 'description' => '场站内资源拓扑类型:'."\n"
+ ."\n"
+ .'- LOAD_ESS:市电+储能。'."\n"
+ .'- LOAD_ESS_SOLAR: 市电+储能+光伏。',
'type' => 'string',
'required' => false,
- 'example' => 'c31238fcb74e482588a72de90cd7dba3',
+ 'example' => 'LOAD_ESS_SOLAR',
+ 'enum' => ['LOAD_ESS', 'LOAD_ESS_SOLAR'],
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'SystemData',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'Data' => [
- 'description' => '返回的结果',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'LicenseSpecName' => [
- 'title' => '资源组ID',
- 'description' => '授权类型',
- 'type' => 'string',
- 'example' => '边缘端1000型运行节点授权',
- ],
- 'BuyTime' => [
- 'title' => '资源名称',
- 'description' => '购买时间。',
- 'type' => 'string',
- 'example' => '2024-04-29 15:01:15',
- ],
- 'ActivateTime' => [
- 'title' => '资源一级ID',
- 'description' => '激活时间',
- 'type' => 'string',
- 'example' => '2024-04-29 15:03:12',
- ],
- 'Fingerprint' => [
- 'title' => '创建时间',
- 'description' => '机器指纹',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'LicenseCode' => [
- 'description' => '授权码',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'EffectTime' => [
- 'description' => '生效时间',
- 'type' => 'string',
- 'example' => '2024-05-01 00:00:00',
- ],
- 'ExpireTime' => [
- 'description' => '过期时间',
- 'type' => 'string',
- 'example' => '2025-05-01 00:00:00',
- ],
- 'Duration' => [
- 'description' => '总激活剩余时长',
- 'type' => 'string',
- 'example' => '2个月9天',
- ],
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'activated',
- ],
- 'AdaptiveMachine' => [
- 'description' => '适配机型',
- 'type' => 'string',
- 'example' => '72核256G',
- ],
- 'LicenseSpecCode' => [
- 'description' => '授权商品code',
- 'type' => 'string',
- 'example' => 'aics_1000',
- ],
- 'LicenseSpecType' => [
- 'description' => 'license商品类型',
- 'type' => 'string',
- 'example' => 'edge_license',
- ],
- 'CpuLimit' => [
- 'description' => '限制的CPU核数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '72',
- ],
- 'MemoryLimit' => [
- 'description' => '内存限制(GB)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '256',
- ],
- 'InstanceId' => [
- 'description' => '实例ID',
- 'type' => 'string',
- 'example' => 'c31238fcb74e482588a72de90cd7dba3',
- ],
- 'AllDuration' => [
- 'description' => '激活总时长',
- 'type' => 'string',
- 'example' => '1年',
- ],
- 'ApplicableSpecs' => [
- 'description' => '适用规格',
- 'type' => 'string',
- 'example' => '72核256G',
- ],
- 'Description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'UnActivateAllDuration' => [
- 'description' => '未激活时长',
- 'type' => 'string',
- 'example' => '1个月',
- ],
- 'Proposal' => [
- 'description' => '建议。',
- 'type' => 'string',
- 'example' => '最大用量建议(72核256G)',
- ],
- 'ActivateRecord' => [
- 'description' => '激活记录列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '激活记录',
- 'type' => 'object',
- 'properties' => [
- 'OrderId' => [
- 'description' => '订单id',
- 'type' => 'string',
- 'example' => '1040b91765d14ad1a40ff22589070342',
- ],
- 'BuyTime' => [
- 'description' => '购买时间。',
- 'type' => 'string',
- 'example' => '2024-04-29 15:01:15'."\n",
- ],
- 'ActivateTime' => [
- 'description' => '激活时间',
- 'type' => 'string',
- 'example' => '2024-04-29 15:03:12'."\n",
- ],
- 'ExpireTime' => [
- 'description' => '过期时间',
- 'type' => 'string',
- 'example' => '2025-05-01 00:00:00'."\n",
- ],
- 'Duration' => [
- 'description' => '授权时长',
- 'type' => 'string',
- 'example' => '1年',
- ],
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'activated',
- ],
- 'LicenseCode' => [
- 'description' => '授权码',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
- ],
- ],
- ],
+ 'description' => '系统数据,包含场站内各个系统的参数和历史数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SystemType' => [
+ 'description' => '系统类型,SystemType的取值可以是:'."\n"
+ ."\n"
+ .'- load: 市电'."\n"
+ .'- ess:储能'."\n"
+ .'- solar:光伏'."\n"
+ .'- hvac: 空调'."\n"
+ .'- flexible:照明'."\n"
+ .'- charge:充电桩',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['hvac' => 'hvac', 'charge' => 'charge', 'load' => 'load', 'ess' => 'ess', 'flexible' => 'flexible', 'solar' => 'solar'],
+ 'example' => 'ess',
+ ],
+ 'SystemId' => ['description' => '系统ID。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'SystemParams' => ['description' => '系统参数,各个类型的系统的参数值。', 'type' => 'object', 'required' => false, 'example' => '如光伏系统参数:{'."\n"
+ .' "sfktj": 0, //是否可调节:0-不可调 1-可调,一般光伏为 不可调'."\n"
+ .' "cfdfs": 0, //充放电方式:0-正放电负充电 1-负放电正充电'."\n"
+ .' "zjrl": "xxx", //装机容量'."\n"
+ .' }'],
+ 'HistoryData' => [
+ 'description' => '各系统的历史运行数据。',
+ 'type' => 'array',
+ 'items' => ['description' => '历史时段的运行数据。', 'type' => 'object', 'required' => false, 'example' => '如市电的历史数据:{'."\n"
+ .' "runTime": "2023-05-06 20:00:00",'."\n"
+ .' "pwr": 0.0, //总有功功率, 单位kW'."\n"
+ .' "qvr": 0.0, //总无功功率, 单位Var'."\n"
+ .' "sva": 0.0, //总视在功率, 单位VA'."\n"
+ .' "cos": 1, //总功率因数'."\n"
+ .' "fwdActngy": 0.0, //累计正向有功总电量, 单位kWh'."\n"
+ .' "rvsActngy": 0.0, //累计反相有功总电量, 单位kWh'."\n"
+ .' "demandpwr": 0.0 //正向有功总需量, 单位kW'."\n"
+ .' }'],
+ 'required' => false,
],
],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => 'None',
- ],
+ 'required' => false,
+ 'description' => '',
],
+ 'required' => false,
],
],
- ],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"LicenseSpecName\\": \\"边缘端1000型运行节点授权\\",\\n \\"BuyTime\\": \\"2024-04-29 15:01:15\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\",\\n \\"Fingerprint\\": \\"XXX\\",\\n \\"LicenseCode\\": \\"XXX\\",\\n \\"EffectTime\\": \\"2024-05-01 00:00:00\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\",\\n \\"Duration\\": \\"2个月9天\\",\\n \\"Status\\": \\"activated\\",\\n \\"AdaptiveMachine\\": \\"72核256G\\",\\n \\"LicenseSpecCode\\": \\"aics_1000\\",\\n \\"LicenseSpecType\\": \\"edge_license\\",\\n \\"CpuLimit\\": 72,\\n \\"MemoryLimit\\": 256,\\n \\"InstanceId\\": \\"c31238fcb74e482588a72de90cd7dba3\\",\\n \\"AllDuration\\": \\"1年\\",\\n \\"ApplicableSpecs\\": \\"72核256G\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"UnActivateAllDuration\\": \\"1个月\\",\\n \\"Proposal\\": \\"最大用量建议(72核256G)\\",\\n \\"ActivateRecord\\": [\\n {\\n \\"OrderId\\": \\"1040b91765d14ad1a40ff22589070342\\",\\n \\"BuyTime\\": \\"2024-04-29 15:01:15\\\\n\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\\\n\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\\\n\\",\\n \\"Duration\\": \\"1年\\",\\n \\"Status\\": \\"activated\\",\\n \\"LicenseCode\\": \\"XXXX\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
- 'title' => '获取授权',
- ],
- 'ActivateLicense' => [
- 'summary' => '激活License。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrialGARA6B',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'Id',
+ 'name' => 'ElecPrice',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
+ 'description' => '目标日期该天的市电分时价格变化,时间粒度与freq一致。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '目标日期该天某时刻的市电价格。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataTime' => ['description' => '一天内的时刻。', 'type' => 'string', 'required' => false, 'example' => '00:00:15'],
+ 'Price' => ['description' => '市电价格。', 'type' => 'string', 'required' => false, 'example' => '0.5'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '1',
],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'GenPrice',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '实例ID。',
- 'type' => 'string',
+ 'description' => '目标日期该天的售电上网价格的分时变化,时间粒度与freq一致。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '目标日期该天某时刻的售电价格。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataTime' => ['description' => '一天内的时刻。', 'type' => 'string', 'required' => false, 'example' => '00:00:15'],
+ 'Price' => ['description' => '售电价格。', 'type' => 'string', 'required' => false, 'example' => '0.3'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '12bea6b4489fsde7b903fe05934a0adx',
],
],
[
- 'name' => 'Fingerprint',
+ 'name' => 'Location',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '机器指纹',
- 'type' => 'string',
+ 'title' => '地址位置信息,经纬度',
+ 'description' => '地址位置信息,经纬度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Altitude' => ['title' => '海拔高度,精度到小数点后3位,默认值为10', 'description' => '海拔高度,精度到小数点后3位,默认值为10。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10.123'],
+ 'Latitude' => ['title' => '纬度,精度到小数点后3位', 'description' => '纬度,精度到小数点后3位。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '40.027'],
+ 'Longitude' => ['title' => '经度,精度到小数点后3位', 'description' => '经度,精度到小数点后3位。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '120.042'],
+ ],
'required' => false,
- 'example' => 'XXX',
],
],
[
- 'name' => 'OrderId',
+ 'name' => 'BusinessKey',
'in' => 'formData',
- 'schema' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XXX',
- ],
+ 'schema' => ['title' => '业务键', 'description' => '业务键。', 'type' => 'string', 'required' => false, 'example' => 'stationA'],
],
],
'responses' => [
@@ -966,214 +459,105 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '65308A66-8764-53EE-8D4A-201E86CA88C5',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
'Success' => [
- 'title' => '资源ID,如ECS实例的创建接口CreateInstance应返回InstanceId。',
+ 'title' => '是否调用成功。'."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。',
'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。',
'type' => 'string',
- 'example' => 'successful',
+ 'enumValueTitles' => ['True' => 'True', 'False' => 'False'],
+ 'example' => 'True',
],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '返回的结果',
+ 'title' => '返回JOB详细信息',
+ 'description' => '返回JOB详细信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => 'Id',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'LicenseSpecName' => [
- 'description' => 'license类型名称',
- 'type' => 'string',
- 'example' => '边缘端1000型运行节点授权',
- ],
- 'BuyTime' => [
- 'description' => '购买时间',
- 'type' => 'string',
- 'example' => '2024-04-29 15:00:15',
- ],
- 'ActivateTime' => [
- 'description' => '激活时间。',
- 'type' => 'string',
- 'example' => '2024-04-29 15:03:12',
- ],
- 'Fingerprint' => [
- 'description' => '机器指纹',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
- 'LicenseCode' => [
- 'description' => '授权码。',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'EffectTime' => [
- 'description' => '生效时间',
- 'type' => 'string',
- 'example' => '2024-05-01 00:00:00',
- ],
- 'ExpireTime' => [
- 'description' => '过期时间',
- 'type' => 'string',
- 'example' => '2025-05-01 00:00:00',
- ],
- 'Duration' => [
- 'description' => '已激活剩余时长',
- 'type' => 'string',
- 'example' => '2个月9天',
+ 'Completed' => ['title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。', 'description' => '操作是否完成,取值范围: '."\n"
+ .'- True:当前Job已经执行完成。 '."\n"
+ .'- False:当前Job还在执行中。', 'type' => 'boolean', 'example' => 'True'],
+ 'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-12-22 00:00:21'],
+ 'Error' => ['title' => '当前操作异常或者失败时的错误信息', 'description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => '""'],
+ 'JobId' => ['title' => '算法计算任务ID', 'description' => '算法计算任务ID。', 'type' => 'string', 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33'],
+ 'Progress' => ['title' => '进度', 'description' => '进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
+ 'Response' => [
+ 'title' => '计算任务的结果',
+ 'description' => '计算任务的结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DebugInfo' => ['title' => '调试信息', 'description' => '调试信息。', 'type' => 'any', 'example' => '{}'],
+ 'JobType' => [
+ 'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
+ 'description' => '计算任务类型,枚举值:'."\n"
+ .'- LoadForecast:负荷预测。'."\n"
+ .'- PowerForecast:功率预测。'."\n"
+ .'- EssOptStrategy:储能优化。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['EssOptStrategy' => 'EssOptStrategy', 'LoadForecast' => 'LoadForecast', 'PowerForecast' => 'PowerForecast'],
+ 'example' => 'EssOptStrategy',
+ ],
+ 'Result' => ['title' => '计算任务的结果', 'description' => '计算任务的结果。', 'type' => 'any', 'example' => '{}'],
+ ],
],
'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'activated',
- ],
- 'CpuLimit' => [
- 'description' => '限制的CPU核数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '72',
- ],
- 'MemoryLimit' => [
- 'description' => 'memory 上限(GB)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '256',
- ],
- 'InstanceId' => [
- 'description' => '实例ID',
- 'type' => 'string',
- 'example' => 'c39128fcb74e482546a72de90cdsaba3',
- ],
- 'AllDuration' => [
- 'description' => '已激活总时长',
- 'type' => 'string',
- 'example' => '1年',
- ],
- 'ApplicableSpecs' => [
- 'description' => '适用规格',
- 'type' => 'string',
- 'example' => '72核256G',
- ],
- 'Description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'UnActivateAllDuration' => [
- 'description' => '未激活时长',
+ 'title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL',
+ 'description' => '任务状态,枚举值: '."\n"
+ .'- RUNNING'."\n"
+ .'- SUCCESS'."\n"
+ .'- FAIL',
'type' => 'string',
- 'example' => '1个月',
- ],
- 'ActivateRecord' => [
- 'description' => '激活记录',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'BuyTime' => [
- 'description' => '购买时间。',
- 'type' => 'string',
- 'example' => '2024-04-29 15:01:15',
- ],
- 'ActivateTime' => [
- 'description' => '激活时间',
- 'type' => 'string',
- 'example' => '2024-04-29 15:03:12',
- ],
- 'ExpireTime' => [
- 'description' => '过期时间。',
- 'type' => 'string',
- 'example' => '2025-05-01 00:00:00',
- ],
- 'Duration' => [
- 'description' => '时长',
- 'type' => 'string',
- 'example' => '1年',
- ],
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'activated',
- ],
- 'LicenseCode' => [
- 'description' => '激活码',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- ],
- ],
+ 'enumValueTitles' => ['SUCCESS' => 'SUCCESS', 'RUNNING' => 'RUNNING', 'FAIL' => 'FAIL'],
+ 'example' => 'RUNNING',
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情',
- 'type' => 'string',
- 'example' => '{}',
- ],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
+ ['errorCode' => 'NoNormalResource', 'errorMessage' => 'There is no normal resource.', 'description' => '无可用资源'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 25,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"EssOptStrategy\\",\\n \\"Result\\": \\"{}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
+ 'title' => '创建储能优化任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-28T07:25:20.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2025-07-23T14:04:47.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreateEssOptJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65308A66-8764-53EE-8D4A-201E86CA88C5\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Id\\": \\"1\\",\\n \\"LicenseSpecName\\": \\"边缘端1000型运行节点授权\\",\\n \\"BuyTime\\": \\"2024-04-29 15:00:15\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\",\\n \\"Fingerprint\\": \\"XXXX\\",\\n \\"LicenseCode\\": \\"XXX\\",\\n \\"EffectTime\\": \\"2024-05-01 00:00:00\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\",\\n \\"Duration\\": \\"2个月9天\\",\\n \\"Status\\": \\"activated\\",\\n \\"CpuLimit\\": 72,\\n \\"MemoryLimit\\": 256,\\n \\"InstanceId\\": \\"c39128fcb74e482546a72de90cdsaba3\\",\\n \\"AllDuration\\": \\"1年\\",\\n \\"ApplicableSpecs\\": \\"72核256G\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"UnActivateAllDuration\\": \\"1个月\\",\\n \\"ActivateRecord\\": [\\n {\\n \\"OrderId\\": \\"XXX\\",\\n \\"BuyTime\\": \\"2024-04-29 15:01:15\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\",\\n \\"Duration\\": \\"1年\\",\\n \\"Status\\": \\"activated\\",\\n \\"LicenseCode\\": \\"XXX\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => '激活授权',
],
- 'UpdateLicenseDescription' => [
- 'summary' => '更新授权描述。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateLoadForecastByFileUrlJob' => [
+ 'summary' => '创建用电负荷预测任务,历史数据来自文件url。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1182,182 +566,131 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrialGARA6B',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREbrainindustrial1ZR6M2'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'DeviceType',
'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '实例id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'brainindustrial_aicsruntime_public_cn-mdu3ps3kw04',
- ],
+ 'schema' => ['title' => '设备类型,每个systemType支持的设备类型有:系统类型:设备类型 load: electricityMeter --市电电表 hvac: gateway-hvac --空调 flexible: electricityMeter --照明电表 charge'."\0".':gateway-charging --充电桩', 'description' => '设备类型,每个系统类型支持的设备类型有: '."\n"
+ ."\n"
+ .'- load: electricityMeter --市电电表'."\n"
+ .'- hvac: gateway-hvac --空调'."\n"
+ .'- flexible: electricityMeter --照明电表'."\n"
+ .'- charge:gateway-charging --充电桩', 'type' => 'string', 'required' => false, 'example' => 'electricityMeter', 'default' => 'electricityMeter'],
],
[
- 'name' => 'Description',
+ 'name' => 'HistoryUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '历史数据csv文件url地址', 'description' => '历史数据csv文件url地址,在调用期间地址需要公网可访问。', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/dir/target_file.csv'],
+ ],
+ [
+ 'name' => 'Freq',
'in' => 'formData',
'schema' => [
- 'description' => '授权描述',
+ 'title' => '默认15min;需要与historyData的数据频率一致;枚举值:'."\n"
+ .'FIFTEEN_MIN: 15分钟'."\n"
+ .'FIVE_MIN: 5分钟'."\n"
+ .'ONE_HOUR: 1小时'."\n"
+ .'ONE_DAY: 1天',
+ 'description' => '默认值为FIFTEEN_MIN;需要与历史数据的数据频率一致;'."\n"
+ .'- FIFTEEN_MIN: 15分钟'."\n"
+ .'- FIVE_MIN: 5分钟'."\n"
+ .'- ONE_HOUR: 1小时'."\n"
+ .'- ONE_DAY: 1天',
'type' => 'string',
'required' => false,
- 'example' => '华新水泥-阳江厂授权',
+ 'example' => 'FIFTEEN_MIN',
+ 'default' => 'FIFTEEN_MIN',
+ 'enum' => ['FIFTEEN_MIN', 'FIVE_MIN', 'ONE_HOUR', 'ONE_DAY'],
],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- ],
- ],
+ [
+ 'name' => 'Duration',
+ 'in' => 'formData',
+ 'schema' => ['title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
+ .'非必填,默认1天', 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
+ ."\n"
+ .'非必填,默认1天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
- ],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
+ [
+ 'name' => 'SystemType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '系统类型,支持的系统类型有: load: 市电 hvac: 空调 flexible:照明 charge:充电桩', 'description' => '系统类型,支持的系统类型有: '."\n"
+ .'- load: 市电 '."\n"
+ .'- hvac: 空调 '."\n"
+ .'- flexible:照明 '."\n"
+ .'- charge:充电桩', 'type' => 'string', 'required' => false, 'example' => 'load', 'default' => 'load'],
],
- 500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ [
+ 'name' => 'RunDate',
+ 'in' => 'formData',
+ 'schema' => ['title' => '运行日,精确到天,“yyyy-MM-dd”格式', 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。', 'type' => 'string', 'required' => false, 'example' => '2025-01-01'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"True\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
- 'title' => '更新授权描述',
- 'description' => '更新授权描述',
- ],
- 'ListAivppResources' => [
- 'summary' => '获取用户AIVPP资源列表。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'TimeZone',
+ 'in' => 'formData',
+ 'schema' => ['title' => '时区,默认上海时区:Asia/Shanghai', 'description' => '时区,默认上海时区:Asia/Shanghai。', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'."\n", 'default' => 'Asia/Shanghai'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrial1ZR6M2',
+ [
+ 'name' => 'ModelVersion',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本', 'description' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本。', 'type' => 'string', 'required' => false, 'example' => 'latest', 'default' => 'latest'],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'MaxResults',
+ 'name' => 'BusinessKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页返回数据量,默认为20',
- 'description' => '每页返回数据量,默认为20',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['title' => '业务键,如场站名称编号等。', 'description' => '业务键,如场站名称编号等。', 'type' => 'string', 'required' => false, 'example' => 'stationA'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'TimeColumn',
+ 'in' => 'formData',
+ 'schema' => ['title' => '时间列', 'description' => '历史数据csv文件中的时间列,时间列需要符合 yyyy-MM-dd HH:mm:SS格式,数据频率需要与freq字段对齐。', 'type' => 'string', 'required' => false, 'example' => 'runTime'],
+ ],
+ [
+ 'name' => 'ValueColumn',
+ 'in' => 'formData',
+ 'schema' => ['title' => '值列', 'description' => '历史数据csv文件中的值列,需要为数值类型。', 'type' => 'string', 'required' => false, 'example' => 'value'],
+ ],
+ [
+ 'name' => 'ForecastHorizon',
'in' => 'formData',
'schema' => [
- 'title' => '当前页,默认为1',
- 'description' => '当前页,默认为1',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '预测时间跨度。'."\n"
+ .'可取枚举值:'."\n"
+ .'- 日前预测:DAY_AHEAD'."\n"
+ .'- 日内预测:INTRADAY',
+ 'description' => '预测时间跨度。'."\n"
+ .'可取枚举值:'."\n"
+ .'- DAY_AHEAD:日前预测'."\n"
+ .'- INTRADAY:日内预测',
+ 'type' => 'string',
'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
+ 'example' => 'DAY_AHEAD',
+ 'default' => 'DAY_AHEAD',
+ 'enum' => ['DAY_AHEAD', 'INTRADAY'],
],
],
[
- 'name' => 'InstanceType',
+ 'name' => 'DataMode',
'in' => 'formData',
'schema' => [
- 'title' => '实例类型'."\n"
- .'API: API类型'."\n"
- .'DATA: 时序数据类型',
- 'description' => '实例类型'."\n"
- .'API: API类型'."\n"
- .'DATA: 时序数据类型',
+ 'title' => '本次调用的数据模式,枚举值:'."\n"
+ .'FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
+ .'INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
+ 'description' => '本次调用的数据模式,枚举值:'."\n"
+ .'- FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
+ .'- INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
'type' => 'string',
'required' => false,
- 'example' => 'DATA',
- 'default' => 'API',
- 'enum' => [
- 'API',
- 'DATA',
- ],
+ 'example' => 'FULL',
+ 'default' => 'FULL',
+ 'enum' => ['FULL', 'INCREMENTAL'],
],
],
],
@@ -1368,182 +701,92 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'Success' => [
- 'title' => '是否调用成功。'."\n"
- ."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
+ 'Success' => ['title' => '是否调用成功。'."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'description' => '是否调用成功。'."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'type' => 'string', 'example' => 'True'],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '分组列表。',
- 'description' => '分组列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => '分组列表。',
- 'description' => '分组列表。',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'title' => '资源实例id',
- 'description' => '资源实例id',
- 'type' => 'string',
- 'example' => 'i-bp154xh3gt3adb4xu1ue',
- ],
- 'Specification' => [
- 'title' => '规格',
- 'description' => '规格',
- 'type' => 'string',
- 'example' => 'LoadForecasting',
- ],
- 'OrderId' => [
- 'title' => '订单id',
- 'description' => '订单id',
- 'type' => 'string',
- 'example' => '231287932080007',
- ],
- 'UserId' => [
- 'title' => '用户id',
- 'description' => '用户id',
- 'type' => 'string',
- 'example' => '123456789',
- ],
- 'Quantity' => [
- 'title' => '资源规格总调用次数',
- 'description' => '资源规格总调用次数',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'LeftQuantity' => [
- 'title' => '剩下可调用次数',
- 'description' => '剩下可调用次数',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Status' => [
- 'title' => '状态',
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'StartTime' => [
- 'title' => '开通日期',
- 'description' => '开通日期',
- 'type' => 'string',
- 'example' => '2024-09-08T01:16Z',
- ],
- 'ExpireTime' => [
- 'title' => '失效日期',
- 'description' => '失效日期',
- 'type' => 'string',
- 'example' => '2034-03-09T17:47:11Z',
- ],
- 'InstanceType' => [
- 'description' => '商品类型',
- 'type' => 'string',
- 'example' => 'api',
- ],
- 'Detail' => [
- 'description' => '规格详情',
- 'type' => 'string',
- 'example' => '规格: LoadForecasting,api数量:50',
- ],
- 'ConnectNum' => [
- 'title' => '时序数据规格:在线设备数',
- 'description' => '时序数据规格:在线设备数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10000',
- ],
- 'MessageTps' => [
- 'title' => '时序数据规格:消息TPS',
- 'description' => '时序数据规格:消息TPS',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
+ 'title' => '返回JOB详细信息',
+ 'description' => '返回JOB详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Completed' => ['title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。', 'description' => '操作是否完成,取值范围: '."\n"
+ .'- True:当前Job已经执行完成。'."\n"
+ .'- False:当前Job还在执行中。', 'type' => 'boolean', 'example' => 'True'],
+ 'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-12-22 00:00:21'],
+ 'Error' => ['title' => '当前操作异常或者失败时的错误信息', 'description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => '""'],
+ 'JobId' => ['title' => '算法计算任务ID', 'description' => '算法计算任务id。', 'type' => 'string', 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33'],
+ 'Progress' => ['title' => '进度', 'description' => '进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Response' => [
+ 'title' => '计算任务的结果',
+ 'description' => '计算任务的结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DebugInfo' => ['title' => '调试信息', 'description' => '调试信息。', 'type' => 'any', 'example' => 'null'],
+ 'JobType' => [
+ 'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
+ 'description' => '计算任务类型,枚举值:'."\n"
+ .'- LoadForecast:负荷预测。'."\n"
+ .'- PowerForecast:功率预测。'."\n"
+ .'- EssOptStrategy:储能优化。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['EssOptStrategy' => 'EssOptStrategy', 'LoadForecast' => 'LoadForecast', 'PowerForecast' => 'PowerForecast'],
+ 'example' => 'PowerForecast',
+ ],
+ 'Result' => ['title' => '计算任务的结果', 'description' => '计算任务的结果。', 'type' => 'any', 'example' => '{"runTime": \'2025-01-01 00:00:00\', "value": 0.0}'],
],
],
+ 'Status' => ['title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL', 'description' => '任务状态,枚举值:'."\n"
+ .'- RUNNING:运行中。'."\n"
+ .'- SUCCESS:运行成功。'."\n"
+ .'- FAIL:运行失败。', 'type' => 'string', 'example' => 'RUNNING'],
],
],
- 'MaxResults' => [
- 'title' => '分批次查询时每次显示的条目数。取值范围:1~100,默认值:20。',
- 'description' => '分批次查询时每次显示的条目数。取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'NextToken' => [
- 'title' => '下一个查询开始的Token。',
- 'description' => '下一个查询开始的Token。',
- 'type' => 'string',
- 'example' => '37cc36b4344b182d36b45d95ae4ef03952ee5c24733ba461',
- ],
- 'TotalCount' => [
- 'title' => '总个数。',
- 'description' => '总个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
+ ['errorCode' => 'NoNormalResource', 'errorMessage' => 'There is no normal resource.', 'description' => '无可用资源'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 100,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"null\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{\\\\\\"runTime\\\\\\": \'2025-01-01 00:00:00\', \\\\\\"value\\\\\\": 0.0}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
+ 'title' => '通过文件URL创建负荷预测任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-10-17T04:03:47.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreateLoadForecastByFileUrlJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"i-bp154xh3gt3adb4xu1ue\\",\\n \\"Specification\\": \\"LoadForecasting\\",\\n \\"OrderId\\": \\"231287932080007\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"Quantity\\": \\"1\\",\\n \\"LeftQuantity\\": \\"1\\",\\n \\"Status\\": \\"Normal\\",\\n \\"StartTime\\": \\"2024-09-08T01:16Z\\",\\n \\"ExpireTime\\": \\"2034-03-09T17:47:11Z\\",\\n \\"InstanceType\\": \\"api\\",\\n \\"Detail\\": \\"规格: LoadForecasting,api数量:50\\",\\n \\"ConnectNum\\": 10000,\\n \\"MessageTps\\": 500\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"37cc36b4344b182d36b45d95ae4ef03952ee5c24733ba461\\",\\n \\"TotalCount\\": 30\\n}","type":"json"}]',
- 'title' => '查询AIVPP资源列表',
],
'CreateLoadForecastJob' => [
'summary' => '创建用电负荷预测任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1555,9 +798,7 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrial1ZR6M2',
- ],
+ 'abilityTreeNodes' => ['FEATUREbrainindustrial1ZR6M2'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1580,12 +821,7 @@
.'- charge:gateway-charging --充电桩',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'hvac' => 'hvac',
- 'charge' => 'charge',
- 'load' => 'load',
- 'flexible' => 'flexible',
- ],
+ 'enumValueTitles' => ['hvac' => 'hvac', 'charge' => 'charge', 'load' => 'load', 'flexible' => 'flexible'],
'example' => 'electricityMeter',
'default' => 'electricityMeter',
],
@@ -1601,23 +837,11 @@
'items' => [
'type' => 'object',
'properties' => [
- 'RunTime' => [
- 'title' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐',
- 'description' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-12-12 00:00:00',
- ],
- 'Value' => [
- 'title' => '负荷数据',
- 'description' => '负荷数据。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '1.0',
- ],
+ 'RunTime' => ['title' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐', 'description' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐。', 'type' => 'string', 'required' => false, 'example' => '2025-12-12 00:00:00'],
+ 'Value' => ['title' => '负荷数据', 'description' => '负荷数据。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
'maxItems' => 100000,
@@ -1643,28 +867,16 @@
'required' => false,
'example' => 'FIFTEEN_MIN',
'default' => 'FIFTEEN_MIN',
- 'enum' => [
- 'FIFTEEN_MIN',
- 'FIVE_MIN',
- 'ONE_HOUR',
- 'ONE_DAY',
- ],
+ 'enum' => ['FIFTEEN_MIN', 'FIVE_MIN', 'ONE_HOUR', 'ONE_DAY'],
],
],
[
'name' => 'Duration',
'in' => 'formData',
- 'schema' => [
- 'title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
- .'非必填,默认1天',
- 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
- ."\n"
- .'非必填,默认1天。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
+ .'非必填,默认1天', 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
+ ."\n"
+ .'非必填,默认1天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'SystemType',
@@ -1679,12 +891,7 @@
.'- charge:充电桩',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'hvac' => 'hvac',
- 'charge' => 'charge',
- 'load' => 'load',
- 'flexible' => 'flexible',
- ],
+ 'enumValueTitles' => ['hvac' => 'hvac', 'charge' => 'charge', 'load' => 'load', 'flexible' => 'flexible'],
'example' => 'load',
'default' => 'load',
],
@@ -1692,48 +899,22 @@
[
'name' => 'RunDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '运行日,精确到天,“yyyy-MM-dd”格式',
- 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-12-12',
- ],
+ 'schema' => ['title' => '运行日,精确到天,“yyyy-MM-dd”格式', 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。', 'type' => 'string', 'required' => false, 'example' => '2025-12-12'],
],
[
'name' => 'TimeZone',
'in' => 'formData',
- 'schema' => [
- 'title' => '时区,默认上海时区:Asia/Shanghai',
- 'description' => '时区,默认上海时区:Asia/Shanghai。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Asia/Shanghai',
- 'default' => 'Asia/Shanghai',
- ],
+ 'schema' => ['title' => '时区,默认上海时区:Asia/Shanghai', 'description' => '时区,默认上海时区:Asia/Shanghai。', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', 'default' => 'Asia/Shanghai'],
],
[
'name' => 'ModelVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本',
- 'description' => '模型对应的版本号,默认为latest。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'latest',
- 'default' => 'latest',
- ],
+ 'schema' => ['title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本', 'description' => '模型对应的版本号,默认为latest。', 'type' => 'string', 'required' => false, 'example' => 'latest', 'default' => 'latest'],
],
[
'name' => 'BusinessKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务键,如场站名称编号等。',
- 'description' => '业务键,如场站名称编号等。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'stationA',
- ],
+ 'schema' => ['title' => '业务键,如场站名称编号等。', 'description' => '业务键,如场站名称编号等。', 'type' => 'string', 'required' => false, 'example' => 'stationA'],
],
[
'name' => 'ForecastHorizon',
@@ -1749,10 +930,7 @@
'required' => false,
'example' => 'DAY_AHEAD',
'default' => 'DAY_AHEAD',
- 'enum' => [
- 'DAY_AHEAD',
- 'INTRADAY',
- ],
+ 'enum' => ['DAY_AHEAD', 'INTRADAY'],
],
],
[
@@ -1769,10 +947,7 @@
'required' => false,
'example' => 'FULL',
'default' => 'FULL',
- 'enum' => [
- 'FULL',
- 'INCREMENTAL',
- ],
+ 'enum' => ['FULL', 'INCREMENTAL'],
],
],
],
@@ -1783,12 +958,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
'Success' => [
'title' => '是否调用成功。'."\n"
.'- **True**:调用成功。'."\n"
@@ -1797,28 +967,15 @@
.'- **True**:调用成功。'."\n"
.'- **False**:调用失败。',
'type' => 'string',
- 'enumValueTitles' => [
- 'True' => 'True',
- 'False' => 'False',
- ],
+ 'enumValueTitles' => ['True' => 'True', 'False' => 'False'],
'example' => 'True',
],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'title' => '返回JOB详细信息',
'description' => '返回JOB详细信息。',
@@ -1830,48 +987,19 @@
.'- True:当前Job已经执行完成。 '."\n"
.'- False:当前Job还在执行中。',
'type' => 'boolean',
- 'enumValueTitles' => [
- 'True' => 'True',
- 'False' => 'False',
- ],
+ 'enumValueTitles' => ['True' => 'True', 'False' => 'False'],
'example' => 'True',
],
- 'CreateTime' => [
- 'title' => '任务创建时间',
- 'description' => '任务创建时间。',
- 'type' => 'string',
- 'example' => '2024-12-22 00:00:21',
- ],
- 'Error' => [
- 'title' => '当前操作异常或者失败时的错误信息',
- 'description' => '当前操作异常或者失败时的错误信息。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'JobId' => [
- 'title' => '算法计算任务ID',
- 'description' => '算法计算任务ID。',
- 'type' => 'string',
- 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33',
- ],
- 'Progress' => [
- 'title' => '进度',
- 'description' => '进度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- ],
+ 'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-12-22 00:00:21'],
+ 'Error' => ['title' => '当前操作异常或者失败时的错误信息', 'description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => '""'],
+ 'JobId' => ['title' => '算法计算任务ID', 'description' => '算法计算任务ID。', 'type' => 'string', 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33'],
+ 'Progress' => ['title' => '进度', 'description' => '进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
'Response' => [
'title' => '计算任务的结果',
'description' => '计算任务的结果。',
'type' => 'object',
'properties' => [
- 'DebugInfo' => [
- 'title' => '调试信息',
- 'description' => '调试信息。',
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'DebugInfo' => ['title' => '调试信息', 'description' => '调试信息。', 'type' => 'any', 'example' => '{}'],
'JobType' => [
'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
'description' => '计算任务类型,枚举值:'."\n"
@@ -1879,19 +1007,10 @@
.'- PowerForecast:功率预测。'."\n"
.'- EssOptStrategy:储能优化。',
'type' => 'string',
- 'enumValueTitles' => [
- 'EssOptStrategy' => 'EssOptStrategy',
- 'LoadForecast' => 'LoadForecast',
- 'PowerForecast' => 'PowerForecast',
- ],
+ 'enumValueTitles' => ['EssOptStrategy' => 'EssOptStrategy', 'LoadForecast' => 'LoadForecast', 'PowerForecast' => 'PowerForecast'],
'example' => 'LoadForecast',
],
- 'Result' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果。',
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'Result' => ['title' => '计算任务的结果', 'description' => '计算任务的结果。', 'type' => 'any', 'example' => '{}'],
],
],
'Status' => [
@@ -1901,11 +1020,7 @@
.'- SUCCESS'."\n"
.'- FAIL',
'type' => 'string',
- 'enumValueTitles' => [
- 'SUCCESS' => 'SUCCESS',
- 'RUNNING' => 'RUNNING',
- 'FAIL' => 'FAIL',
- ],
+ 'enumValueTitles' => ['SUCCESS' => 'SUCCESS', 'RUNNING' => 'RUNNING', 'FAIL' => 'FAIL'],
'example' => 'RUNNING',
],
],
@@ -1916,36 +1031,39 @@
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
- [
- 'errorCode' => 'NoNormalResource',
- 'errorMessage' => 'There is no normal resource.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
+ ['errorCode' => 'NoNormalResource', 'errorMessage' => 'There is no normal resource.', 'description' => '无可用资源'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 25,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"LoadForecast\\",\\n \\"Result\\": \\"{}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
'title' => '创建负荷预测任务',
- ],
- 'CreatePowerForecastJob' => [
- 'summary' => '创建发电功率预测任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-10-17T04:03:47.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-28T07:25:20.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2025-07-23T14:04:47.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreateLoadForecastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreatePowerForecastByFileUrlJob' => [
+ 'summary' => '创建发电功率预测任务,历史数据来自文件url。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1957,9 +1075,7 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrial1ZR6M2',
- ],
+ 'abilityTreeNodes' => ['FEATUREbrainindustrial1ZR6M2'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1969,51 +1085,20 @@
'in' => 'formData',
'schema' => [
'title' => '设备类型,每个systemType支持的设备类型有:系统类型:设备类型 load: electricityMeter --市电电表 hvac: gateway-hvac --空调 flexible: electricityMeter --照明电表 charge'."\0".':gateway-charging --充电桩',
- 'description' => '设备类型,每个systemType支持的设备类型有:'."\n"
- ."\n"
- .'系统类型:设备类型'."\n"
- ."\n"
- .'- solar: solarInverter --光伏逆变器'."\n"
- .'- wind: windTurbine --风电发电机',
+ 'description' => '设备类型,每个系统类型支持的设备类型有:'."\n"
+ .'- solar: solarInverter --光伏逆变器'."\n"
+ .'- wind: windTurbine--风电发电机',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => ['solarInverter' => 'solarInverter'],
'example' => 'solarInverter',
'default' => 'solarInverter',
],
],
[
- 'name' => 'HistoryData',
+ 'name' => 'HistoryUrl',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '历史负荷,需要90天的历史数据',
- 'description' => '历史负荷,需要90天的历史数据。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RunTime' => [
- 'title' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐',
- 'description' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-02-12 00:00:00',
- ],
- 'Value' => [
- 'title' => '负荷数据',
- 'description' => '负荷数据。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '1.0',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100000,
- 'minItems' => 1,
- ],
+ 'schema' => ['title' => '历史数据csv文件url地址', 'description' => '历史数据csv文件url地址,在调用期间地址需要公网可访问。', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/dir/target_file.csv'],
],
[
'name' => 'Freq',
@@ -2024,8 +1109,7 @@
.'FIVE_MIN: 5分钟'."\n"
.'ONE_HOUR: 1小时'."\n"
.'ONE_DAY: 1天',
- 'description' => '默认15min;需要与historyData的数据频率一致;枚举值:'."\n"
- ."\n"
+ 'description' => '默认值为FIFTEEN_MIN;需要与历史数据的数据频率一致;枚举值:'."\n"
.'- FIFTEEN_MIN: 15分钟'."\n"
.'- FIVE_MIN: 5分钟'."\n"
.'- ONE_HOUR: 1小时'."\n"
@@ -2034,40 +1118,28 @@
'required' => false,
'example' => 'FIFTEEN_MIN',
'default' => 'FIFTEEN_MIN',
- 'enum' => [
- 'FIFTEEN_MIN',
- 'FIVE_MIN',
- 'ONE_HOUR',
- 'ONE_DAY',
- ],
+ 'enum' => ['FIFTEEN_MIN', 'FIVE_MIN', 'ONE_HOUR', 'ONE_DAY'],
],
],
[
'name' => 'Duration',
'in' => 'formData',
- 'schema' => [
- 'title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
- .'非必填,默认1天',
- 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
- ."\n"
- .'非必填,默认1天。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
+ .'非必填,默认1天', 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
+ ."\n"
+ .'非必填,默认1天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'SystemType',
'in' => 'formData',
'schema' => [
'title' => '系统类型,支持的系统类型有: solar: 光伏 wind: 风电',
- 'description' => '系统类型,支持的系统类型有:'."\n"
- ."\n"
+ 'description' => '系统类型,支持的系统类型有: '."\n"
.'- solar: 光伏'."\n"
.'- wind: 风电',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => ['solar' => 'solar'],
'example' => 'solar',
'default' => 'solar',
],
@@ -2075,37 +1147,17 @@
[
'name' => 'RunDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '运行日,精确到天,“yyyy-MM-dd”格式',
- 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-02-12',
- ],
+ 'schema' => ['title' => '运行日,精确到天,“yyyy-MM-dd”格式', 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。', 'type' => 'string', 'required' => false, 'example' => '2025-01-01'],
],
[
'name' => 'TimeZone',
'in' => 'formData',
- 'schema' => [
- 'title' => '时区,默认上海时区:Asia/Shanghai',
- 'description' => '时区,默认上海时区:Asia/Shanghai。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Asia/Shanghai'."\n",
- 'default' => 'Asia/Shanghai',
- ],
+ 'schema' => ['title' => '时区,默认上海时区:Asia/Shanghai', 'description' => '时区,默认上海时区:Asia/Shanghai。', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', 'default' => 'Asia/Shanghai'],
],
[
'name' => 'ModelVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本',
- 'description' => '模型对应的版本号,默认为latest。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'latest',
- 'default' => 'latest',
- ],
+ 'schema' => ['title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本', 'description' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本。', 'type' => 'string', 'required' => false, 'example' => 'latest', 'default' => 'latest'],
],
[
'name' => 'Location',
@@ -2116,30 +1168,9 @@
'description' => '地址位置信息,经纬度。',
'type' => 'object',
'properties' => [
- 'Altitude' => [
- 'title' => '海拔高度,精度到小数点后3位,默认值为10',
- 'description' => '海拔高度,精度到小数点后3位,默认值为10。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '10.123',
- ],
- 'Latitude' => [
- 'title' => '纬度,精度到小数点后3位',
- 'description' => '纬度,精度到小数点后3位。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '40.027',
- ],
- 'Longitude' => [
- 'title' => '经度,精度到小数点后3位',
- 'description' => '经度,精度到小数点后3位。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '120.042',
- ],
+ 'Altitude' => ['title' => '海拔高度,精度到小数点后3位,默认值为10', 'description' => '海拔高度,精度到小数点后3位,默认值为10。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10.123'],
+ 'Latitude' => ['title' => '纬度,精度到小数点后3位', 'description' => '纬度,精度到小数点后3位。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '40.027'],
+ 'Longitude' => ['title' => '经度,精度到小数点后3位', 'description' => '经度,精度到小数点后3位。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '120.042'],
],
'required' => false,
],
@@ -2147,13 +1178,17 @@
[
'name' => 'BusinessKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务键,如场站名称编号',
- 'description' => '业务键,如场站名称编号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'stationA',
- ],
+ 'schema' => ['title' => '业务键,如场站名称编号', 'description' => '业务键,如场站名称编号。', 'type' => 'string', 'required' => false, 'example' => 'stationA'],
+ ],
+ [
+ 'name' => 'TimeColumn',
+ 'in' => 'formData',
+ 'schema' => ['title' => '时间列', 'description' => '历史数据csv文件中的时间列,时间列需要符合 yyyy-MM-dd HH:mm:SS格式,数据频率需要与freq字段对齐。', 'type' => 'string', 'required' => false, 'example' => 'runTime'],
+ ],
+ [
+ 'name' => 'ValueColumn',
+ 'in' => 'formData',
+ 'schema' => ['title' => '值列', 'description' => '历史数据csv文件中的值列,需要为数值类型。', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
[
'name' => 'ForecastHorizon',
@@ -2169,10 +1204,7 @@
'required' => false,
'example' => 'DAY_AHEAD',
'default' => 'DAY_AHEAD',
- 'enum' => [
- 'DAY_AHEAD',
- 'INTRADAY',
- ],
+ 'enum' => ['DAY_AHEAD', 'INTRADAY'],
],
],
[
@@ -2189,10 +1221,7 @@
'required' => false,
'example' => 'FULL',
'default' => 'FULL',
- 'enum' => [
- 'FULL',
- 'INCREMENTAL',
- ],
+ 'enum' => ['FULL', 'INCREMENTAL'],
],
],
],
@@ -2203,95 +1232,36 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'Success' => [
- 'title' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'description' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'True' => 'True',
- 'False' => 'False',
- ],
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
+ 'Success' => ['title' => '是否调用成功。'."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'description' => '是否调用成功。'."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'type' => 'string', 'example' => 'True'],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'title' => '返回JOB详细信息',
- 'description' => '返回JOB详细信息',
+ 'description' => '返回JOB详细信息。',
'type' => 'object',
'properties' => [
- 'Completed' => [
- 'title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。',
- 'description' => '操作是否完成,取值范围: '."\n"
- .'- True:当前Job已经执行完成。 '."\n"
- .'- False:当前Job还在执行中。',
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'True' => 'True',
- 'False' => 'False',
- ],
- 'example' => 'True',
- ],
- 'CreateTime' => [
- 'title' => '任务创建时间',
- 'description' => '任务创建时间。',
- 'type' => 'string',
- 'example' => '2024-12-22 00:00:21',
- ],
- 'Error' => [
- 'title' => '当前操作异常或者失败时的错误信息',
- 'description' => '当前操作异常或者失败时的错误信息。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'JobId' => [
- 'title' => '算法计算任务ID',
- 'description' => '算法计算任务ID。',
- 'type' => 'string',
- 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33',
- ],
- 'Progress' => [
- 'title' => '进度',
- 'description' => '进度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- ],
+ 'Completed' => ['title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。', 'description' => '操作是否完成,取值范围: '."\n"
+ .'- True:当前Job已经执行完成。'."\n"
+ .'- False:当前Job还在执行中。', 'type' => 'boolean', 'example' => 'True'],
+ 'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-12-22 00:00:21'],
+ 'Error' => ['title' => '当前操作异常或者失败时的错误信息', 'description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => '""'],
+ 'JobId' => ['title' => '算法计算任务ID', 'description' => '算法计算任务id。', 'type' => 'string', 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33'],
+ 'Progress' => ['title' => '进度', 'description' => '进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Response' => [
'title' => '计算任务的结果',
'description' => '计算任务的结果。',
'type' => 'object',
'properties' => [
- 'DebugInfo' => [
- 'title' => '调试信息',
- 'description' => '调试信息。',
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'DebugInfo' => ['title' => '调试信息', 'description' => '调试信息。', 'type' => 'any', 'example' => '{}'],
'JobType' => [
'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
'description' => '计算任务类型,枚举值:'."\n"
@@ -2299,35 +1269,16 @@
.'- PowerForecast:功率预测。'."\n"
.'- EssOptStrategy:储能优化。',
'type' => 'string',
- 'enumValueTitles' => [
- 'EssOptStrategy' => 'EssOptStrategy',
- 'LoadForecast' => 'LoadForecast',
- 'PowerForecast' => 'PowerForecast',
- ],
+ 'enumValueTitles' => ['EssOptStrategy' => 'EssOptStrategy', 'LoadForecast' => 'LoadForecast', 'PowerForecast' => 'PowerForecast'],
'example' => 'PowerForecast',
],
- 'Result' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果。',
- 'type' => 'any',
- 'example' => '{}',
- ],
- ],
- ],
- 'Status' => [
- 'title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL',
- 'description' => '任务状态,枚举值:'."\n"
- .'- RUNNING:运行中。'."\n"
- .'- SUCCESS:运行成功。'."\n"
- .'- FAIL:运行失败。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'SUCCESS' => 'SUCCESS',
- 'RUNNING' => 'RUNNING',
- 'FAIL' => 'FAIL',
+ 'Result' => ['title' => '计算任务的结果', 'description' => '计算任务的结果。', 'type' => 'any', 'example' => '{"runTime": \'2025-01-01 00:00:00\', "value": 0.0}'],
],
- 'example' => 'RUNNING',
],
+ 'Status' => ['title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL', 'description' => '任务状态,枚举值:'."\n"
+ .'- RUNNING:运行中。'."\n"
+ .'- SUCCESS:运行成功。'."\n"
+ .'- FAIL:运行失败。', 'type' => 'string', 'example' => 'RUNNING'],
],
],
],
@@ -2336,36 +1287,37 @@
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
- [
- 'errorCode' => 'NoNormalResource',
- 'errorMessage' => 'There is no normal resource.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
+ ['errorCode' => 'NoNormalResource', 'errorMessage' => 'There is no normal resource.', 'description' => '无可用资源'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 100,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{\\\\\\"runTime\\\\\\": \'2025-01-01 00:00:00\', \\\\\\"value\\\\\\": 0.0}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
+ 'title' => '通过文件URL创建功率预测任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-10-17T04:03:47.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreatePowerForecastByFileUrlJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 25,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
- 'title' => '创建功率预测任务',
],
- 'CreateEssOptJob' => [
- 'summary' => '创建储能运行优化任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreatePowerForecastJob' => [
+ 'summary' => '创建发电功率预测任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2377,14 +1329,44 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrial1ZR6M2',
- ],
+ 'abilityTreeNodes' => ['FEATUREbrainindustrial1ZR6M2'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
+ 'name' => 'DeviceType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备类型,每个systemType支持的设备类型有:系统类型:设备类型 load: electricityMeter --市电电表 hvac: gateway-hvac --空调 flexible: electricityMeter --照明电表 charge'."\0".':gateway-charging --充电桩', 'description' => '设备类型,每个systemType支持的设备类型有:'."\n"
+ ."\n"
+ .'系统类型:设备类型'."\n"
+ ."\n"
+ .'- solar: solarInverter --光伏逆变器'."\n"
+ .'- wind: windTurbine --风电发电机', 'type' => 'string', 'required' => false, 'example' => 'solarInverter', 'default' => 'solarInverter'],
+ ],
+ [
+ 'name' => 'HistoryData',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '历史负荷,需要90天的历史数据',
+ 'description' => '历史负荷,需要90天的历史数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RunTime' => ['title' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐', 'description' => '每{freq}分钟,"yyyy-MM-dd HH:mm:ss", 数据频率需与freq字段对齐。', 'type' => 'string', 'required' => false, 'example' => '2025-02-12 00:00:00'],
+ 'Value' => ['title' => '负荷数据', 'description' => '负荷数据。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 100000,
+ 'minItems' => 1,
+ ],
+ ],
+ [
'name' => 'Freq',
'in' => 'formData',
'schema' => [
@@ -2402,256 +1384,94 @@
'type' => 'string',
'required' => false,
'example' => 'FIFTEEN_MIN',
- 'enum' => [
- 'FIFTEEN_MIN',
- 'FIVE_MIN',
- 'ONE_HOUR',
- 'ONE_DAY',
- ],
+ 'default' => 'FIFTEEN_MIN',
+ 'enum' => ['FIFTEEN_MIN', 'FIVE_MIN', 'ONE_HOUR', 'ONE_DAY'],
],
],
[
'name' => 'Duration',
'in' => 'formData',
- 'schema' => [
- 'title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
- .'非必填,默认1天',
- 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
- ."\n"
- .'非必填,默认1天。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
+ .'非必填,默认1天', 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
+ ."\n"
+ .'非必填,默认1天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'RunDate',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '运行日,精确到天,“yyyy-MM-dd”格式',
- 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-02-12',
- ],
- ],
- [
- 'name' => 'TimeZone',
+ 'name' => 'SystemType',
'in' => 'formData',
- 'schema' => [
- 'title' => '时区,默认上海时区:Asia/Shanghai',
- 'description' => '时区,默认上海时区:Asia/Shanghai。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Asia/Shanghai',
- ],
+ 'schema' => ['title' => '系统类型,支持的系统类型有: solar: 光伏 wind: 风电', 'description' => '系统类型,支持的系统类型有:'."\n"
+ ."\n"
+ .'- solar: 光伏'."\n"
+ .'- wind: 风电', 'type' => 'string', 'required' => false, 'example' => 'solar', 'default' => 'solar'],
],
[
- 'name' => 'ModelVersion',
+ 'name' => 'RunDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本',
- 'description' => '模型对应的版本号,默认为latest。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'latest',
- ],
+ 'schema' => ['title' => '运行日,精确到天,“yyyy-MM-dd”格式', 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。', 'type' => 'string', 'required' => false, 'example' => '2025-02-12'],
],
[
- 'name' => 'TopoType',
+ 'name' => 'TimeZone',
'in' => 'formData',
- 'schema' => [
- 'description' => '场站内资源拓扑类型:'."\n"
- ."\n"
- .'- LOAD_ESS:市电+储能。'."\n"
- .'- LOAD_ESS_SOLAR: 市电+储能+光伏。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LOAD_ESS_SOLAR',
- 'enum' => [
- 'LOAD_ESS',
- 'LOAD_ESS_SOLAR',
- ],
- ],
+ 'schema' => ['title' => '时区,默认上海时区:Asia/Shanghai', 'description' => '时区,默认上海时区:Asia/Shanghai。', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'."\n", 'default' => 'Asia/Shanghai'],
],
[
- 'name' => 'SystemData',
+ 'name' => 'ModelVersion',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '系统数据,包含场站内各个系统的参数和历史数据。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SystemType' => [
- 'description' => '系统类型,SystemType的取值可以是:'."\n"
- ."\n"
- .'- load: 市电'."\n"
- .'- ess:储能'."\n"
- .'- solar:光伏'."\n"
- .'- hvac: 空调'."\n"
- .'- flexible:照明'."\n"
- .'- charge:充电桩',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'hvac' => 'hvac',
- 'charge' => 'charge',
- 'load' => 'load',
- 'ess' => 'ess',
- 'flexible' => 'flexible',
- 'solar' => 'solar',
- ],
- 'example' => 'ess',
- ],
- 'SystemId' => [
- 'description' => '系统ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- 'SystemParams' => [
- 'description' => '系统参数,各个类型的系统的参数值。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '如光伏系统参数:{'."\n"
- .' "sfktj": 0, //是否可调节:0-不可调 1-可调,一般光伏为 不可调'."\n"
- .' "cfdfs": 0, //充放电方式:0-正放电负充电 1-负放电正充电'."\n"
- .' "zjrl": "xxx", //装机容量'."\n"
- .' }',
- ],
- 'HistoryData' => [
- 'description' => '各系统的历史运行数据。',
- 'type' => 'array',
- 'items' => [
- 'description' => '历史时段的运行数据。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '如市电的历史数据:{'."\n"
- .' "runTime": "2023-05-06 20:00:00",'."\n"
- .' "pwr": 0.0, //总有功功率, 单位kW'."\n"
- .' "qvr": 0.0, //总无功功率, 单位Var'."\n"
- .' "sva": 0.0, //总视在功率, 单位VA'."\n"
- .' "cos": 1, //总功率因数'."\n"
- .' "fwdActngy": 0.0, //累计正向有功总电量, 单位kWh'."\n"
- .' "rvsActngy": 0.0, //累计反相有功总电量, 单位kWh'."\n"
- .' "demandpwr": 0.0 //正向有功总需量, 单位kW'."\n"
- .' }',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本', 'description' => '模型对应的版本号,默认为latest。', 'type' => 'string', 'required' => false, 'example' => 'latest', 'default' => 'latest'],
],
[
- 'name' => 'ElecPrice',
+ 'name' => 'Location',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '目标日期该天的市电分时价格变化,时间粒度与freq一致。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标日期该天某时刻的市电价格。',
- 'type' => 'object',
- 'properties' => [
- 'DataTime' => [
- 'description' => '一天内的时刻。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '00:00:15',
- ],
- 'Price' => [
- 'description' => '市电价格。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.5',
- ],
- ],
- 'required' => false,
+ 'title' => '地址位置信息,经纬度',
+ 'description' => '地址位置信息,经纬度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Altitude' => ['title' => '海拔高度,精度到小数点后3位,默认值为10', 'description' => '海拔高度,精度到小数点后3位,默认值为10。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10.123'],
+ 'Latitude' => ['title' => '纬度,精度到小数点后3位', 'description' => '纬度,精度到小数点后3位。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '40.027'],
+ 'Longitude' => ['title' => '经度,精度到小数点后3位', 'description' => '经度,精度到小数点后3位。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '120.042'],
],
'required' => false,
],
],
[
- 'name' => 'GenPrice',
+ 'name' => 'BusinessKey',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '目标日期该天的售电上网价格的分时变化,时间粒度与freq一致。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标日期该天某时刻的售电价格。',
- 'type' => 'object',
- 'properties' => [
- 'DataTime' => [
- 'description' => '一天内的时刻。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '00:00:15',
- ],
- 'Price' => [
- 'description' => '售电价格。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.3',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '业务键,如场站名称编号', 'description' => '业务键,如场站名称编号。', 'type' => 'string', 'required' => false, 'example' => 'stationA'],
],
[
- 'name' => 'Location',
+ 'name' => 'ForecastHorizon',
'in' => 'formData',
- 'style' => 'json',
'schema' => [
- 'title' => '地址位置信息,经纬度',
- 'description' => '地址位置信息,经纬度。',
- 'type' => 'object',
- 'properties' => [
- 'Altitude' => [
- 'title' => '海拔高度,精度到小数点后3位,默认值为10',
- 'description' => '海拔高度,精度到小数点后3位,默认值为10。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '10.123',
- ],
- 'Latitude' => [
- 'title' => '纬度,精度到小数点后3位',
- 'description' => '纬度,精度到小数点后3位。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '40.027',
- ],
- 'Longitude' => [
- 'title' => '经度,精度到小数点后3位',
- 'description' => '经度,精度到小数点后3位。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '120.042',
- ],
- ],
+ 'title' => '预测时间尺度,枚举值:'."\n"
+ .'DAY_AHEAD:日前预测'."\n"
+ .'INTRADAY:日内预测',
+ 'description' => '预测时间尺度,枚举值:'."\n"
+ .'- DAY_AHEAD:日前预测'."\n"
+ .'- INTRADAY:日内预测',
+ 'type' => 'string',
'required' => false,
+ 'example' => 'DAY_AHEAD',
+ 'default' => 'DAY_AHEAD',
+ 'enum' => ['DAY_AHEAD', 'INTRADAY'],
],
],
[
- 'name' => 'BusinessKey',
+ 'name' => 'DataMode',
'in' => 'formData',
'schema' => [
- 'title' => '业务键',
- 'description' => '业务键。',
+ 'title' => '本次调用的数据模式,枚举值:'."\n"
+ .'FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
+ .'INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
+ 'description' => '本次调用的数据模式,枚举值:'."\n"
+ .'- FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
+ .'- INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
'type' => 'string',
'required' => false,
- 'example' => 'stationA',
+ 'example' => 'FULL',
+ 'default' => 'FULL',
+ 'enum' => ['FULL', 'INCREMENTAL'],
],
],
],
@@ -2662,12 +1482,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
'Success' => [
'title' => '是否调用成功。'."\n"
.'- **True**:调用成功。'."\n"
@@ -2676,28 +1491,15 @@
.'- **True**:调用成功。'."\n"
.'- **False**:调用失败。',
'type' => 'string',
- 'enumValueTitles' => [
- 'True' => 'True',
- 'False' => 'False',
- ],
+ 'enumValueTitles' => ['True' => 'True', 'False' => 'False'],
'example' => 'True',
],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'title' => '返回JOB详细信息',
'description' => '返回JOB详细信息',
@@ -2709,44 +1511,19 @@
.'- True:当前Job已经执行完成。 '."\n"
.'- False:当前Job还在执行中。',
'type' => 'boolean',
+ 'enumValueTitles' => ['True' => 'True', 'False' => 'False'],
'example' => 'True',
],
- 'CreateTime' => [
- 'title' => '任务创建时间',
- 'description' => '任务创建时间。',
- 'type' => 'string',
- 'example' => '2024-12-22 00:00:21',
- ],
- 'Error' => [
- 'title' => '当前操作异常或者失败时的错误信息',
- 'description' => '当前操作异常或者失败时的错误信息。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'JobId' => [
- 'title' => '算法计算任务ID',
- 'description' => '算法计算任务ID。',
- 'type' => 'string',
- 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33',
- ],
- 'Progress' => [
- 'title' => '进度',
- 'description' => '进度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- ],
+ 'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间。', 'type' => 'string', 'example' => '2024-12-22 00:00:21'],
+ 'Error' => ['title' => '当前操作异常或者失败时的错误信息', 'description' => '当前操作异常或者失败时的错误信息。', 'type' => 'string', 'example' => '""'],
+ 'JobId' => ['title' => '算法计算任务ID', 'description' => '算法计算任务ID。', 'type' => 'string', 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33'],
+ 'Progress' => ['title' => '进度', 'description' => '进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
'Response' => [
'title' => '计算任务的结果',
'description' => '计算任务的结果。',
'type' => 'object',
'properties' => [
- 'DebugInfo' => [
- 'title' => '调试信息',
- 'description' => '调试信息。',
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'DebugInfo' => ['title' => '调试信息', 'description' => '调试信息。', 'type' => 'any', 'example' => '{}'],
'JobType' => [
'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
'description' => '计算任务类型,枚举值:'."\n"
@@ -2754,33 +1531,20 @@
.'- PowerForecast:功率预测。'."\n"
.'- EssOptStrategy:储能优化。',
'type' => 'string',
- 'enumValueTitles' => [
- 'EssOptStrategy' => 'EssOptStrategy',
- 'LoadForecast' => 'LoadForecast',
- 'PowerForecast' => 'PowerForecast',
- ],
- 'example' => 'EssOptStrategy',
- ],
- 'Result' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果。',
- 'type' => 'any',
- 'example' => '{}',
+ 'enumValueTitles' => ['EssOptStrategy' => 'EssOptStrategy', 'LoadForecast' => 'LoadForecast', 'PowerForecast' => 'PowerForecast'],
+ 'example' => 'PowerForecast',
],
+ 'Result' => ['title' => '计算任务的结果', 'description' => '计算任务的结果。', 'type' => 'any', 'example' => '{}'],
],
],
'Status' => [
'title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL',
- 'description' => '任务状态,枚举值: '."\n"
- .'- RUNNING'."\n"
- .'- SUCCESS'."\n"
- .'- FAIL',
+ 'description' => '任务状态,枚举值:'."\n"
+ .'- RUNNING:运行中。'."\n"
+ .'- SUCCESS:运行成功。'."\n"
+ .'- FAIL:运行失败。',
'type' => 'string',
- 'enumValueTitles' => [
- 'SUCCESS' => 'SUCCESS',
- 'RUNNING' => 'RUNNING',
- 'FAIL' => 'FAIL',
- ],
+ 'enumValueTitles' => ['SUCCESS' => 'SUCCESS', 'RUNNING' => 'RUNNING', 'FAIL' => 'FAIL'],
'example' => 'RUNNING',
],
],
@@ -2791,248 +1555,166 @@
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
- [
- 'errorCode' => 'NoNormalResource',
- 'errorMessage' => 'There is no normal resource.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
+ ['errorCode' => 'NoNormalResource', 'errorMessage' => 'There is no normal resource.', 'description' => '无可用资源'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 25,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
+ 'title' => '创建功率预测任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-10-17T04:03:47.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-28T07:25:20.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2025-07-23T14:04:47.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreatePowerForecastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 25,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"EssOptStrategy\\",\\n \\"Result\\": \\"{}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
- 'title' => '创建储能优化任务',
],
- 'CreateLoadForecastByFileUrlJob' => [
- 'summary' => '创建用电负荷预测任务,历史数据来自文件url。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetAivppAlgoJob' => [
+ 'summary' => '查询aivpp算法job。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrial1ZR6M2',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREbrainindustrial1ZR6M2'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'DeviceType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备类型,每个systemType支持的设备类型有:系统类型:设备类型 load: electricityMeter --市电电表 hvac: gateway-hvac --空调 flexible: electricityMeter --照明电表 charge'."\0".':gateway-charging --充电桩',
- 'description' => '设备类型,每个系统类型支持的设备类型有: '."\n"
- ."\n"
- .'- load: electricityMeter --市电电表'."\n"
- .'- hvac: gateway-hvac --空调'."\n"
- .'- flexible: electricityMeter --照明电表'."\n"
- .'- charge:gateway-charging --充电桩',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'electricityMeter',
- 'default' => 'electricityMeter',
- ],
- ],
- [
- 'name' => 'HistoryUrl',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'title' => '历史数据csv文件url地址',
- 'description' => '历史数据csv文件url地址,在调用期间地址需要公网可访问。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/dir/target_file.csv',
- ],
+ 'schema' => ['title' => '创建任务接口返回的JobId,输入后可以查询异步接口的生成的任务实时详情', 'description' => '创建任务接口返回的JobId,输入后可以查询异步接口的生成的任务实时详情', 'type' => 'string', 'required' => false, 'example' => '5854bfa6-f002-43c2-8e1d-e9b2c28f9384'],
],
- [
- 'name' => 'Freq',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '默认15min;需要与historyData的数据频率一致;枚举值:'."\n"
- .'FIFTEEN_MIN: 15分钟'."\n"
- .'FIVE_MIN: 5分钟'."\n"
- .'ONE_HOUR: 1小时'."\n"
- .'ONE_DAY: 1天',
- 'description' => '默认值为FIFTEEN_MIN;需要与历史数据的数据频率一致;'."\n"
- .'- FIFTEEN_MIN: 15分钟'."\n"
- .'- FIVE_MIN: 5分钟'."\n"
- .'- ONE_HOUR: 1小时'."\n"
- .'- ONE_DAY: 1天',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FIFTEEN_MIN',
- 'default' => 'FIFTEEN_MIN',
- 'enum' => [
- 'FIFTEEN_MIN',
- 'FIVE_MIN',
- 'ONE_HOUR',
- 'ONE_DAY',
+ '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' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
+ 'Success' => ['title' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'type' => 'string', 'example' => 'True'],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'title' => '返回的数据内容。',
+ 'description' => '返回的数据内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Completed' => ['title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。', 'description' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。', 'type' => 'boolean', 'example' => 'False'],
+ 'CreateTime' => ['title' => '任务创建时间。'."\n"
+ ."\n", 'description' => '任务创建时间。'."\n"
+ ."\n", 'type' => 'string', 'example' => '2024-12-10 17:50:48'],
+ 'Error' => ['title' => '当前操作异常或者失败时的错误信息', 'description' => '当前操作异常或者失败时的错误信息', 'type' => 'string', 'example' => '""'],
+ 'JobId' => ['title' => '任务ID。', 'description' => '任务ID。', 'type' => 'string', 'example' => '5854bfa6-f002-43c2-8e1d-e9b2c28f9384'],
+ 'Progress' => ['title' => '任务进度,取值范围为0~100。', 'description' => '任务进度,取值范围为0~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Response' => [
+ 'title' => '计算任务的结果',
+ 'description' => '计算任务的结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'DebugInfo' => ['title' => '调试信息', 'description' => '调试信息', 'type' => 'any', 'example' => '{}'],
+ 'JobType' => ['title' => '计算任务类型,枚举值:LoadForecast PowerForecast', 'description' => '计算任务类型,枚举值:LoadForecast PowerForecast', 'type' => 'string', 'example' => 'PowerForecast'],
+ 'Result' => ['title' => '任务结果', 'description' => '任务结果', 'type' => 'any', 'example' => '{}'],
+ ],
+ ],
+ 'Status' => ['title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL', 'description' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL', 'type' => 'string', 'example' => 'RUNNING'],
+ ],
+ ],
],
],
],
- [
- 'name' => 'Duration',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
- .'非必填,默认1天',
- 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
- ."\n"
- .'非必填,默认1天。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'SystemType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '系统类型,支持的系统类型有: load: 市电 hvac: 空调 flexible:照明 charge:充电桩',
- 'description' => '系统类型,支持的系统类型有: '."\n"
- .'- load: 市电 '."\n"
- .'- hvac: 空调 '."\n"
- .'- flexible:照明 '."\n"
- .'- charge:充电桩',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'load',
- 'default' => 'load',
- ],
- ],
- [
- 'name' => 'RunDate',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '运行日,精确到天,“yyyy-MM-dd”格式',
- 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-01-01',
- ],
- ],
- [
- 'name' => 'TimeZone',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '时区,默认上海时区:Asia/Shanghai',
- 'description' => '时区,默认上海时区:Asia/Shanghai。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Asia/Shanghai'."\n",
- 'default' => 'Asia/Shanghai',
- ],
- ],
- [
- 'name' => 'ModelVersion',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本',
- 'description' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'latest',
- 'default' => 'latest',
- ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
],
- [
- 'name' => 'BusinessKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务键,如场站名称编号等。',
- 'description' => '业务键,如场站名称编号等。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'stationA',
- ],
+ 500 => [
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
- [
- 'name' => 'TimeColumn',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '时间列',
- 'description' => '历史数据csv文件中的时间列,时间列需要符合 yyyy-MM-dd HH:mm:SS格式,数据频率需要与freq字段对齐。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'runTime',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-10 17:50:48\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"5854bfa6-f002-43c2-8e1d-e9b2c28f9384\\",\\n \\"Progress\\": 100,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取AIVPP算法任务结果',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:GetAivppAlgoJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetLicense' => [
+ 'summary' => 'License详情。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ValueColumn',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '值列',
- 'description' => '历史数据csv文件中的值列,需要为数值类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREbrainindustrialGARA6B'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'ForecastHorizon',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '预测时间跨度。'."\n"
- .'可取枚举值:'."\n"
- .'- 日前预测:DAY_AHEAD'."\n"
- .'- 日内预测:INTRADAY',
- 'description' => '预测时间跨度。'."\n"
- .'可取枚举值:'."\n"
- .'- DAY_AHEAD:日前预测'."\n"
- .'- INTRADAY:日内预测',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAY_AHEAD',
- 'default' => 'DAY_AHEAD',
- 'enum' => [
- 'DAY_AHEAD',
- 'INTRADAY',
- ],
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'DataMode',
+ 'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '本次调用的数据模式,枚举值:'."\n"
- .'FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
- .'INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
- 'description' => '本次调用的数据模式,枚举值:'."\n"
- .'- FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
- .'- INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FULL',
- 'default' => 'FULL',
- 'enum' => [
- 'FULL',
- 'INCREMENTAL',
- ],
- ],
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c31238fcb74e482588a72de90cd7dba3'],
],
],
'responses' => [
@@ -3042,404 +1724,363 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'Success' => [
- 'title' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'description' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'string', 'example' => 'true'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
'Data' => [
- 'title' => '返回JOB详细信息',
- 'description' => '返回JOB详细信息。',
+ 'description' => '返回的结果',
'type' => 'object',
'properties' => [
- 'Completed' => [
- 'title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。',
- 'description' => '操作是否完成,取值范围: '."\n"
- .'- True:当前Job已经执行完成。'."\n"
- .'- False:当前Job还在执行中。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'CreateTime' => [
- 'title' => '任务创建时间',
- 'description' => '任务创建时间。',
- 'type' => 'string',
- 'example' => '2024-12-22 00:00:21',
- ],
- 'Error' => [
- 'title' => '当前操作异常或者失败时的错误信息',
- 'description' => '当前操作异常或者失败时的错误信息。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'JobId' => [
- 'title' => '算法计算任务ID',
- 'description' => '算法计算任务id。',
- 'type' => 'string',
- 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33',
- ],
- 'Progress' => [
- 'title' => '进度',
- 'description' => '进度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Response' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果。',
- 'type' => 'object',
- 'properties' => [
- 'DebugInfo' => [
- 'title' => '调试信息',
- 'description' => '调试信息。',
- 'type' => 'any',
- 'example' => 'null',
- ],
- 'JobType' => [
- 'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
- 'description' => '计算任务类型,枚举值:'."\n"
- .'- LoadForecast:负荷预测。'."\n"
- .'- PowerForecast:功率预测。'."\n"
- .'- EssOptStrategy:储能优化。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'EssOptStrategy' => 'EssOptStrategy',
- 'LoadForecast' => 'LoadForecast',
- 'PowerForecast' => 'PowerForecast',
- ],
- 'example' => 'PowerForecast',
- ],
- 'Result' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果。',
- 'type' => 'any',
- 'example' => '{"runTime": \'2025-01-01 00:00:00\', "value": 0.0}',
+ 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'LicenseSpecName' => ['title' => '资源组ID', 'description' => '授权类型', 'type' => 'string', 'example' => '边缘端1000型运行节点授权'],
+ 'BuyTime' => ['title' => '资源名称', 'description' => '购买时间。', 'type' => 'string', 'example' => '2024-04-29 15:01:15'],
+ 'ActivateTime' => ['title' => '资源一级ID', 'description' => '激活时间', 'type' => 'string', 'example' => '2024-04-29 15:03:12'],
+ 'Fingerprint' => ['title' => '创建时间', 'description' => '机器指纹', 'type' => 'string', 'example' => 'XXX'],
+ 'LicenseCode' => ['description' => '授权码', 'type' => 'string', 'example' => 'XXX'],
+ 'EffectTime' => ['description' => '生效时间', 'type' => 'string', 'example' => '2024-05-01 00:00:00'],
+ 'ExpireTime' => ['description' => '过期时间', 'type' => 'string', 'example' => '2025-05-01 00:00:00'],
+ 'Duration' => ['description' => '总激活剩余时长', 'type' => 'string', 'example' => '2个月9天'],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'activated'],
+ 'AdaptiveMachine' => ['description' => '适配机型', 'type' => 'string', 'example' => '72核256G'],
+ 'LicenseSpecCode' => ['description' => '授权商品code', 'type' => 'string', 'example' => 'aics_1000'],
+ 'LicenseSpecType' => ['description' => 'license商品类型', 'type' => 'string', 'example' => 'edge_license'],
+ 'CpuLimit' => ['description' => '限制的CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '72'],
+ 'MemoryLimit' => ['description' => '内存限制(GB)', 'type' => 'integer', 'format' => 'int32', 'example' => '256'],
+ 'InstanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'c31238fcb74e482588a72de90cd7dba3'],
+ 'AllDuration' => ['description' => '激活总时长', 'type' => 'string', 'example' => '1年'],
+ 'ApplicableSpecs' => ['description' => '适用规格', 'type' => 'string', 'example' => '72核256G'],
+ 'Description' => ['description' => '描述', 'type' => 'string', 'example' => '""'],
+ 'UnActivateAllDuration' => ['description' => '未激活时长', 'type' => 'string', 'example' => '1个月'],
+ 'Proposal' => ['description' => '建议。', 'type' => 'string', 'example' => '最大用量建议(72核256G)'],
+ 'ActivateRecord' => [
+ 'description' => '激活记录列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '激活记录',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => '订单id', 'type' => 'string', 'example' => '1040b91765d14ad1a40ff22589070342'],
+ 'BuyTime' => ['description' => '购买时间。', 'type' => 'string', 'example' => '2024-04-29 15:01:15'."\n"],
+ 'ActivateTime' => ['description' => '激活时间', 'type' => 'string', 'example' => '2024-04-29 15:03:12'."\n"],
+ 'ExpireTime' => ['description' => '过期时间', 'type' => 'string', 'example' => '2025-05-01 00:00:00'."\n"],
+ 'Duration' => ['description' => '授权时长', 'type' => 'string', 'example' => '1年'],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'activated'],
+ 'LicenseCode' => ['description' => '授权码', 'type' => 'string', 'example' => 'XXXX'],
],
],
],
- 'Status' => [
- 'title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL',
- 'description' => '任务状态,枚举值:'."\n"
- .'- RUNNING:运行中。'."\n"
- .'- SUCCESS:运行成功。'."\n"
- .'- FAIL:运行失败。',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
],
],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
- [
- 'errorCode' => 'NoNormalResource',
- 'errorMessage' => 'There is no normal resource.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"LicenseSpecName\\": \\"边缘端1000型运行节点授权\\",\\n \\"BuyTime\\": \\"2024-04-29 15:01:15\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\",\\n \\"Fingerprint\\": \\"XXX\\",\\n \\"LicenseCode\\": \\"XXX\\",\\n \\"EffectTime\\": \\"2024-05-01 00:00:00\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\",\\n \\"Duration\\": \\"2个月9天\\",\\n \\"Status\\": \\"activated\\",\\n \\"AdaptiveMachine\\": \\"72核256G\\",\\n \\"LicenseSpecCode\\": \\"aics_1000\\",\\n \\"LicenseSpecType\\": \\"edge_license\\",\\n \\"CpuLimit\\": 72,\\n \\"MemoryLimit\\": 256,\\n \\"InstanceId\\": \\"c31238fcb74e482588a72de90cd7dba3\\",\\n \\"AllDuration\\": \\"1年\\",\\n \\"ApplicableSpecs\\": \\"72核256G\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"UnActivateAllDuration\\": \\"1个月\\",\\n \\"Proposal\\": \\"最大用量建议(72核256G)\\",\\n \\"ActivateRecord\\": [\\n {\\n \\"OrderId\\": \\"1040b91765d14ad1a40ff22589070342\\",\\n \\"BuyTime\\": \\"2024-04-29 15:01:15\\\\n\\",\\n \\"ActivateTime\\": \\"2024-04-29 15:03:12\\\\n\\",\\n \\"ExpireTime\\": \\"2025-05-01 00:00:00\\\\n\\",\\n \\"Duration\\": \\"1年\\",\\n \\"Status\\": \\"activated\\",\\n \\"LicenseCode\\": \\"XXXX\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
+ 'title' => '获取授权',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:GetLicense',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 100,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"null\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{\\\\\\"runTime\\\\\\": \'2025-01-01 00:00:00\', \\\\\\"value\\\\\\": 0.0}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
- 'title' => '通过文件URL创建负荷预测任务',
],
- 'CreatePowerForecastByFileUrlJob' => [
- 'summary' => '创建发电功率预测任务,历史数据来自文件url。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListAivppResources' => [
+ 'summary' => '获取用户AIVPP资源列表。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrial1ZR6M2',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREbrainindustrial1ZR6M2'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'DeviceType',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '设备类型,每个systemType支持的设备类型有:系统类型:设备类型 load: electricityMeter --市电电表 hvac: gateway-hvac --空调 flexible: electricityMeter --照明电表 charge'."\0".':gateway-charging --充电桩',
- 'description' => '设备类型,每个系统类型支持的设备类型有:'."\n"
- .'- solar: solarInverter --光伏逆变器'."\n"
- .'- wind: windTurbine--风电发电机',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'solarInverter' => 'solarInverter',
- ],
- 'example' => 'solarInverter',
- 'default' => 'solarInverter',
- ],
+ 'schema' => ['title' => '每页返回数据量,默认为20', 'description' => '每页返回数据量,默认为20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
[
- 'name' => 'HistoryUrl',
+ 'name' => 'CurrentPage',
'in' => 'formData',
- 'schema' => [
- 'title' => '历史数据csv文件url地址',
- 'description' => '历史数据csv文件url地址,在调用期间地址需要公网可访问。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/dir/target_file.csv',
- ],
+ 'schema' => ['title' => '当前页,默认为1', 'description' => '当前页,默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'Freq',
+ 'name' => 'InstanceType',
'in' => 'formData',
'schema' => [
- 'title' => '默认15min;需要与historyData的数据频率一致;枚举值:'."\n"
- .'FIFTEEN_MIN: 15分钟'."\n"
- .'FIVE_MIN: 5分钟'."\n"
- .'ONE_HOUR: 1小时'."\n"
- .'ONE_DAY: 1天',
- 'description' => '默认值为FIFTEEN_MIN;需要与历史数据的数据频率一致;枚举值:'."\n"
- .'- FIFTEEN_MIN: 15分钟'."\n"
- .'- FIVE_MIN: 5分钟'."\n"
- .'- ONE_HOUR: 1小时'."\n"
- .'- ONE_DAY: 1天',
+ 'title' => '实例类型'."\n"
+ .'API: API类型'."\n"
+ .'DATA: 时序数据类型',
+ 'description' => '实例类型'."\n"
+ .'API: API类型'."\n"
+ .'DATA: 时序数据类型',
'type' => 'string',
'required' => false,
- 'example' => 'FIFTEEN_MIN',
- 'default' => 'FIFTEEN_MIN',
- 'enum' => [
- 'FIFTEEN_MIN',
- 'FIVE_MIN',
- 'ONE_HOUR',
- 'ONE_DAY',
- ],
+ 'example' => 'DATA',
+ 'default' => 'API',
+ 'enum' => ['API', 'DATA'],
],
],
- [
- 'name' => 'Duration',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '从运行日(含)开始, 预测时长(单位:天)'."\n"
- .'非必填,默认1天',
- 'description' => '从运行日(含)开始, 预测时长(单位:天)。'."\n"
- ."\n"
- .'非必填,默认1天。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ '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' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
+ 'Success' => ['title' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **True**:调用成功。'."\n"
+ .'- **False**:调用失败。', 'type' => 'string', 'example' => 'True'],
+ 'Code' => ['title' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'title' => '分组列表。',
+ 'description' => '分组列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '分组列表。',
+ 'description' => '分组列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['title' => '资源实例id', 'description' => '资源实例id', 'type' => 'string', 'example' => 'i-bp154xh3gt3adb4xu1ue'],
+ 'Specification' => ['title' => '规格', 'description' => '规格', 'type' => 'string', 'example' => 'LoadForecasting'],
+ 'OrderId' => ['title' => '订单id', 'description' => '订单id', 'type' => 'string', 'example' => '231287932080007'],
+ 'UserId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '123456789'],
+ 'Quantity' => ['title' => '资源规格总调用次数', 'description' => '资源规格总调用次数', 'type' => 'string', 'example' => '1'],
+ 'LeftQuantity' => ['title' => '剩下可调用次数', 'description' => '剩下可调用次数', 'type' => 'string', 'example' => '1'],
+ 'Status' => ['title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => 'Normal'],
+ 'StartTime' => ['title' => '开通日期', 'description' => '开通日期', 'type' => 'string', 'example' => '2024-09-08T01:16Z'],
+ 'ExpireTime' => ['title' => '失效日期', 'description' => '失效日期', 'type' => 'string', 'example' => '2034-03-09T17:47:11Z'],
+ 'InstanceType' => ['description' => '商品类型', 'type' => 'string', 'example' => 'api'],
+ 'Detail' => ['description' => '规格详情', 'type' => 'string', 'example' => '规格: LoadForecasting,api数量:50'],
+ 'ConnectNum' => ['title' => '时序数据规格:在线设备数', 'description' => '时序数据规格:在线设备数', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
+ 'MessageTps' => ['title' => '时序数据规格:消息TPS', 'description' => '时序数据规格:消息TPS', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
+ 'ConsoleUrl' => ['title' => '控制台访问地址', 'description' => '控制台访问地址', 'type' => 'string', 'example' => 'industry-brain.aliyun.com'],
+ ],
+ ],
+ ],
+ 'MaxResults' => ['title' => '分批次查询时每次显示的条目数。取值范围:1~100,默认值:20。', 'description' => '分批次查询时每次显示的条目数。取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'NextToken' => ['title' => '下一个查询开始的Token。', 'description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => '37cc36b4344b182d36b45d95ae4ef03952ee5c24733ba461'],
+ 'TotalCount' => ['title' => '总个数。', 'description' => '总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ ],
],
],
- [
- 'name' => 'SystemType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '系统类型,支持的系统类型有: solar: 光伏 wind: 风电',
- 'description' => '系统类型,支持的系统类型有: '."\n"
- .'- solar: 光伏'."\n"
- .'- wind: 风电',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'solar' => 'solar',
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
+ ],
+ 500 => [
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"i-bp154xh3gt3adb4xu1ue\\",\\n \\"Specification\\": \\"LoadForecasting\\",\\n \\"OrderId\\": \\"231287932080007\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"Quantity\\": \\"1\\",\\n \\"LeftQuantity\\": \\"1\\",\\n \\"Status\\": \\"Normal\\",\\n \\"StartTime\\": \\"2024-09-08T01:16Z\\",\\n \\"ExpireTime\\": \\"2034-03-09T17:47:11Z\\",\\n \\"InstanceType\\": \\"api\\",\\n \\"Detail\\": \\"规格: LoadForecasting,api数量:50\\",\\n \\"ConnectNum\\": 10000,\\n \\"MessageTps\\": 500,\\n \\"ConsoleUrl\\": \\"industry-brain.aliyun.com\\"\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"37cc36b4344b182d36b45d95ae4ef03952ee5c24733ba461\\",\\n \\"TotalCount\\": 30\\n}","type":"json"}]',
+ 'title' => '查询AIVPP资源列表',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ListAivppResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'example' => 'solar',
- 'default' => 'solar',
],
],
+ ],
+ ],
+ 'ListLicenses' => [
+ 'summary' => 'License列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'RunDate',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '运行日,精确到天,“yyyy-MM-dd”格式',
- 'description' => '运行日,精确到天,“yyyy-MM-dd”格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-01-01',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREbrainindustrialGARA6B'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'TimeZone',
+ 'name' => 'CurrentPage',
'in' => 'formData',
- 'schema' => [
- 'title' => '时区,默认上海时区:Asia/Shanghai',
- 'description' => '时区,默认上海时区:Asia/Shanghai。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Asia/Shanghai',
- 'default' => 'Asia/Shanghai',
- ],
+ 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'ModelVersion',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本',
- 'description' => '模型对应的版本号,默认为latest;可根据文档查询版本号,以调用历史快照版本,或preview版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'latest',
- 'default' => 'latest',
- ],
+ 'schema' => ['description' => '每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12'],
],
[
- 'name' => 'Location',
+ 'name' => 'QueryStr',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['description' => '商品名称关键字,可根据该关键字模糊搜索。', 'type' => 'string', 'required' => false, 'example' => '边缘端1000型'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '地址位置信息,经纬度',
- 'description' => '地址位置信息,经纬度。',
'type' => 'object',
'properties' => [
- 'Altitude' => [
- 'title' => '海拔高度,精度到小数点后3位,默认值为10',
- 'description' => '海拔高度,精度到小数点后3位,默认值为10。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '10.123',
- ],
- 'Latitude' => [
- 'title' => '纬度,精度到小数点后3位',
- 'description' => '纬度,精度到小数点后3位。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '40.027',
- ],
- 'Longitude' => [
- 'title' => '经度,精度到小数点后3位',
- 'description' => '经度,精度到小数点后3位。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '120.042',
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
+ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'FAC892CE-5A94-5616-91DC-629B09CC6792'],
+ 'Message' => ['description' => '信息', 'type' => 'string', 'example' => 'successful'],
+ 'PageSize' => ['description' => '每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'CurrentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalPage' => ['description' => '总页数', 'type' => 'string', 'example' => '4'],
+ 'TotalPageCount' => ['description' => '总分页数', 'type' => 'string', 'example' => '4'],
+ 'Code' => ['description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'LicenseList' => [
+ 'description' => '授权列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '授权信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '授权ID', 'type' => 'string', 'example' => '1'],
+ 'LicenseSpecName' => ['description' => 'license规格名', 'type' => 'string', 'example' => '边缘端1000型运行节点授权'],
+ 'LicenseSpecType' => ['description' => 'license商品类型', 'type' => 'string', 'example' => 'brainindustrial_aicsruntime_public_cn'],
+ 'LicenseSpecCode' => ['description' => '授权商品code', 'type' => 'string', 'example' => 'aics_1000'],
+ 'BuyTime' => ['description' => '购买时间。', 'type' => 'string', 'example' => '2024-10-14 13:17:20'],
+ 'ActivateTime' => ['description' => '激活时间', 'type' => 'string', 'example' => '2024-10-14 14:15:45'],
+ 'EffectTime' => ['description' => '生效时间', 'type' => 'string', 'example' => '2024-10-14 14:15:45'],
+ 'ExpireTime' => ['description' => '过期时间', 'type' => 'string', 'example' => '2025-10-14 14:15:45'],
+ 'Duration' => ['description' => '已激活剩余时长', 'type' => 'string', 'example' => '7个月23天'],
+ 'AdaptiveMachine' => ['description' => '授权机型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'activated'],
+ 'MemoryLimit' => ['description' => 'memory 上限(GB)', 'type' => 'integer', 'format' => 'int32', 'example' => '256'],
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '451f14ee73604aesdfe4da606764ce09'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => '""'],
+ 'AllDuration' => ['description' => '已激活总时长', 'type' => 'string', 'example' => '1年'],
+ 'CpuLimit' => ['description' => '限制的CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '72'],
+ 'UnActivateAllDuration' => ['description' => '未激活时长', 'type' => 'string', 'example' => '1个月'],
+ ],
+ ],
],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => '{}'],
],
- 'required' => false,
+ 'description' => '',
],
],
- [
- 'name' => 'BusinessKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务键,如场站名称编号',
- 'description' => '业务键,如场站名称编号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'stationA',
- ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
],
- [
- 'name' => 'TimeColumn',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '时间列',
- 'description' => '历史数据csv文件中的时间列,时间列需要符合 yyyy-MM-dd HH:mm:SS格式,数据频率需要与freq字段对齐。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'runTime',
- ],
+ 500 => [
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
- [
- 'name' => 'ValueColumn',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '值列',
- 'description' => '历史数据csv文件中的值列,需要为数值类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 42,\\n \\"RequestId\\": \\"FAC892CE-5A94-5616-91DC-629B09CC6792\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 12,\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": \\"4\\",\\n \\"TotalPageCount\\": \\"4\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"LicenseList\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"LicenseSpecName\\": \\"边缘端1000型运行节点授权\\",\\n \\"LicenseSpecType\\": \\"brainindustrial_aicsruntime_public_cn\\",\\n \\"LicenseSpecCode\\": \\"aics_1000\\",\\n \\"BuyTime\\": \\"2024-10-14 13:17:20\\",\\n \\"ActivateTime\\": \\"2024-10-14 14:15:45\\",\\n \\"EffectTime\\": \\"2024-10-14 14:15:45\\",\\n \\"ExpireTime\\": \\"2025-10-14 14:15:45\\",\\n \\"Duration\\": \\"7个月23天\\",\\n \\"AdaptiveMachine\\": 1,\\n \\"Status\\": \\"activated\\",\\n \\"MemoryLimit\\": 256,\\n \\"InstanceId\\": \\"451f14ee73604aesdfe4da606764ce09\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AllDuration\\": \\"1年\\",\\n \\"CpuLimit\\": 72,\\n \\"UnActivateAllDuration\\": \\"1个月\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]',
+ 'title' => '查询授权列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-10T02:52:16.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-04-29T06:06:37.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ListLicenses',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
],
],
+ ],
+ ],
+ 'ListUserResources' => [
+ 'summary' => '获取用户资源列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ForecastHorizon',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '预测时间尺度,枚举值:'."\n"
- .'DAY_AHEAD:日前预测'."\n"
- .'INTRADAY:日内预测',
- 'description' => '预测时间尺度,枚举值:'."\n"
- .'- DAY_AHEAD:日前预测'."\n"
- .'- INTRADAY:日内预测',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAY_AHEAD',
- 'default' => 'DAY_AHEAD',
- 'enum' => [
- 'DAY_AHEAD',
- 'INTRADAY',
- ],
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREbrainindustrialGARA6B'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'DataMode',
+ 'name' => 'CommodityCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '本次调用的数据模式,枚举值:'."\n"
- .'FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
- .'INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
- 'description' => '本次调用的数据模式,枚举值:'."\n"
- .'- FULL:全量数据(仅使用本次调用中传递的数据)'."\n"
- .'- INCREMENTAL:增量数据(自动关联使用历史调用中相同BusinessKey的数据)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FULL',
- 'default' => 'FULL',
- 'enum' => [
- 'FULL',
- 'INCREMENTAL',
- ],
- ],
+ 'schema' => ['title' => '产品CODE', 'description' => '产品CODE', 'type' => 'string', 'required' => false, 'example' => 'BrainIndustrial'],
],
],
'responses' => [
@@ -3449,184 +2090,95 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'Success' => [
- 'title' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'description' => '是否调用成功。'."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '65308A66-8764-53EE-8D4A-201E86CA88C5'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '返回JOB详细信息',
- 'description' => '返回JOB详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'Completed' => [
- 'title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。',
- 'description' => '操作是否完成,取值范围: '."\n"
- .'- True:当前Job已经执行完成。'."\n"
- .'- False:当前Job还在执行中。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'CreateTime' => [
- 'title' => '任务创建时间',
- 'description' => '任务创建时间。',
- 'type' => 'string',
- 'example' => '2024-12-22 00:00:21',
- ],
- 'Error' => [
- 'title' => '当前操作异常或者失败时的错误信息',
- 'description' => '当前操作异常或者失败时的错误信息。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'JobId' => [
- 'title' => '算法计算任务ID',
- 'description' => '算法计算任务id。',
- 'type' => 'string',
- 'example' => '8c0ca18a-246a-4acd-80ca-e16d8ff5ef33',
- ],
- 'Progress' => [
- 'title' => '进度',
- 'description' => '进度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Response' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果。',
- 'type' => 'object',
- 'properties' => [
- 'DebugInfo' => [
- 'title' => '调试信息',
- 'description' => '调试信息。',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'JobType' => [
- 'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
- 'description' => '计算任务类型,枚举值:'."\n"
- .'- LoadForecast:负荷预测。'."\n"
- .'- PowerForecast:功率预测。'."\n"
- .'- EssOptStrategy:储能优化。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'EssOptStrategy' => 'EssOptStrategy',
- 'LoadForecast' => 'LoadForecast',
- 'PowerForecast' => 'PowerForecast',
- ],
- 'example' => 'PowerForecast',
- ],
- 'Result' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果。',
- 'type' => 'any',
- 'example' => '{"runTime": \'2025-01-01 00:00:00\', "value": 0.0}',
- ],
- ],
- ],
- 'Status' => [
- 'title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL',
- 'description' => '任务状态,枚举值:'."\n"
- .'- RUNNING:运行中。'."\n"
- .'- SUCCESS:运行成功。'."\n"
- .'- FAIL:运行失败。',
- 'type' => 'string',
- 'example' => 'RUNNING',
+ 'description' => '资源列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '资源实例',
+ 'type' => 'object',
+ 'properties' => [
+ 'startDate' => ['description' => '开始时间', 'type' => 'string', 'example' => '20240902'],
+ 'endDate' => ['description' => '结束时间', 'type' => 'string', 'example' => '2024-12-21'],
+ 'region' => ['description' => '地域', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'status' => ['description' => '状态。', 'type' => 'string', 'example' => '""'],
+ 'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '12345ea3cff446e8837078c2baffbe83'],
+ 'chargeType' => ['description' => '付费类型', 'type' => 'string', 'example' => 'PREPAY'],
+ 'commodityCode' => ['description' => '商品代码。', 'type' => 'string', 'example' => 'brainindustrial_simupostpaid_public_cn'],
+ 'statusMsg' => ['description' => '状态信息', 'type' => 'string', 'example' => '""'],
],
],
],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息;只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'None'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
- [
- 'errorCode' => 'NoNormalResource',
- 'errorMessage' => 'There is no normal resource.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65308A66-8764-53EE-8D4A-201E86CA88C5\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"startDate\\": \\"20240902\\",\\n \\"endDate\\": \\"2024-12-21\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"instanceId\\": \\"12345ea3cff446e8837078c2baffbe83\\",\\n \\"chargeType\\": \\"PREPAY\\",\\n \\"commodityCode\\": \\"brainindustrial_simupostpaid_public_cn\\",\\n \\"statusMsg\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
+ 'title' => '查询资源列表',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ListUserResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-22 00:00:21\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"8c0ca18a-246a-4acd-80ca-e16d8ff5ef33\\",\\n \\"Progress\\": 100,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{\\\\\\"runTime\\\\\\": \'2025-01-01 00:00:00\', \\\\\\"value\\\\\\": 0.0}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
- 'title' => '通过文件URL创建功率预测任务',
],
- 'GetAivppAlgoJob' => [
- 'summary' => '查询aivpp算法job。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateLicenseDescription' => [
+ 'summary' => '更新授权描述。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbrainindustrial1ZR6M2',
- ],
+ 'abilityTreeNodes' => ['FEATUREbrainindustrialGARA6B'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建任务接口返回的JobId,输入后可以查询异步接口的生成的任务实时详情',
- 'description' => '创建任务接口返回的JobId,输入后可以查询异步接口的生成的任务实时详情',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5854bfa6-f002-43c2-8e1d-e9b2c28f9384',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '实例id', 'type' => 'string', 'required' => false, 'example' => 'brainindustrial_aicsruntime_public_cn-mdu3ps3kw04'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => '授权描述', 'type' => 'string', 'required' => false, 'example' => '华新水泥-阳江厂授权'],
],
],
'responses' => [
@@ -3636,140 +2188,305 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F',
- ],
- 'Success' => [
- 'title' => '是否调用成功。'."\n"
- ."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **True**:调用成功。'."\n"
- .'- **False**:调用失败。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'description' => '状态码。'."\n"
- ."\n"
- .'> 200表示成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '返回信息。',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'title' => '返回的数据内容。',
- 'description' => '返回的数据内容。',
- 'type' => 'object',
- 'properties' => [
- 'Completed' => [
- 'title' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。',
- 'description' => '操作是否完成,取值范围: True:当前Job已经执行完成。 False:当前Job还在执行中。',
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- 'CreateTime' => [
- 'title' => '任务创建时间。'."\n"
- ."\n",
- 'description' => '任务创建时间。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '2024-12-10 17:50:48',
- ],
- 'Error' => [
- 'title' => '当前操作异常或者失败时的错误信息',
- 'description' => '当前操作异常或者失败时的错误信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'JobId' => [
- 'title' => '任务ID。',
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => '5854bfa6-f002-43c2-8e1d-e9b2c28f9384',
- ],
- 'Progress' => [
- 'title' => '任务进度,取值范围为0~100。',
- 'description' => '任务进度,取值范围为0~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Response' => [
- 'title' => '计算任务的结果',
- 'description' => '计算任务的结果',
- 'type' => 'object',
- 'properties' => [
- 'DebugInfo' => [
- 'title' => '调试信息',
- 'description' => '调试信息',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'JobType' => [
- 'title' => '计算任务类型,枚举值:LoadForecast PowerForecast',
- 'description' => '计算任务类型,枚举值:LoadForecast PowerForecast',
- 'type' => 'string',
- 'example' => 'PowerForecast',
- ],
- 'Result' => [
- 'title' => '任务结果',
- 'description' => '任务结果',
- 'type' => 'any',
- 'example' => '{}',
- ],
- ],
- ],
- 'Status' => [
- 'title' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL',
- 'description' => '任务状态,枚举值: RUNNING, SUCCESS, FAIL',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- ],
- ],
+ 'Code' => ['description' => '状态码。'."\n"
+ ."\n"
+ .'> 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'string', 'example' => 'True'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '68738E75-43C1-5AE5-9F3A-AFEF576D7B5F'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'RamAuthenticationFailed',
- 'errorMessage' => 'RAM authentication failed.',
- ],
+ ['errorCode' => 'RamAuthenticationFailed', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败。'],
],
500 => [
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'SystemError', 'errorMessage' => '%s.', 'description' => '%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"True\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
+ 'title' => '更新授权描述',
+ 'description' => '更新授权描述',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-10T02:52:16.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:UpdateLicenseDescription',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68738E75-43C1-5AE5-9F3A-AFEF576D7B5F\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Completed\\": true,\\n \\"CreateTime\\": \\"2024-12-10 17:50:48\\",\\n \\"Error\\": \\"\\\\\\"\\\\\\"\\",\\n \\"JobId\\": \\"5854bfa6-f002-43c2-8e1d-e9b2c28f9384\\",\\n \\"Progress\\": 100,\\n \\"Response\\": {\\n \\"DebugInfo\\": \\"{}\\",\\n \\"JobType\\": \\"PowerForecast\\",\\n \\"Result\\": \\"{}\\"\\n },\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取AIVPP算法任务结果',
],
],
'endpoints' => [
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'brain-industrial.cn-hangzhou.aliyuncs.com', 'endpoint' => 'brain-industrial.cn-hangzhou.aliyuncs.com', 'vpc' => 'brain-industrial-vpc.cn-hangzhou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AUTH_RUNTIME_TEST_NO_AUTH_ERROR', 'message' => 'RAM authentication failed.', 'http_code' => 403, 'description' => 'RAM鉴权失败。'],
+ ['code' => 'DuplicatedRequest', 'message' => 'The request is duplicated.', 'http_code' => 500, 'description' => '重复请求。'],
+ ['code' => 'IdempotentParameterMismatch', 'message' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'http_code' => 400, 'description' => '同一个ClientToken对应不同的请求。'],
+ ['code' => 'IllegalAuth', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 500, 'description' => '您没有操作权限。'],
+ ['code' => 'InternalError', 'message' => 'Internal error.', 'http_code' => 500, 'description' => '内部错误。'],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid. Please check the parameter.', 'http_code' => 500, 'description' => '请求参数错误,请检查参数。'],
+ ['code' => 'NoNormalResource', 'message' => 'There is no normal resource.', 'http_code' => 403, 'description' => '无可用资源'],
+ ['code' => 'NotAuthorized', 'message' => 'You are not authorized to perform the operation. Please authorize in RAM first and try again.', 'http_code' => 200, 'description' => '无权执行该操作,请您先在RAM中申请授权,再进行此操作。'],
+ ['code' => 'NO_NORMAL_RESOURCE', 'message' => 'There is no normal resource.', 'http_code' => 403, 'description' => '没有可用资源'],
+ ['code' => 'QueryDataFailed', 'message' => 'Failed to query data. Try again later.', 'http_code' => 500, 'description' => '查询数据失败,请稍后重试。'],
+ ['code' => 'RamAuthenticationFailed', 'message' => 'RAM user authentication failed. Please try again later.', 'http_code' => 200, 'description' => '子账号授权校验失败,请稍后重试。'],
+ ['code' => 'RamAuthenticationFailed', 'message' => 'RAM authentication failed.', 'http_code' => 403, 'description' => 'RAM鉴权失败。'],
+ ['code' => 'StsAuthenticationFailed', 'message' => 'STS token authentication failed. Please try again later.', 'http_code' => 200, 'description' => 'STS账号授权校验失败,请稍后重试。'],
+ ['code' => 'SystemError', 'message' => 'System error. Try again later.', 'http_code' => 500, 'description' => '系统错误,请稍后重试。'],
+ ['code' => 'SystemError', 'message' => '%s.', 'http_code' => 500, 'description' => '%s'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetLicense'],
+ ],
+ 'createdAt' => '2024-05-29T08:12:38.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更、请求参数发生变更、响应参数发生变更', 'api' => 'ActivateLicense'],
+ ['description' => '错误码发生变更、请求参数发生变更、响应参数发生变更', 'api' => 'GetLicense'],
+ ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'ListLicenses'],
+ ],
+ 'createdAt' => '2024-04-29T06:06:40.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'brain-industrial.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'AddParameterToPidLoop'],
+ ['description' => '错误码发生变更', 'api' => 'AddPidLoopToSchedule'],
+ ['description' => '错误码发生变更', 'api' => 'CreatePidLoop'],
+ ['description' => '错误码发生变更', 'api' => 'DeletePidLoop'],
+ ['description' => '错误码发生变更', 'api' => 'DeletePidProject'],
+ ['description' => '错误码发生变更', 'api' => 'DeletePoint'],
+ ['description' => '错误码发生变更', 'api' => 'GetCustomIdentValues'],
+ ['description' => '错误码发生变更', 'api' => 'GetDailyReportChart'],
+ ['description' => '错误码发生变更', 'api' => 'GetDailyReportDataTrend'],
+ ['description' => '错误码发生变更', 'api' => 'GetDailyReportInfo'],
+ ],
+ 'createdAt' => '2023-12-11T07:24:12.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'CreatePidOrganization'],
+ ['description' => '错误码发生变更', 'api' => 'CreatePidProject'],
+ ['description' => '错误码发生变更', 'api' => 'DeletePidOrganization'],
+ ['description' => '错误码发生变更', 'api' => 'GetIgateList'],
+ ['description' => '错误码发生变更', 'api' => 'GetPidOrganizationParentIds'],
+ ['description' => '错误码发生变更', 'api' => 'GetPidProjectReportOverview'],
+ ['description' => '错误码发生变更', 'api' => 'GetPointList'],
+ ['description' => '错误码发生变更', 'api' => 'GetSelectPointList'],
+ ],
+ 'createdAt' => '2023-10-12T08:01:31.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListUserResources'],
+ ],
+ 'createdAt' => '2021-03-29T09:05:52.000Z',
+ 'description' => 'commodity code',
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'BrainIndustrial',
+ 'productName' => '工业大脑',
+ 'ramCodes' => ['brain-industrial'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'ActivateLicense',
+ 'description' => '激活授权',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ActivateLicense',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAivppAlgoJob',
+ 'description' => '获取AIVPP算法任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:GetAivppAlgoJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateLoadForecastJob',
+ 'description' => '创建负荷预测任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreateLoadForecastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreatePowerForecastByFileUrlJob',
+ 'description' => '通过文件URL创建功率预测任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreatePowerForecastByFileUrlJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListLicenses',
+ 'description' => '查询授权列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ListLicenses',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetLicense',
+ 'description' => '获取授权',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:GetLicense',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AicsOpenApiInvoke',
+ 'description' => 'AICS OpenApi调用',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:AicsOpenApiInvoke',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateLicenseDescription',
+ 'description' => '更新授权描述',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:UpdateLicenseDescription',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateLoadForecastByFileUrlJob',
+ 'description' => '通过文件URL创建负荷预测任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreateLoadForecastByFileUrlJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAivppResources',
+ 'description' => '查询AIVPP资源列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ListAivppResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateEssOptJob',
+ 'description' => '创建储能优化任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreateEssOptJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListUserResources',
+ 'description' => '查询资源列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:ListUserResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'BrainIndustrial', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreatePowerForecastJob',
+ 'description' => '创建功率预测任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'brain-industrial:CreatePowerForecastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BrainIndustrial', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'conditional', 'resourceType' => 'PidOrganization', 'arn' => 'acs:brain-industrial::{#accountId}:none/{#none}'],
],
],
];