diff options
Diffstat (limited to 'data/zh_cn/cloudcontrol/2022-08-30/api-docs.php')
| -rw-r--r-- | data/zh_cn/cloudcontrol/2022-08-30/api-docs.php | 2690 |
1 files changed, 1027 insertions, 1663 deletions
diff --git a/data/zh_cn/cloudcontrol/2022-08-30/api-docs.php b/data/zh_cn/cloudcontrol/2022-08-30/api-docs.php index 48c5b85..b0aa8a5 100644 --- a/data/zh_cn/cloudcontrol/2022-08-30/api-docs.php +++ b/data/zh_cn/cloudcontrol/2022-08-30/api-docs.php @@ -1,117 +1,388 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'V3', - 'product' => 'cloudcontrol', - 'version' => '2022-08-30', - ], + 'info' => ['style' => 'ROA', 'product' => 'cloudcontrol', 'version' => '2022-08-30'], 'directories' => [ [ - 'id' => 177235, - 'title' => '元数据查询', + 'children' => ['GetResourceType', 'ListProducts', 'ListResourceTypes'], 'type' => 'directory', - 'children' => [ - 'GetResourceType', - 'ListProducts', - 'ListResourceTypes', - ], + 'title' => '元数据查询', + 'id' => 433000, ], [ - 'id' => 177238, - 'title' => '资源管理', + 'children' => ['CreateResource', 'DeleteResource', 'GetResources', 'UpdateResource'], 'type' => 'directory', - 'children' => [ - 'CreateResource', - 'DeleteResource', - 'GetResources', - 'UpdateResource', - ], + 'title' => '资源管理', + 'id' => 433004, ], [ - 'id' => 177243, - 'title' => '异步任务管理', + 'children' => ['GetTask', 'CancelTask'], 'type' => 'directory', - 'children' => [ - 'GetTask', - 'CancelTask', - ], + 'title' => '异步任务管理', + 'id' => 433009, ], [ - 'id' => 177246, - 'title' => '数据查询', + 'children' => ['ListDataSources'], 'type' => 'directory', - 'children' => [ - 'ListDataSources', - ], + 'title' => '数据查询', + 'id' => 433012, ], [ - 'id' => 188598, - 'title' => '其他', + 'children' => ['GetPrice', 'GetApiPrice', 'ListSupportedPricingApis'], 'type' => 'directory', - 'children' => [ - 'GetPrice', - ], + 'title' => '其他', + 'id' => 433014, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'GetResourceType' => [ - 'summary' => '获取资源元数据。', - 'path' => '/api/v1/providers/{provider}/products/{product}/resourceTypes/*', - 'methods' => [ - 'get', + 'CancelTask' => [ + 'summary' => '通过此接口取消指定异步任务。', + 'path' => '/api/v1/tasks/{taskId}/operation/cancel', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['title' => '任务id', 'description' => '任务id。', 'type' => 'string', 'required' => true, 'example' => 'task-433aead756057fff2913e7ce5****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', + 'title' => '取消任务', + 'description' => '仅状态为Pending或Running的Task可以被取消。'."\n" + ."\n" + .'调用CancelTask可以取消Cloud Control API 执行的任务，但是不会终止已经在下游云产品服务上启动的任务。', + 'changeSet' => [ + ['createdAt' => '2023-07-04T02:16:46.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelTask'], + ], + ], + ], + 'CreateResource' => [ + 'summary' => '创建资源。', + 'path' => '/api/v1/providers/{provider}/products/{product}/resources/*', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'requestPath', + 'in' => 'path', + 'schema' => ['description' => '请求路径。格式为：'."\n" + .'/api/v1/providers/{provider}/products/{product}/resources/{resourceType}'."\n" + ."\n" + .'请求路径中变量说明：'."\n" + ."\n" + .'provider: 云厂商，目前只支持Aliyun。'."\n" + ."\n" + .'product: 产品Code。'."\n" + ."\n" + .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/父资源ID/{资源类型code}。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'No parent resource:'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance'."\n" + .'Has parent resource:'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。若云产品是region化产品，则此参数为必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等参数。若云产品支持幂等能力，则传入生效。', 'type' => 'string', 'required' => false, 'example' => '1e810dfe1468721d0664a49b9d9f74f4'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => ['description' => '请求Body。资源属性，以JSON的形式传入。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "AccountName": "cctest",'."\n" + .' "AccountPassword": "Aa1234****"'."\n" + .'}'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-acs-cloudcontrol-timeout' => [ + 'schema' => ['type' => 'string', 'backendName' => 'retry-timeout'], + ], + ], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + 'resourceId' => ['title' => '资源id', 'description' => '资源ID。', 'type' => 'string', 'example' => 'cctest'], + 'resourcePath' => ['title' => '资源路径', 'description' => '资源路径。相对资源id，资源路径会包含完整的资源定位（父资源/子资源）。', 'type' => 'string', 'example' => 'Instance/r-8vbf5abe31c9c4d4/Account/cctest'], + 'taskId' => ['title' => '任务id', 'description' => '异步任务ID。当本次操作为异步时，此字段返回，此时HTTP状态码为202。', 'type' => 'string', 'example' => 'task-433aead756057fff8189a7ce5****'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"resourceId\\": \\"cctest\\",\\n \\"resourcePath\\": \\"Instance/r-8vbf5abe31c9c4d4/Account/cctest\\",\\n \\"taskId\\": \\"task-433aead756057fff8189a7ce5****\\"\\n}","type":"json"}]', + 'title' => '创建资源', + 'description' => '用户可前往[在线调试API门户](https://next.api.aliyun.com/cloudcontrol)查看资源文档和体验Cloud Control API。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResource'], + ], ], + ], + 'DeleteResource' => [ + 'summary' => '用户通过此接口删除资源。', + 'path' => '/api/v1/providers/{provider}/products/{product}/resources/*', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'requestPath', + 'in' => 'path', + 'schema' => ['description' => '请求路径。格式为：'."\n" + .'/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}'."\n" + ."\n" + .'请求路径中变量说明：'."\n" + ."\n" + .'provider: 云厂商，目前只支持Aliyun。'."\n" + ."\n" + .'product: 产品Code。'."\n" + ."\n" + .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/父资源ID/{资源类型code}。'."\n" + ."\n" + .'resourceId: 资源ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'No parent resource:'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****'."\n" + ."\n" + .'Has parent resource:'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user****'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。若云产品是region化产品，则此参数为必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'."\n"], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等参数。若云产品支持幂等能力，则传入生效。', 'type' => 'string', 'required' => false, 'example' => '1e810dfe1468721d0664a49b9d9f74f4'], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['type' => 'object'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-acs-cloudcontrol-timeout' => [ + 'schema' => ['type' => 'string', 'backendName' => 'retry-timeout'], + ], + ], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + 'taskId' => ['description' => '异步任务ID。当本次操作为异步时，此字段返回，此时HTTP状态码为202。', 'type' => 'string', 'example' => 'task-433aead756057fff8189a7ce5****'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"taskId\\": \\"task-433aead756057fff8189a7ce5****\\"\\n}","type":"json"}]', + 'title' => '删除资源', + 'description' => '用户可前往[在线调试API门户](https://next.api.aliyun.com/cloudcontrol)查看资源文档和体验Cloud Control API。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResource'], + ], ], - 'produces' => [ - 'application/json', + ], + 'GetApiPrice' => [ + 'summary' => '根据OpenAPI三元组与入参询价', + 'path' => '/api/v1/price/quote', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'x-acs-accept-language', - 'in' => 'header', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => ['title' => '询价请求体：popCode（POP产品码，如Ecs）、popVersion（API版本，如2014-05-26）、apiName（OpenAPI名称，如RunInstances）、parameters（源OpenAPI入参JSON）', 'type' => 'object'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '选择返回产品的语言。'."\n" - ."\n" - .'zh_CH：中文 （默认）'."\n" - ."\n" - .'en_US：英文。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'zh_CH' => 'zh_CH', - 'en_US' => 'en_US', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'price' => [ + 'type' => 'object', + 'properties' => [ + 'pricingMode' => ['type' => 'string', 'description' => ''], + 'success' => ['type' => 'boolean', 'description' => ''], + 'currency' => ['type' => 'string', 'description' => ''], + 'calculatedAmount' => ['type' => 'number', 'format' => 'float', 'description' => ''], + 'priceSummary' => [ + 'type' => 'object', + 'properties' => [ + 'currency' => ['type' => 'string', 'description' => ''], + 'tradePrice' => ['type' => 'number', 'format' => 'float', 'description' => ''], + 'originalPrice' => ['title' => '本次询价折扣前的原价合计；当 originalPrice 与 tradePrice/moduleSum 不一致时，说明应用了优惠（如新购首单折扣、促销活动）', 'type' => 'number', 'format' => 'float'], + 'moduleSum' => ['type' => 'number', 'format' => 'float', 'description' => ''], + 'effectiveModuleSum' => ['type' => 'number', 'format' => 'float', 'description' => ''], + 'quantity' => ['title' => '询价数量（来自 OpenAPI 入参，如 ECS RunInstances 的 Amount）。moduleSum 是单台单价，effectiveModuleSum = moduleSum × quantity 是总价；调用方应据此向用户呈现 N 台的真实总额，避免把单价误认为总价', 'type' => 'number', 'format' => 'float'], + 'pricingUnit' => ['title' => '计费周期单位（如 \'Hour\'、\'1 Month\'、\'12 Month\'、\'GB·Month\'），标注 moduleSum 的时间维度。BSS 响应不返回此字段，由 mapping 维护方在 pricingTarget.pricingUnit 显式声明。Subscription 场景可不配（CLI 端会从 Period+PeriodUnit 反推），PayAsYouGo 场景需 mapping 配，否则金额无量纲', 'type' => 'string'], + 'modules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'moduleCode' => ['type' => 'string', 'description' => ''], + 'costAfterDiscount' => ['type' => 'number', 'format' => 'float', 'description' => ''], + 'originalCost' => ['type' => 'number', 'format' => 'float', 'description' => ''], + 'invoiceDiscount' => ['title' => '本模块的优惠金额（折扣额）；invoiceDiscount = originalCost - costAfterDiscount，由 BSS 上游精确给出（含税场景自己减容易丢精度）', 'type' => 'number', 'format' => 'float'], + 'unitPrice' => ['title' => '本模块的单价（按计费单位，如 元/小时、元/月、元/份）；用于在多数量/多周期场景下解释 costAfterDiscount 的构成', 'type' => 'number', 'format' => 'float'], + ], + 'description' => '', + ], + 'description' => '', + ], + ], + 'description' => '', + ], + 'upstreamRequestId' => ['title' => '上游询价 API 的 requestId（如 BSS GetSubscriptionPrice 的 RequestId），无论成功失败都填充，用于审计对账与上游日志追溯', 'type' => 'string'], + 'errorCode' => ['title' => '上游询价失败时的错误码（如 InvalidParameter / COMMODITY.INVALID_COMPONENT），success=true 时为空', 'type' => 'string'], + 'errorMessage' => ['title' => '上游询价失败时的错误描述，便于调用方自排查具体参数问题，success=true 时为空', 'type' => 'string'], + 'components' => [ + 'title' => 'composite/delta 模式下每次询价调用的明细，key 为 priceCall id（如 prepaid、postpaid 或自定义 id）。single 模式为空；calculatedAmount 是各 component 按 priceCalculation 表达式汇总后的结果，components 暴露分项以便调用方查看构成（如实例费 vs 存储费）', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'currency' => ['type' => 'string'], + 'tradePrice' => ['type' => 'number', 'format' => 'float'], + 'originalPrice' => ['title' => '本次询价折扣前的原价合计；当 originalPrice 与 tradePrice/moduleSum 不一致时，说明应用了优惠（如新购首单折扣、促销活动）', 'type' => 'number', 'format' => 'float'], + 'moduleSum' => ['type' => 'number', 'format' => 'float'], + 'effectiveModuleSum' => ['type' => 'number', 'format' => 'float'], + 'quantity' => ['title' => '询价数量（来自 OpenAPI 入参，如 ECS RunInstances 的 Amount）。moduleSum 是单台单价，effectiveModuleSum = moduleSum × quantity 是总价；调用方应据此向用户呈现 N 台的真实总额，避免把单价误认为总价', 'type' => 'number', 'format' => 'float'], + 'pricingUnit' => ['title' => '计费周期单位（如 \'Hour\'、\'1 Month\'、\'12 Month\'、\'GB·Month\'），标注 moduleSum 的时间维度。BSS 响应不返回此字段，由 mapping 维护方在 pricingTarget.pricingUnit 显式声明。Subscription 场景可不配（CLI 端会从 Period+PeriodUnit 反推），PayAsYouGo 场景需 mapping 配，否则金额无量纲', 'type' => 'string'], + 'modules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'moduleCode' => ['type' => 'string'], + 'costAfterDiscount' => ['type' => 'number', 'format' => 'float'], + 'originalCost' => ['type' => 'number', 'format' => 'float'], + 'invoiceDiscount' => ['title' => '本模块的优惠金额（折扣额）；invoiceDiscount = originalCost - costAfterDiscount，由 BSS 上游精确给出（含税场景自己减容易丢精度）', 'type' => 'number', 'format' => 'float'], + 'unitPrice' => ['title' => '本模块的单价（按计费单位，如 元/小时、元/月、元/份）；用于在多数量/多周期场景下解释 costAfterDiscount 的构成', 'type' => 'number', 'format' => 'float'], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + 'requestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => 'Id of the request'], ], - 'example' => 'zh_CH', + 'description' => 'Schema of Response', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"price\\": {\\n \\"pricingMode\\": \\"\\",\\n \\"success\\": true,\\n \\"currency\\": \\"\\",\\n \\"calculatedAmount\\": 0,\\n \\"priceSummary\\": {\\n \\"currency\\": \\"\\",\\n \\"tradePrice\\": 0,\\n \\"originalPrice\\": 0,\\n \\"moduleSum\\": 0,\\n \\"effectiveModuleSum\\": 0,\\n \\"quantity\\": 0,\\n \\"pricingUnit\\": \\"\\",\\n \\"modules\\": [\\n {\\n \\"moduleCode\\": \\"\\",\\n \\"costAfterDiscount\\": 0,\\n \\"originalCost\\": 0,\\n \\"invoiceDiscount\\": 0,\\n \\"unitPrice\\": 0\\n }\\n ]\\n },\\n \\"upstreamRequestId\\": \\"\\",\\n \\"errorCode\\": \\"\\",\\n \\"errorMessage\\": \\"\\",\\n \\"components\\": {\\n \\"key\\": {\\n \\"currency\\": \\"\\",\\n \\"tradePrice\\": 0,\\n \\"originalPrice\\": 0,\\n \\"moduleSum\\": 0,\\n \\"effectiveModuleSum\\": 0,\\n \\"quantity\\": 0,\\n \\"pricingUnit\\": \\"\\",\\n \\"modules\\": [\\n {\\n \\"moduleCode\\": \\"\\",\\n \\"costAfterDiscount\\": 0,\\n \\"originalCost\\": 0,\\n \\"invoiceDiscount\\": 0,\\n \\"unitPrice\\": 0\\n }\\n ]\\n }\\n }\\n },\\n \\"requestId\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetPrice' => [ + 'summary' => '该接口为询价接口，用户可通过此接口查询资源价格。', + 'path' => '/api/v1/providers/{provider}/products/{product}/price/*', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ 'name' => 'requestPath', 'in' => 'path', 'schema' => [ - 'description' => '请求路径。格式为：'."\n" - .'/api/v1/providers/{provider}/products/{product}/resourceTypes/{resourceType}'."\n" + 'title' => 'A short description of struct', + 'description' => '请求路径。格式为： /api/v1/providers/{provider}/products/{product}/price/{resourceType}'."\n" ."\n" .'请求路径中变量说明：'."\n" ."\n" @@ -119,30 +390,171 @@ ."\n" .'product: 产品Code。'."\n" ."\n" - .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/{资源类型code}', + .'resourceType: 资源Type。以Redis Account为例，resourceType为DBInstance/Account'."\n" + ."\n" + .'目前支持询价的资源列表如下：'."\n" + ."\n" + .'Redis DBInstance: /api/v1/providers/aliyun/products/Redis/price/DBInstance'."\n" + ."\n" + .'ECS Instance: /api/v1/providers/aliyun/products/ECS/price/Instance'."\n" + ."\n" + .'RDS DBInstance: /api/v1/providers/aliyun/products/RDS/price/DBInstance'."\n" + ."\n" + .'SLB LoadBalancer: /api/v1/providers/aliyun/products/SLB/price/LoadBalancer'."\n" + ."\n" + .'ClickHouse DBCluster: /api/v1/providers/aliyun/products/ClickHouse/price/DBCluster'."\n" + ."\n" + .'AliKafka Instance: /api/v1/providers/aliyun/products/AliKafka/price/Instance', 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => '无父资源： /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance'."\n" - .' '."\n" - .'有父资源： /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance/Account', - 'default' => '0', + 'enumValueTitles' => ['/api/v1/providers/aliyun/products/Redis/price/DBInstance' => 'Redis DBInstance', '/api/v1/providers/aliyun/products/AliKafka/price/Instance' => 'AliKafka Instance', '/api/v1/providers/aliyun/products/ECS/price/Instance' => 'ECS Instance', '/api/v1/providers/aliyun/products/ClickHouse/price/DBCluster' => 'ClickHouse DBCluster', '/api/v1/providers/aliyun/products/RDS/price/DBInstance' => 'RDS DBInstance', '/api/v1/providers/aliyun/products/SLB/price/LoadBalancer' => 'SLB LoadBalancer'], + 'example' => '/api/v1/providers/aliyun/products/SLB/price/LoadBalancer', ], ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。若云产品是region化产品，则此参数为必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'."\n"], + ], + [ + 'name' => 'resourceAttributes', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '询价属性（json格式）。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "LoadBalancerName": "cc-test",'."\n" + .' "LoadBalancerSpec": "slb.s3.small",'."\n" + .' "InternetChargeType": "paybybandwidth",'."\n" + .' "AddressType": "internet",'."\n" + .' "PaymentType": "PayAsYouGo",'."\n" + .' "Bandwidth": 6'."\n" + .' }'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + 'price' => [ + 'description' => '价格', + 'type' => 'object', + 'properties' => [ + 'currency' => [ + 'description' => '币种。取值范围：CNY：人民币。USD：美元。JPY：日元。', + 'type' => 'string', + 'enumValueTitles' => ['JPY' => 'JPY', 'USD' => 'USD', 'CNY' => 'CNY'], + 'example' => 'CNY', + ], + 'discountPrice' => ['description' => '折扣', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'moduleDetails' => [ + 'description' => '计价模块价格详情', + 'type' => 'array', + 'items' => [ + 'description' => '计价模块价格详情', + 'type' => 'object', + 'properties' => [ + 'costAfterDiscount' => ['description' => '优惠价', 'type' => 'number', 'format' => 'float', 'example' => '0.02'], + 'invoiceDiscount' => ['description' => '折扣', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'moduleCode' => ['description' => '计价模块标识', 'type' => 'string', 'example' => 'InstanceRent'], + 'moduleName' => ['description' => '计价模块名称', 'type' => 'string', 'example' => 'InstanceRent'], + 'originalCost' => ['description' => '原价', 'type' => 'number', 'format' => 'float', 'example' => '1000.0'], + 'priceType' => ['description' => '价格类型', 'type' => 'string', 'example' => '1.0'], + ], + ], + ], + 'originalPrice' => ['description' => '原价', 'type' => 'number', 'format' => 'float', 'example' => '760.0'], + 'promotionDetails' => [ + 'description' => '优惠详情', + 'type' => 'array', + 'items' => [ + 'description' => '优惠详情', + 'type' => 'object', + 'properties' => [ + 'promotionDesc' => ['description' => '优惠描述', 'type' => 'string', 'example' => '37284'], + 'promotionId' => ['description' => '优惠标识', 'type' => 'integer', 'format' => 'int64', 'example' => '数据盘享8.5折'], + 'promotionName' => ['description' => '优惠名称', 'type' => 'string', 'example' => '数据盘享8.5折'], + ], + ], + ], + 'tradePrice' => ['description' => '优惠价', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + ], ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"price\\": {\\n \\"currency\\": \\"CNY\\",\\n \\"discountPrice\\": 0,\\n \\"moduleDetails\\": [\\n {\\n \\"costAfterDiscount\\": 0.02,\\n \\"invoiceDiscount\\": 0,\\n \\"moduleCode\\": \\"InstanceRent\\",\\n \\"moduleName\\": \\"InstanceRent\\",\\n \\"originalCost\\": 1000,\\n \\"priceType\\": \\"1.0\\"\\n }\\n ],\\n \\"originalPrice\\": 760,\\n \\"promotionDetails\\": [\\n {\\n \\"promotionDesc\\": \\"37284\\",\\n \\"promotionId\\": 0,\\n \\"promotionName\\": \\"数据盘享8.5折\\"\\n }\\n ],\\n \\"tradePrice\\": 0\\n },\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', + 'title' => '资源询价', + 'changeSet' => [ + ['createdAt' => '2024-08-22T08:59:46.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrice'], + ], + ], + ], + 'GetResourceType' => [ + 'summary' => '获取资源元数据。', + 'path' => '/api/v1/providers/{provider}/products/{product}/resourceTypes/*', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'x-acs-accept-language', + 'in' => 'header', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '选择返回产品的语言。'."\n" + ."\n" + .'zh_CH：中文 （默认）'."\n" + ."\n" + .'en_US：英文。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['zh_CH' => 'zh_CH', 'en_US' => 'en_US'], + 'example' => 'zh_CH', + ], + ], + [ + 'name' => 'requestPath', + 'in' => 'path', + 'schema' => ['description' => '请求路径。格式为：'."\n" + .'/api/v1/providers/{provider}/products/{product}/resourceTypes/{resourceType}'."\n" + ."\n" + .'请求路径中变量说明：'."\n" + ."\n" + .'provider: 云厂商，目前只支持Aliyun。'."\n" + ."\n" + .'product: 产品Code。'."\n" + ."\n" + .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/{资源类型code}', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'No parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance'."\n" + ."\n" + .'Has parent resource: /api/v1/providers/Aliyun/products/Redis/resourceTypes/DBInstance/Account', 'default' => '0'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], 'resourceType' => [ 'description' => '资源类型。', 'type' => 'object', @@ -150,48 +562,28 @@ 'createOnlyProperties' => [ 'description' => '创建操作私有参数集合。资源查询操作中不会返回的属性，但是创建操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '创建操作私有参数。', - 'type' => 'string', - 'example' => '/properties/AutoRenew', - ], + 'items' => ['description' => '创建操作私有参数。', 'type' => 'string', 'example' => '/properties/AutoRenew'], ], 'deleteOnlyProperties' => [ 'description' => '删除操作私有参数集合。资源查询操作中不会返回的属性，但是删除操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '删除操作私有参数。', - 'type' => 'string', - 'example' => '/properties/ForceDelete', - ], + 'items' => ['description' => '删除操作私有参数。', 'type' => 'string', 'example' => '/properties/ForceDelete'], ], 'filterProperties' => [ 'description' => 'list操作时可以作为filter参数的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => 'filter参数。', - 'type' => 'string', - 'example' => ' '."\n" - .'/properties/ResourceGroupId', - ], + 'items' => ['description' => 'filter参数。', 'type' => 'string', 'example' => ' '."\n" + .'/properties/ResourceGroupId'], ], 'getOnlyProperties' => [ 'description' => '查询操作私有参数集合。资源查询操作中不会返回的属性，但是查询操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '查询操作私有参数。', - 'type' => 'string', - 'example' => '/properties/DryRun', - ], + 'items' => ['description' => '查询操作私有参数。', 'type' => 'string', 'example' => '/properties/DryRun'], ], 'getResponseProperties' => [ 'description' => '查询返回的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => '查询返回的属性。', - 'type' => 'string', - 'example' => '/properties/NetworkInterfaces/items/properties/IpvSets', - ], + 'items' => ['description' => '查询返回的属性。', 'type' => 'string', 'example' => '/properties/NetworkInterfaces/items/properties/IpvSets'], ], 'handlers' => [ 'description' => '支持的资源操作信息（包括RAM权限）。', @@ -204,11 +596,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:CreateInstance', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:CreateInstance'], ], ], ], @@ -219,11 +607,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:DeleteInstance', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:DeleteInstance'], ], ], ], @@ -234,11 +618,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:DescribeInstanceAttachmentAttributes', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:DescribeInstanceAttachmentAttributes'], ], ], ], @@ -249,11 +629,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:DescribeInstances', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:DescribeInstances'], ], ], ], @@ -264,11 +640,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:ModifyInstanceNetworkSpec', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:ModifyInstanceNetworkSpec'], ], ], ], @@ -278,170 +650,404 @@ 'description' => '资源类型基础信息。', 'type' => 'object', 'properties' => [ - 'chargeType' => [ - 'description' => '付费形式'."\n" - ."\n" - .'paid（付费）'."\n" - .'free（免费）', - 'type' => 'string', - 'example' => 'paid', - ], - 'deliveryScope' => [ - 'description' => '交付级别 '."\n" - ."\n" - .'center（中心化部署级别）'."\n" - ."\n" - .'region（地域部署级别）'."\n" - ."\n" - .'zone（可用区部署级别）', - 'type' => 'string', - 'example' => 'region', - ], - 'description' => [ - 'description' => '资源类型描述。', - 'type' => 'string', - 'example' => 'An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.', - ], - 'title' => [ - 'description' => '资源类型名称。', - 'type' => 'string', - 'example' => 'Instance', - ], + 'chargeType' => ['description' => '付费形式'."\n" + ."\n" + .'paid（付费）'."\n" + .'free（免费）', 'type' => 'string', 'example' => 'paid'], + 'deliveryScope' => ['description' => '交付级别 '."\n" + ."\n" + .'center（中心化部署级别）'."\n" + ."\n" + .'region（地域部署级别）'."\n" + ."\n" + .'zone（可用区部署级别）', 'type' => 'string', 'example' => 'region'], + 'description' => ['description' => '资源类型描述。', 'type' => 'string', 'example' => 'An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.'], + 'title' => ['description' => '资源类型名称。', 'type' => 'string', 'example' => 'Instance'], ], ], 'listOnlyProperties' => [ 'description' => '列举操作私有参数集合。资源查询操作中不会返回的属性，但是列举操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '列举操作私有参数。', - 'type' => 'string', - 'example' => '/properties/DryRun', - ], + 'items' => ['description' => '列举操作私有参数。', 'type' => 'string', 'example' => '/properties/DryRun'], ], 'listResponseProperties' => [ 'description' => '列举返回的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => '列举返回的属性。', - 'type' => 'string', - 'example' => '/properties/InstanceId', - ], - ], - 'primaryIdentifier' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => '/properties/InstanceId'."\n", - ], - 'product' => [ - 'description' => '产品Code。', - 'type' => 'string', - 'example' => 'ECS', - ], - 'properties' => [ - 'description' => '资源属性定义，key是属性名，value为属性详细信息。', - 'type' => 'object', + 'items' => ['description' => '列举返回的属性。', 'type' => 'string', 'example' => '/properties/InstanceId'], ], + 'primaryIdentifier' => ['description' => '资源ID。', 'type' => 'string', 'example' => '/properties/InstanceId'."\n"], + 'product' => ['description' => '产品Code。', 'type' => 'string', 'example' => 'ECS'], + 'properties' => ['description' => '资源属性定义，key是属性名，value为属性详细信息。', 'type' => 'object'], 'publicProperties' => [ 'description' => '公共的属性集合，为资源基本属性。非操作私有参数。', 'type' => 'array', - 'items' => [ - 'description' => '公共属性。', - 'type' => 'string', - 'example' => ' '."\n" - .'/properties/Description', - ], + 'items' => ['description' => '公共属性。', 'type' => 'string', 'example' => ' '."\n" + .'/properties/Description'], ], 'readOnlyProperties' => [ 'description' => '只读参数集合，只在list或者get操作中返回，创建及变更时不作为入参。', 'type' => 'array', - 'items' => [ - 'description' => '只读参数。', - 'type' => 'string', - 'example' => '/properties/CreateTime', - ], + 'items' => ['description' => '只读参数。', 'type' => 'string', 'example' => '/properties/CreateTime'], ], 'required' => [ 'description' => '资源创建必填参数集合。', 'type' => 'array', - 'items' => [ - 'description' => '资源创建必填参数。', - 'type' => 'string', - 'example' => 'RegionId', - ], - ], - 'resourceType' => [ - 'description' => '资源类型。资源有父资源时，返回格式为{父资源类型code/资源类型code}。', - 'type' => 'string', - 'example' => '无父资源：'."\n" - .'Instance'."\n" - .'有父资源：'."\n" - .'DBInstance/Account', + 'items' => ['description' => '资源创建必填参数。', 'type' => 'string', 'example' => 'RegionId'], ], + 'resourceType' => ['description' => '资源类型。资源有父资源时，返回格式为{父资源类型code/资源类型code}。', 'type' => 'string', 'example' => '无父资源：'."\n" + .'Instance'."\n" + .'有父资源：'."\n" + .'DBInstance/Account'], 'sensitiveInfoProperties' => [ 'description' => '敏感属性集合，例如密码等。', 'type' => 'array', - 'items' => [ - 'description' => '敏感属性。', - 'type' => 'string', - 'example' => '/properties/VncPassword', - ], + 'items' => ['description' => '敏感属性。', 'type' => 'string', 'example' => '/properties/VncPassword'], ], 'updateOnlyProperties' => [ 'description' => '更新操作私有参数集合。资源查询操作中不会返回的属性，但是更新操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '更新操作私有参数。', - 'type' => 'string', - 'example' => '/properties/DryRun', - ], + 'items' => ['description' => '更新操作私有参数。', 'type' => 'string', 'example' => '/properties/DryRun'], ], 'updateTypeProperties' => [ 'description' => '可以修改的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => '可改属性。', - 'type' => 'string', - 'example' => '/properties/InstanceName', - ], + 'items' => ['description' => '可改属性。', 'type' => 'string', 'example' => '/properties/InstanceName'], ], ], + 'example' => 'No parent resource:'."\n" + .'Instance'."\n" + .'Has parent resource:'."\n" + .'DBInstance/Account', ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"resourceType\\": {\\n \\"createOnlyProperties\\": [\\n \\"/properties/AutoRenew\\"\\n ],\\n \\"deleteOnlyProperties\\": [\\n \\"/properties/ForceDelete\\"\\n ],\\n \\"filterProperties\\": [\\n \\"\\\\t\\\\n/properties/ResourceGroupId\\"\\n ],\\n \\"getOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"getResponseProperties\\": [\\n \\"/properties/NetworkInterfaces/items/properties/IpvSets\\"\\n ],\\n \\"handlers\\": {\\n \\"create\\": {\\n \\"permissions\\": [\\n \\"ecs:CreateInstance\\"\\n ]\\n },\\n \\"delete\\": {\\n \\"permissions\\": [\\n \\"ecs:DeleteInstance\\"\\n ]\\n },\\n \\"get\\": {\\n \\"permissions\\": [\\n \\"ecs:DescribeInstanceAttachmentAttributes\\"\\n ]\\n },\\n \\"list\\": {\\n \\"permissions\\": [\\n \\"ecs:DescribeInstances\\"\\n ]\\n },\\n \\"update\\": {\\n \\"permissions\\": [\\n \\"ecs:ModifyInstanceNetworkSpec\\"\\n ]\\n }\\n },\\n \\"info\\": {\\n \\"chargeType\\": \\"paid\\",\\n \\"deliveryScope\\": \\"region\\",\\n \\"description\\": \\"An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.\\",\\n \\"title\\": \\"Instance\\"\\n },\\n \\"listOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"listResponseProperties\\": [\\n \\"/properties/InstanceId\\"\\n ],\\n \\"primaryIdentifier\\": \\"/properties/InstanceId\\\\n\\",\\n \\"product\\": \\"ECS\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"publicProperties\\": [\\n \\"\\\\t\\\\n/properties/Description\\"\\n ],\\n \\"readOnlyProperties\\": [\\n \\"/properties/CreateTime\\"\\n ],\\n \\"required\\": [\\n \\"RegionId\\"\\n ],\\n \\"resourceType\\": \\"无父资源：\\\\nInstance\\\\n有父资源：\\\\nDBInstance/Account\\",\\n \\"sensitiveInfoProperties\\": [\\n \\"/properties/VncPassword\\"\\n ],\\n \\"updateOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"updateTypeProperties\\": [\\n \\"/properties/InstanceName\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询资源类型的详情', + 'changeSet' => [ + ['createdAt' => '2023-01-04T07:13:59.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceType'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"resourceType\\": {\\n \\"createOnlyProperties\\": [\\n \\"/properties/AutoRenew\\"\\n ],\\n \\"deleteOnlyProperties\\": [\\n \\"/properties/ForceDelete\\"\\n ],\\n \\"filterProperties\\": [\\n \\"\\\\t\\\\n/properties/ResourceGroupId\\"\\n ],\\n \\"getOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"getResponseProperties\\": [\\n \\"/properties/NetworkInterfaces/items/properties/IpvSets\\"\\n ],\\n \\"handlers\\": {\\n \\"create\\": {\\n \\"permissions\\": [\\n \\"ecs:CreateInstance\\"\\n ]\\n },\\n \\"delete\\": {\\n \\"permissions\\": [\\n \\"ecs:DeleteInstance\\"\\n ]\\n },\\n \\"get\\": {\\n \\"permissions\\": [\\n \\"ecs:DescribeInstanceAttachmentAttributes\\"\\n ]\\n },\\n \\"list\\": {\\n \\"permissions\\": [\\n \\"ecs:DescribeInstances\\"\\n ]\\n },\\n \\"update\\": {\\n \\"permissions\\": [\\n \\"ecs:ModifyInstanceNetworkSpec\\"\\n ]\\n }\\n },\\n \\"info\\": {\\n \\"chargeType\\": \\"paid\\",\\n \\"deliveryScope\\": \\"region\\",\\n \\"description\\": \\"An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.\\",\\n \\"title\\": \\"Instance\\"\\n },\\n \\"listOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"listResponseProperties\\": [\\n \\"/properties/InstanceId\\"\\n ],\\n \\"primaryIdentifier\\": \\"/properties/InstanceId\\\\n\\",\\n \\"product\\": \\"ECS\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"publicProperties\\": [\\n \\"\\\\t\\\\n/properties/Description\\"\\n ],\\n \\"readOnlyProperties\\": [\\n \\"/properties/CreateTime\\"\\n ],\\n \\"required\\": [\\n \\"RegionId\\"\\n ],\\n \\"resourceType\\": \\"无父资源：\\\\nInstance\\\\n有父资源：\\\\nDBInstance/Account\\",\\n \\"sensitiveInfoProperties\\": [\\n \\"/properties/VncPassword\\"\\n ],\\n \\"updateOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"updateTypeProperties\\": [\\n \\"/properties/InstanceName\\"\\n ]\\n }\\n}","type":"json"}]', ], - 'ListProducts' => [ - 'summary' => '列举支持的产品。', - 'path' => '/api/v1/providers/{provider}/products', - 'methods' => [ - 'get', + 'GetResources' => [ + 'summary' => '通过此接口查询资源。', + 'path' => '/api/v1/providers/{provider}/products/{product}/resources/*', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'requestPath', + 'in' => 'path', + 'schema' => ['description' => '请求路径。'."\n" + ."\n" + .'根据不同的请求路径，用户可分别调用资源的List操作或Get操作。'."\n" + .'- List：`/api/v1/providers/{provider}/products/{product}/resources/{resourceType}`'."\n" + ."\n" + .'- Get：`/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}`'."\n" + ."\n" + .'请求路径中包含以下变量：'."\n" + .'- provider：云厂商。当前仅支持传入`Aliyun`。'."\n" + .'- product：产品Code。'."\n" + .'- resourceType：[资源类型](~~2246871~~)。存在父资源时，格式为`{父资源类型code}/父资源ID/{资源类型code}`。'."\n" + .'- resourceId：资源ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'List (no parent resource):'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance'."\n" + ."\n" + .'List (has parent resource):'."\n" + .'/api/v1/providers/aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account'."\n" + ."\n" + .'Get (no parent resource):'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****'."\n" + ."\n" + .'Get (has parent resource):'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user****'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。若云产品是region化产品，则此参数为必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'."\n"], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '资源过滤条件。'."\n" + ."\n" + .'该参数支持以JSON格式传入多组键值对，用于对资源进行过滤。当某个云产品的资源在执行List或Get操作时，若对应操作支持根据特定属性进行过滤，则可将该属性作为filter参数的过滤条件。'."\n" + .'> 不同资源类型支持的过滤字段可能存在差异，具体支持字段请参见对应资源的OpenAPI文档。 '."\n" + ."\n" + .'例如，DBInstance资源支持通过`EditionType`及`PaymentType`字段进行过滤。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "EditionType": "Community",'."\n" + .' "PaymentType": "PostPaid"'."\n" + .'}'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页游标。'."\n" + .'- 首次查询时可不设置该参数，系统将默认返回第一页数据。'."\n" + .'- 非首次查询时，需传入上一次调用该接口返回的nextToken值。'."\n" + .'> 若传入参数中仅包含数字，云控制API会将其视为页码`PageNumber`进行分页处理。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAdDWBF2****'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '分页查询时每页的最大记录条数。最大值：100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'maxResults' => ['description' => '本次请求所返回的最大记录条数。List操作返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'nextToken' => ['description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕。List操作返回。', 'type' => 'string', 'example' => 'AAAAAdDWBF2****'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + 'resource' => [ + 'description' => '指定资源。Get操作返回。', + 'type' => 'object', + 'properties' => [ + 'resourceAttributes' => ['description' => '资源属性（JSON格式）。', 'type' => 'object', 'example' => '{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}'], + 'resourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'cctest'], + ], + ], + 'resources' => [ + 'description' => '资源列表。List操作返回。', + 'type' => 'array', + 'items' => [ + 'description' => '资源。', + 'type' => 'object', + 'properties' => [ + 'resourceAttributes' => ['description' => '资源属性（JSON格式）。', 'type' => 'object', 'example' => '{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}'], + 'resourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'cctest'], + ], + ], + ], + 'totalCount' => ['description' => '本次请求条件下的数据总量。List操作返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"AAAAAdDWBF2****\\",\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"resource\\": {\\n \\"resourceAttributes\\": {\\n \\"Status\\": \\"Available\\",\\n \\"Description\\": \\"\\",\\n \\"AccountPrivilege\\": \\"RoleReadWrite\\",\\n \\"InstanceId\\": \\"r-2ze8v41uei31lo****\\",\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"TypeInfo\\": {},\\n \\"AccountName\\": \\"cctest\\"\\n },\\n \\"resourceId\\": \\"cctest\\"\\n },\\n \\"resources\\": [\\n {\\n \\"resourceAttributes\\": {\\n \\"Status\\": \\"Available\\",\\n \\"Description\\": \\"\\",\\n \\"AccountPrivilege\\": \\"RoleReadWrite\\",\\n \\"InstanceId\\": \\"r-2ze8v41uei31lo****\\",\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"TypeInfo\\": {},\\n \\"AccountName\\": \\"cctest\\"\\n },\\n \\"resourceId\\": \\"cctest\\"\\n }\\n ],\\n \\"totalCount\\": 20\\n}","type":"json"}]', + 'title' => '查询资源', + 'description' => '用户可前往[在线调试API门户](https://next.api.aliyun.com/cloudcontrol)查看资源文档和体验Cloud Control API。'."\n" + ."\n" + .'此API包括资源的Get和List功能，根据不同的请求路径，用户可分别调用资源List和Get能力。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResources'], + ], ], + ], + 'GetTask' => [ + 'summary' => '通过此接口查询指定异步任务详情。', + 'path' => '/api/v1/tasks/{taskId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['title' => '任务id', 'description' => '任务id。', 'type' => 'string', 'required' => true, 'example' => 'task-433aead756057fff8189a7ce5****'], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + 'task' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '任务创建时间', 'type' => 'string', 'example' => '2022-10-09T00:46:03Z'], + 'error' => [ + 'description' => '任务错误信息。', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'OperationFailure.OperationFailed'], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => '{'."\n" + .' "requestId": "123****",'."\n" + .' "errorCode": "InvalidRamUser.NoPermission",'."\n" + .' "errorMsg": "Ram user is not authorized to perform the operation."'."\n" + .'}'], + ], + ], + 'product' => ['description' => '产品code。', 'type' => 'string', 'example' => 'ECS'], + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'resourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'i-8vbascjthm7kzhp3****'."\n"], + 'resourcePath' => ['description' => '资源路径。相对资源id，资源路径会包含完整的资源定位（父资源/子资源）。', 'type' => 'string', 'example' => 'Instance/i-8vbascjthm7kzhp3****'."\n" + .'Instance/r-8vbf5abe31c9c4d4/Account/cctest'], + 'resourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'Instance'], + 'status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'Pending 排队中'."\n" + ."\n" + .'Running 进行中'."\n" + ."\n" + .'Succeeded 成功完成'."\n" + ."\n" + .'Failed 失败'."\n" + ."\n" + .'Cancelling 取消中'."\n" + ."\n" + .'Cancelled 已取消。', + 'type' => 'string', + 'enumValueTitles' => ['Succeeded' => 'Succeeded', 'Failed' => 'Failed', 'Running' => 'Running', 'Cancelled' => 'Cancelled', 'Pending' => 'Pending', 'Cancelling' => 'Cancelling'], + 'example' => 'Succeeded', + ], + 'taskAction' => [ + 'description' => '任务操作类型（Create | Update | Delete）。', + 'type' => 'string', + 'enumValueTitles' => ['Delete' => 'Delete', 'Create' => 'Create', 'Update' => 'Update'], + 'example' => 'Create', + ], + 'taskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'task-433aead756057fff8189a7ce5****'], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"task\\": {\\n \\"createTime\\": \\"2022-10-09T00:46:03Z\\",\\n \\"error\\": {\\n \\"code\\": \\"OperationFailure.OperationFailed\\",\\n \\"message\\": \\"{\\\\n \\\\\\"requestId\\\\\\": \\\\\\"123****\\\\\\",\\\\n \\\\\\"errorCode\\\\\\": \\\\\\"InvalidRamUser.NoPermission\\\\\\",\\\\n \\\\\\"errorMsg\\\\\\": \\\\\\"Ram user is not authorized to perform the operation.\\\\\\"\\\\n}\\"\\n },\\n \\"product\\": \\"ECS\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"resourceId\\": \\"i-8vbascjthm7kzhp3****\\\\n\\",\\n \\"resourcePath\\": \\"Instance/i-8vbascjthm7kzhp3****\\\\nInstance/r-8vbf5abe31c9c4d4/Account/cctest\\",\\n \\"resourceType\\": \\"Instance\\",\\n \\"status\\": \\"Succeeded\\",\\n \\"taskAction\\": \\"Create\\",\\n \\"taskId\\": \\"task-433aead756057fff8189a7ce5****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询任务', + 'description' => 'GET /api/v1/tasks/{taskId}。', + 'changeSet' => [ + ['createdAt' => '2023-07-04T02:16:46.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'], + ], ], + ], + 'ListDataSources' => [ + 'summary' => '用户通过此接口查询资源属性可选值（RegionID、ZoneId等）。', + 'path' => '/api/v1/providers/{provider}/products/{product}/dataSources/*', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'requestPath', + 'in' => 'path', + 'schema' => ['description' => '请求路径。格式为：'."\n" + .' /api/v1/providers/{provider}/products/{product}/dataSources/{resourceType}'."\n" + ."\n" + .'请求路径中变量说明：'."\n" + ."\n" + .'provider: 云厂商，目前只支持Aliyun。'."\n" + ."\n" + .'product: 产品Code。'."\n" + ."\n" + .'resourceType: 资源类型。'."\n" + ."\n" + .'示例如下：'."\n" + ."\n" + .'Redis DBInstance: /api/v1/providers/Aliyun/products/Redis/dataSources/DBInstance', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '/api/v1/providers/Aliyun/products/Redis/dataSources/DBInstance'], + ], + [ + 'name' => 'attributeName', + 'in' => 'query', + 'schema' => ['description' => '属性名称（当前支持RegionId）。', 'type' => 'string', 'required' => true, 'example' => 'RegionId'], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['title' => '在当前版本下，该参数暂不生效', 'description' => '指定过滤条件。json格式：{"key1":"value1"}。', 'type' => 'object', 'required' => false], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'dataSources' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => '数据ID。', 'type' => 'string', 'example' => 'cn-beijing'], + ], + ], + ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"dataSources\\": [\\n {\\n \\"id\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', + 'title' => '查询资源属性可选值', + 'changeSet' => [ + ['createdAt' => '2024-10-22T02:50:18.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-27T11:41:15.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataSources'], + ], + ], + ], + 'ListProducts' => [ + 'summary' => '列举支持的产品。', + 'path' => '/api/v1/providers/{provider}/products', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'x-acs-accept-language', @@ -455,43 +1061,24 @@ .'en_US：英文。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'zh_CH' => 'zh_CH', - 'en_US' => 'en_US', - ], + 'enumValueTitles' => ['zh_CH' => 'zh_CH', 'en_US' => 'en_US'], 'example' => 'zh_CH', ], ], [ 'name' => 'provider', 'in' => 'path', - 'schema' => [ - 'description' => '云厂商，目前只支持Aliyun。', - 'type' => 'string', - 'required' => true, - 'example' => 'Aliyun', - ], + 'schema' => ['description' => '云厂商，目前只支持Aliyun。', 'type' => 'string', 'required' => true, 'example' => 'Aliyun'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '用来标记当前开始读取的位置，置空表示从头开始。', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'ECS'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页行数。最大值为100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页查询时每页行数。最大值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -501,18 +1088,8 @@ 'description' => '返回结构。', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => '本次请求所返回的最大记录条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕。', - 'type' => 'string', - 'example' => 'Redis', - ], + 'maxResults' => ['description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'nextToken' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'Redis'], 'products' => [ 'description' => '产品列表。', 'type' => 'array', @@ -520,32 +1097,13 @@ 'description' => '产品信息。', 'type' => 'object', 'properties' => [ - 'productCode' => [ - 'description' => '产品code。', - 'type' => 'string', - 'example' => 'ECS', - ], - 'productName' => [ - 'description' => '产品名称。', - 'type' => 'string', - 'example' => 'Elastic Compute Service', - ], + 'productCode' => ['description' => '产品code。', 'type' => 'string', 'example' => 'ECS'], + 'productName' => ['description' => '产品名称。', 'type' => 'string', 'example' => 'Elastic Compute Service'], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'totalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '本次请求条件下的数据总量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + 'totalCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '本次请求条件下的数据总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], @@ -553,36 +1111,28 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"Redis\\",\\n \\"products\\": [\\n {\\n \\"productCode\\": \\"ECS\\",\\n \\"productName\\": \\"Elastic Compute Service\\"\\n }\\n ],\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"totalCount\\": 20\\n}","type":"json"}]', 'title' => '列举产品', 'description' => 'GET /api/v1/providers/{provider}/products。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], + ], + ], ], 'ListResourceTypes' => [ 'summary' => '列举产品的资源类型。', 'path' => '/api/v1/providers/{provider}/products/{product}/resourceTypes', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'x-acs-accept-language', @@ -595,32 +1145,19 @@ .'en_US：英文。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'zh_CH' => 'zh_CH', - 'en_US' => 'en_US', - ], + 'enumValueTitles' => ['zh_CH' => 'zh_CH', 'en_US' => 'en_US'], 'example' => 'zh_CH', ], ], [ 'name' => 'provider', 'in' => 'path', - 'schema' => [ - 'description' => '云厂商，目前只支持Aliyun。', - 'type' => 'string', - 'required' => true, - 'example' => 'Aliyun', - ], + 'schema' => ['description' => '云厂商，目前只支持Aliyun。', 'type' => 'string', 'required' => true, 'example' => 'Aliyun'], ], [ 'name' => 'product', 'in' => 'path', - 'schema' => [ - 'description' => '产品Code。', - 'type' => 'string', - 'required' => true, - 'example' => 'ECS', - ], + 'schema' => ['description' => '产品Code。', 'type' => 'string', 'required' => true, 'example' => 'ECS'], ], [ 'name' => 'resourceTypes', @@ -629,35 +1166,19 @@ 'schema' => [ 'description' => '资源类型列表。', 'type' => 'array', - 'items' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Instance', - ], + 'items' => ['description' => '资源类型。', 'type' => 'string', 'required' => false, 'example' => 'Instance'], 'required' => false, ], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '用来标记当前开始读取的位置，置空表示从头开始。', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS::Disk', - ], + 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'ECS::Disk'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页行数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -667,24 +1188,9 @@ 'description' => '返回结构。', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => '本次请求所返回的最大记录条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'type' => 'string', - 'example' => 'ECS::Disk', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], + 'maxResults' => ['description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'nextToken' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'type' => 'string', 'example' => 'ECS::Disk'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], 'resourceTypes' => [ 'description' => '资源类型列表。', 'type' => 'array', @@ -695,47 +1201,27 @@ 'createOnlyProperties' => [ 'description' => '创建操作私有参数集合。资源查询操作中不会返回的属性，但是创建操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '创建操作私有参数。', - 'type' => 'string', - 'example' => '/properties/AutoRenew', - ], + 'items' => ['description' => '创建操作私有参数。', 'type' => 'string', 'example' => '/properties/AutoRenew'], ], 'deleteOnlyProperties' => [ 'description' => '删除操作私有参数集合。资源查询操作中不会返回的属性，但是删除操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '删除操作私有参数。', - 'type' => 'string', - 'example' => '/properties/ForceDelete', - ], + 'items' => ['description' => '删除操作私有参数。', 'type' => 'string', 'example' => '/properties/ForceDelete'], ], 'filterProperties' => [ 'description' => 'list操作时可以作为filter参数的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => 'filter参数。', - 'type' => 'string', - 'example' => '/properties/ResourceGroupId', - ], + 'items' => ['description' => 'filter参数。', 'type' => 'string', 'example' => '/properties/ResourceGroupId'], ], 'getOnlyProperties' => [ 'description' => '查询操作私有参数集合。资源查询操作中不会返回的属性，但是查询操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '查询操作私有参数。', - 'type' => 'string', - 'example' => '/properties/DryRun'."\n", - ], + 'items' => ['description' => '查询操作私有参数。', 'type' => 'string', 'example' => '/properties/DryRun'."\n"], ], 'getResponseProperties' => [ 'description' => '查询返回的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => '查询返回的属性。', - 'type' => 'string', - 'example' => '/properties/NetworkInterfaces/items/properties/IpvSets', - ], + 'items' => ['description' => '查询返回的属性。', 'type' => 'string', 'example' => '/properties/NetworkInterfaces/items/properties/IpvSets'], ], 'handlers' => [ 'description' => '支持的资源操作信息（包括RAM权限）。', @@ -748,11 +1234,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:CreateInstance', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:CreateInstance'], ], ], ], @@ -763,11 +1245,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:DeleteInstance', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:DeleteInstance'], ], ], ], @@ -778,11 +1256,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:DescribeInstanceAttachmentAttributes', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:DescribeInstanceAttachmentAttributes'], ], ], ], @@ -793,11 +1267,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:DescribeInstances', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:DescribeInstances'], ], ], ], @@ -808,11 +1278,7 @@ 'permissions' => [ 'description' => '所需RAM权限信息集合。', 'type' => 'array', - 'items' => [ - 'description' => 'RAM权限。', - 'type' => 'string', - 'example' => 'ecs:ModifyInstanceNetworkSpec', - ], + 'items' => ['description' => 'RAM权限。', 'type' => 'string', 'example' => 'ecs:ModifyInstanceNetworkSpec'], ], ], ], @@ -827,10 +1293,7 @@ .'paid（付费）'."\n" .'free（免费）', 'type' => 'string', - 'enumValueTitles' => [ - 'paid' => 'paid', - 'free' => 'free', - ], + 'enumValueTitles' => ['paid' => 'paid', 'free' => 'free'], 'example' => 'paid', ], 'deliveryScope' => [ @@ -842,126 +1305,61 @@ ."\n" .'zone（可用区部署级别）', 'type' => 'string', - 'enumValueTitles' => [ - 'zone' => 'zone', - 'center' => 'center', - 'region' => 'region', - ], + 'enumValueTitles' => ['zone' => 'zone', 'center' => 'center', 'region' => 'region'], 'example' => 'region', ], - 'description' => [ - 'description' => '资源类型描述。', - 'type' => 'string', - 'example' => 'An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.', - ], - 'title' => [ - 'description' => '资源类型名称。', - 'type' => 'string', - 'example' => 'Instance', - ], + 'description' => ['description' => '资源类型描述。', 'type' => 'string', 'example' => 'An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.'], + 'title' => ['description' => '资源类型名称。', 'type' => 'string', 'example' => 'Instance'], ], ], 'listOnlyProperties' => [ 'description' => '列举操作私有参数集合。资源查询操作中不会返回的属性，但是列举操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '列举操作私有参数。', - 'type' => 'string', - 'example' => '/properties/DryRun', - ], + 'items' => ['description' => '列举操作私有参数。', 'type' => 'string', 'example' => '/properties/DryRun'], ], 'listResponseProperties' => [ 'description' => '列举返回的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => '列举返回的属性。', - 'type' => 'string', - 'example' => '/properties/InstanceId', - ], - ], - 'primaryIdentifier' => [ - 'description' => '资源ID', - 'type' => 'string', - 'example' => '/properties/InstanceId', - ], - 'product' => [ - 'description' => '产品Code。', - 'type' => 'string', - 'example' => 'ECS', - ], - 'properties' => [ - 'description' => '资源属性定义，key是属性名，value为属性详细信息。', - 'type' => 'object', + 'items' => ['description' => '列举返回的属性。', 'type' => 'string', 'example' => '/properties/InstanceId'], ], + 'primaryIdentifier' => ['description' => '资源ID', 'type' => 'string', 'example' => '/properties/InstanceId'], + 'product' => ['description' => '产品Code。', 'type' => 'string', 'example' => 'ECS'], + 'properties' => ['description' => '资源属性定义，key是属性名，value为属性详细信息。', 'type' => 'object'], 'publicProperties' => [ 'description' => '公共的属性集合，为资源基本属性。非操作私有参数。', 'type' => 'array', - 'items' => [ - 'description' => '公共属性。', - 'type' => 'string', - 'example' => '/properties/Description', - ], + 'items' => ['description' => '公共属性。', 'type' => 'string', 'example' => '/properties/Description'], ], 'readOnlyProperties' => [ 'description' => '只读参数集合，只在list或者get操作中返回，创建及变更时不作为入参。', 'type' => 'array', - 'items' => [ - 'description' => '只读参数', - 'type' => 'string', - 'example' => '/properties/CreateTime', - ], + 'items' => ['description' => '只读参数', 'type' => 'string', 'example' => '/properties/CreateTime'], ], 'required' => [ 'description' => '资源创建必填参数集合。', 'type' => 'array', - 'items' => [ - 'description' => '资源创建必填参数。', - 'type' => 'string', - 'example' => 'RegionId', - ], - ], - 'resourceType' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'Instance', + 'items' => ['description' => '资源创建必填参数。', 'type' => 'string', 'example' => 'RegionId'], ], + 'resourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'Instance'], 'sensitiveInfoProperties' => [ 'description' => '敏感属性集合，例如密码等。', 'type' => 'array', - 'items' => [ - 'description' => '敏感属性。', - 'type' => 'string', - 'example' => '/properties/VncPassword', - ], + 'items' => ['description' => '敏感属性。', 'type' => 'string', 'example' => '/properties/VncPassword'], ], 'updateOnlyProperties' => [ 'description' => '更新操作私有参数集合。资源查询操作中不会返回的属性，但是更新操作中需要传入的参数。', 'type' => 'array', - 'items' => [ - 'description' => '更新操作私有参数。', - 'type' => 'string', - 'example' => '/properties/DryRun', - ], + 'items' => ['description' => '更新操作私有参数。', 'type' => 'string', 'example' => '/properties/DryRun'], ], 'updateTypeProperties' => [ 'description' => '可以修改的属性集合。', 'type' => 'array', - 'items' => [ - 'description' => '可改属性。', - 'type' => 'string', - 'example' => '/properties/InstanceName', - ], + 'items' => ['description' => '可改属性。', 'type' => 'string', 'example' => '/properties/InstanceName'], ], ], ], ], - 'totalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '本次请求条件下的数据总量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'totalCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '本次请求条件下的数据总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], @@ -969,550 +1367,135 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"ECS::Disk\\",\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"resourceTypes\\": [\\n {\\n \\"createOnlyProperties\\": [\\n \\"/properties/AutoRenew\\"\\n ],\\n \\"deleteOnlyProperties\\": [\\n \\"/properties/ForceDelete\\"\\n ],\\n \\"filterProperties\\": [\\n \\"/properties/ResourceGroupId\\"\\n ],\\n \\"getOnlyProperties\\": [\\n \\"/properties/DryRun\\\\n\\"\\n ],\\n \\"getResponseProperties\\": [\\n \\"/properties/NetworkInterfaces/items/properties/IpvSets\\"\\n ],\\n \\"handlers\\": {\\n \\"create\\": {\\n \\"permissions\\": [\\n \\"ecs:CreateInstance\\"\\n ]\\n },\\n \\"delete\\": {\\n \\"permissions\\": [\\n \\"ecs:DeleteInstance\\"\\n ]\\n },\\n \\"get\\": {\\n \\"permissions\\": [\\n \\"ecs:DescribeInstanceAttachmentAttributes\\"\\n ]\\n },\\n \\"list\\": {\\n \\"permissions\\": [\\n \\"ecs:DescribeInstances\\"\\n ]\\n },\\n \\"update\\": {\\n \\"permissions\\": [\\n \\"ecs:ModifyInstanceNetworkSpec\\"\\n ]\\n }\\n },\\n \\"info\\": {\\n \\"chargeType\\": \\"paid\\",\\n \\"deliveryScope\\": \\"region\\",\\n \\"description\\": \\"An ECS instance is equivalent to a virtual machine, including the most basic computing components such as CPU, memory, operating system, network, and disk. You can easily customize and change the configuration of the instance. You have full control over the virtual machine.\\",\\n \\"title\\": \\"Instance\\"\\n },\\n \\"listOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"listResponseProperties\\": [\\n \\"/properties/InstanceId\\"\\n ],\\n \\"primaryIdentifier\\": \\"/properties/InstanceId\\",\\n \\"product\\": \\"ECS\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"publicProperties\\": [\\n \\"/properties/Description\\"\\n ],\\n \\"readOnlyProperties\\": [\\n \\"/properties/CreateTime\\"\\n ],\\n \\"required\\": [\\n \\"RegionId\\"\\n ],\\n \\"resourceType\\": \\"Instance\\",\\n \\"sensitiveInfoProperties\\": [\\n \\"/properties/VncPassword\\"\\n ],\\n \\"updateOnlyProperties\\": [\\n \\"/properties/DryRun\\"\\n ],\\n \\"updateTypeProperties\\": [\\n \\"/properties/InstanceName\\"\\n ]\\n }\\n ],\\n \\"totalCount\\": 20\\n}","type":"json"}]', 'title' => '列举资源类型', 'description' => 'GET /api/v1/providers/{provider}/products/{product}/resourceTypes。', - ], - 'CreateResource' => [ - 'summary' => '创建资源。', - 'path' => '/api/v1/providers/{provider}/products/{product}/resources/*', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'requestPath', - 'in' => 'path', - 'schema' => [ - 'description' => '请求路径。格式为：'."\n" - .'/api/v1/providers/{provider}/products/{product}/resources/{resourceType}'."\n" - ."\n" - .'请求路径中变量说明：'."\n" - ."\n" - .'provider: 云厂商，目前只支持Aliyun。'."\n" - ."\n" - .'product: 产品Code。'."\n" - ."\n" - .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/父资源ID/{资源类型code}。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '无父资源：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance'."\n" - .'有父资源：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account', - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。若云产品是region化产品，则此参数为必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '幂等参数。若云产品支持幂等能力，则传入生效。', - 'type' => 'string', - 'required' => false, - 'example' => '1e810dfe1468721d0664a49b9d9f74f4', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求Body。资源属性，以JSON的形式传入。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "AccountName": "cctest",'."\n" - .' "AccountPassword": "Aa1234****"'."\n" - .'}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'x-acs-cloudcontrol-timeout' => [ - 'schema' => [ - 'type' => 'string', - 'backendName' => 'retry-timeout', - ], - ], - ], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'resourceId' => [ - 'title' => '资源id', - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'resourcePath' => [ - 'title' => '资源路径', - 'description' => '资源路径。相对资源id，资源路径会包含完整的资源定位（父资源/子资源）。', - 'type' => 'string', - 'example' => 'Instance/r-8vbf5abe31c9c4d4/Account/cctest', - ], - 'taskId' => [ - 'title' => '任务id', - 'description' => '异步任务ID。当本次操作为异步时，此字段返回，此时HTTP状态码为202。', - 'type' => 'string', - 'example' => 'task-433aead756057fff8189a7ce5****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"resourceId\\": \\"cctest\\",\\n \\"resourcePath\\": \\"Instance/r-8vbf5abe31c9c4d4/Account/cctest\\",\\n \\"taskId\\": \\"task-433aead756057fff8189a7ce5****\\"\\n}","type":"json"}]', - 'title' => '创建资源', - 'description' => '用户可前往[在线调试API门户](https://next.api.aliyun.com/cloudcontrol)查看资源文档和体验Cloud Control API。', - ], - 'DeleteResource' => [ - 'summary' => '用户通过此接口删除资源。', - 'path' => '/api/v1/providers/{provider}/products/{product}/resources/*', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'requestPath', - 'in' => 'path', - 'schema' => [ - 'description' => '请求路径。格式为：'."\n" - .'/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}'."\n" - ."\n" - .'请求路径中变量说明：'."\n" - ."\n" - .'provider: 云厂商，目前只支持Aliyun。'."\n" - ."\n" - .'product: 产品Code。'."\n" - ."\n" - .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/父资源ID/{资源类型code}。'."\n" - ."\n" - .'resourceId: 资源ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '无父资源：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****'."\n" - ."\n" - .'有父资源：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user****', - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。若云产品是region化产品，则此参数为必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing'."\n", - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '幂等参数。若云产品支持幂等能力，则传入生效。', - 'type' => 'string', - 'required' => false, - 'example' => '1e810dfe1468721d0664a49b9d9f74f4', - ], - ], - [ - 'name' => 'filter', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceTypes'], ], ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'x-acs-cloudcontrol-timeout' => [ - 'schema' => [ - 'type' => 'string', - 'backendName' => 'retry-timeout', - ], - ], - ], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'taskId' => [ - 'description' => '异步任务ID。当本次操作为异步时，此字段返回，此时HTTP状态码为202。', - 'type' => 'string', - 'example' => 'task-433aead756057fff8189a7ce5****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"taskId\\": \\"task-433aead756057fff8189a7ce5****\\"\\n}","type":"json"}]', - 'title' => '删除资源', - 'description' => '用户可前往[在线调试API门户](https://next.api.aliyun.com/cloudcontrol)查看资源文档和体验Cloud Control API。', ], - 'GetResources' => [ - 'summary' => '通过此接口查询资源。', - 'path' => '/api/v1/providers/{provider}/products/{product}/resources/*', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSupportedPricingApis' => [ + 'summary' => '列出当前支持询价的 OpenAPI 三元组', + 'path' => '/api/v1/price/supported-apis', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'requestPath', - 'in' => 'path', - 'schema' => [ - 'description' => '请求路径。'."\n" - ."\n" - .'根据不同的请求路径，用户可分别调用资源的List操作或Get操作。'."\n" - .'- List：`/api/v1/providers/{provider}/products/{product}/resources/{resourceType}`'."\n" - ."\n" - .'- Get：`/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}`'."\n" - ."\n" - .'请求路径中包含以下变量：'."\n" - .'- provider：云厂商。当前仅支持传入`Aliyun`。'."\n" - .'- product：产品Code。'."\n" - .'- resourceType：[资源类型](~~2246871~~)。存在父资源时，格式为`{父资源类型code}/父资源ID/{资源类型code}`。'."\n" - .'- resourceId：资源ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'List（无父资源）：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance'."\n" - ."\n" - .'List（有父资源）：'."\n" - .'/api/v1/providers/aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account'."\n" - ."\n" - .'Get（无父资源）：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****'."\n" - ."\n" - .'Get（有父资源）：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user****', - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。若云产品是region化产品，则此参数为必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing'."\n", - ], - ], - [ - 'name' => 'filter', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '资源过滤条件。'."\n" - ."\n" - .'该参数支持以JSON格式传入多组键值对，用于对资源进行过滤。当某个云产品的资源在执行List或Get操作时，若对应操作支持根据特定属性进行过滤，则可将该属性作为filter参数的过滤条件。'."\n" - .'> 不同资源类型支持的过滤字段可能存在差异，具体支持字段请参见对应资源的OpenAPI文档。 '."\n" - ."\n" - .'例如，DBInstance资源支持通过`EditionType`及`PaymentType`字段进行过滤。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "EditionType": "Community",'."\n" - .' "PaymentType": "PostPaid"'."\n" - .'}', - ], - ], - [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '分页游标。'."\n" - .'- 首次查询时可不设置该参数，系统将默认返回第一页数据。'."\n" - .'- 非首次查询时，需传入上一次调用该接口返回的nextToken值。'."\n" - .'> 若传入参数中仅包含数字，云控制API会将其视为页码`PageNumber`进行分页处理。', - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAdDWBF2****', - ], + 'schema' => ['title' => '分页 token：传入上一次响应里返回的 nextToken；首次调用不传。当前列表 < 100，默认一页就返完。', 'type' => 'string'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页的最大记录条数。最大值：100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '本页最大返回条数。范围 1-100，默认 100。', 'type' => 'integer', 'format' => 'int32'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构。', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => '本次请求所返回的最大记录条数。List操作返回。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'nextToken' => [ - 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕。List操作返回。', - 'type' => 'string', - 'example' => 'AAAAAdDWBF2****', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'resource' => [ - 'description' => '指定资源。Get操作返回。', - 'type' => 'object', - 'properties' => [ - 'resourceAttributes' => [ - 'description' => '资源属性（JSON格式）。', - 'type' => 'object', - 'example' => '{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}', - ], - 'resourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'cctest', - ], - ], - ], - 'resources' => [ - 'description' => '资源列表。List操作返回。', + 'supportedApis' => [ + 'title' => '支持询价的 OpenAPI 三元组数组（按 popCode、popVersion、apiName 字典序排列）', 'type' => 'array', 'items' => [ - 'description' => '资源。', 'type' => 'object', 'properties' => [ - 'resourceAttributes' => [ - 'description' => '资源属性（JSON格式）。', - 'type' => 'object', - 'example' => '{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}', - ], - 'resourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'cctest', - ], + 'popCode' => ['title' => 'POP 产品码，如 Ecs / Rds / Alb（与询价时 popCode 字段一一对应）', 'type' => 'string', 'description' => 'POP 产品码，如 Ecs / Rds / Alb（与询价时 popCode 字段一一对应）'], + 'popVersion' => ['title' => 'OpenAPI 版本号，如 2014-05-26', 'type' => 'string', 'description' => 'OpenAPI 版本号，如 2014-05-26'], + 'apiName' => ['title' => 'OpenAPI 名称（PascalCase），如 RunInstances', 'type' => 'string', 'description' => 'OpenAPI 名称（PascalCase），如 RunInstances'], ], + 'description' => '', ], + 'description' => '支持询价的 OpenAPI 三元组数组（按 popCode、popVersion、apiName 字典序排列）', ], - 'totalCount' => [ - 'description' => '本次请求条件下的数据总量。List操作返回。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'requestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => 'Id of the request'], + 'nextToken' => ['title' => '下一页 token。如果还有下一页则非空，把它传给下次请求的 nextToken 字段；如果已是最后一页则为空字符串。', 'type' => 'string'], + 'maxResults' => ['title' => '本次响应的实际单页最大返回条数（与请求里的 maxResults 对齐，默认 100）。', 'type' => 'integer', 'format' => 'int32'], ], + 'description' => 'Schema of Response', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"AAAAAdDWBF2****\\",\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"resource\\": {\\n \\"resourceAttributes\\": {\\n \\"Status\\": \\"Available\\",\\n \\"Description\\": \\"\\",\\n \\"AccountPrivilege\\": \\"RoleReadWrite\\",\\n \\"InstanceId\\": \\"r-2ze8v41uei31lo****\\",\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"TypeInfo\\": {},\\n \\"AccountName\\": \\"cctest\\"\\n },\\n \\"resourceId\\": \\"cctest\\"\\n },\\n \\"resources\\": [\\n {\\n \\"resourceAttributes\\": {\\n \\"Status\\": \\"Available\\",\\n \\"Description\\": \\"\\",\\n \\"AccountPrivilege\\": \\"RoleReadWrite\\",\\n \\"InstanceId\\": \\"r-2ze8v41uei31lo****\\",\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"TypeInfo\\": {},\\n \\"AccountName\\": \\"cctest\\"\\n },\\n \\"resourceId\\": \\"cctest\\"\\n }\\n ],\\n \\"totalCount\\": 20\\n}","type":"json"}]', - 'title' => '查询资源', - 'description' => '用户可前往[在线调试API门户](https://next.api.aliyun.com/cloudcontrol)查看资源文档和体验Cloud Control API。'."\n" - ."\n" - .'此API包括资源的Get和List功能，根据不同的请求路径，用户可分别调用资源List和Get能力。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"supportedApis\\": [\\n {\\n \\"popCode\\": \\"\\",\\n \\"popVersion\\": \\"\\",\\n \\"apiName\\": \\"\\"\\n }\\n ],\\n \\"requestId\\": \\"\\",\\n \\"nextToken\\": \\"\\",\\n \\"maxResults\\": 0\\n}","type":"json"}]', ], 'UpdateResource' => [ 'summary' => '通过此接口更新资源。', 'path' => '/api/v1/providers/{provider}/products/{product}/resources/*', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'requestPath', 'in' => 'path', - 'schema' => [ - 'description' => '请求路径。格式为：'."\n" - .'/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}'."\n" - ."\n" - .'请求路径中变量说明：'."\n" - ."\n" - .'provider: 云厂商，目前只支持Aliyun。'."\n" - ."\n" - .'product: 产品Code。'."\n" - ."\n" - .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/父资源ID/{资源类型code}。'."\n" - ."\n" - .'resourceId: 资源ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '无父资源：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****'."\n" - ."\n" - .'有父资源：'."\n" - .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user****', - ], + 'schema' => ['description' => '请求路径。格式为：'."\n" + .'/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}'."\n" + ."\n" + .'请求路径中变量说明：'."\n" + ."\n" + .'provider: 云厂商，目前只支持Aliyun。'."\n" + ."\n" + .'product: 产品Code。'."\n" + ."\n" + .'resourceType: 资源类型。有父资源时，格式为{父资源类型code}/父资源ID/{资源类型code}。'."\n" + ."\n" + .'resourceId: 资源ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'No parent resource:'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****'."\n" + ."\n" + .'Has parent resource:'."\n" + .'/api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user****'], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。若云产品是region化产品，则此参数为必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing'."\n", - ], + 'schema' => ['description' => '地域ID。若云产品是region化产品，则此参数为必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'."\n"], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '幂等参数。若云产品支持幂等能力，则传入生效。', - 'type' => 'string', - 'required' => false, - 'example' => '1e810dfe1468721d0664a49b9d9f74f4', - ], + 'schema' => ['description' => '幂等参数。若云产品支持幂等能力，则传入生效。', 'type' => 'string', 'required' => false, 'example' => '1e810dfe1468721d0664a49b9d9f74f4'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', - 'schema' => [ - 'description' => '请求Body。需要更新的资源属性，以JSON的形式传入。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "AccountPassword": "4321****",'."\n" - .' "Description": "cctest"'."\n" - .'}', - ], + 'schema' => ['description' => '请求Body。需要更新的资源属性，以JSON的形式传入。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "AccountPassword": "4321****",'."\n" + .' "Description": "cctest"'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-acs-cloudcontrol-timeout' => [ - 'schema' => [ - 'type' => 'string', - 'backendName' => 'retry-timeout', - ], + 'schema' => ['type' => 'string', 'backendName' => 'retry-timeout'], ], ], 'schema' => [ @@ -1520,17 +1503,8 @@ 'description' => '返回结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'taskId' => [ - 'description' => '异步任务ID。当本次操作为异步时，此字段返回，此时HTTP状态码为202。', - 'type' => 'string', - 'example' => 'task-433aead756057fff8189a7ce5****', - ], + 'requestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + 'taskId' => ['description' => '异步任务ID。当本次操作为异步时，此字段返回，此时HTTP状态码为202。', 'type' => 'string', 'example' => 'task-433aead756057fff8189a7ce5****'], ], ], ], @@ -1542,683 +1516,73 @@ .'如果更新资源在任何时候失败，云控制 API 不会将资源回滚到先前的状态。'."\n" ."\n" .'由于资源API目前不支持回滚，当用户遇到API部分失败时，需手动调用GetResources API查看资源最新的状态，然后调用UpdateResource或DeleteResource进行手动补偿（如果有必要）。', - ], - 'GetTask' => [ - 'summary' => '通过此接口查询指定异步任务详情。', - 'path' => '/api/v1/tasks/{taskId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'title' => '任务id', - 'description' => '任务id。', - 'type' => 'string', - 'required' => true, - 'example' => 'task-433aead756057fff8189a7ce5****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'task' => [ - 'description' => '任务信息。', - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'description' => '任务创建时间', - 'type' => 'string', - 'example' => '2022-10-09T00:46:03Z', - ], - 'error' => [ - 'description' => '任务错误信息。', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'OperationFailure.OperationFailed', - ], - 'message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => '{'."\n" - .' "requestId": "123****",'."\n" - .' "errorCode": "InvalidRamUser.NoPermission",'."\n" - .' "errorMsg": "Ram user is not authorized to perform the operation."'."\n" - .'}', - ], - ], - ], - 'product' => [ - 'description' => '产品code。', - 'type' => 'string', - 'example' => 'ECS', - ], - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'resourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'i-8vbascjthm7kzhp3****'."\n", - ], - 'resourcePath' => [ - 'description' => '资源路径。相对资源id，资源路径会包含完整的资源定位（父资源/子资源）。', - 'type' => 'string', - 'example' => 'Instance/i-8vbascjthm7kzhp3****'."\n" - .'Instance/r-8vbf5abe31c9c4d4/Account/cctest', - ], - 'resourceType' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'Instance', - ], - 'status' => [ - 'description' => '任务状态。'."\n" - ."\n" - .'Pending 排队中'."\n" - ."\n" - .'Running 进行中'."\n" - ."\n" - .'Succeeded 成功完成'."\n" - ."\n" - .'Failed 失败'."\n" - ."\n" - .'Cancelling 取消中'."\n" - ."\n" - .'Cancelled 已取消。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Succeeded' => 'Succeeded', - 'Failed' => 'Failed', - 'Running' => 'Running', - 'Cancelled' => 'Cancelled', - 'Pending' => 'Pending', - 'Cancelling' => 'Cancelling', - ], - 'example' => 'Succeeded', - ], - 'taskAction' => [ - 'description' => '任务操作类型（Create | Update | Delete）。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Delete' => 'Delete', - 'Create' => 'Create', - 'Update' => 'Update', - ], - 'example' => 'Create', - ], - 'taskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => 'task-433aead756057fff8189a7ce5****', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"task\\": {\\n \\"createTime\\": \\"2022-10-09T00:46:03Z\\",\\n \\"error\\": {\\n \\"code\\": \\"OperationFailure.OperationFailed\\",\\n \\"message\\": \\"{\\\\n \\\\\\"requestId\\\\\\": \\\\\\"123****\\\\\\",\\\\n \\\\\\"errorCode\\\\\\": \\\\\\"InvalidRamUser.NoPermission\\\\\\",\\\\n \\\\\\"errorMsg\\\\\\": \\\\\\"Ram user is not authorized to perform the operation.\\\\\\"\\\\n}\\"\\n },\\n \\"product\\": \\"ECS\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"resourceId\\": \\"i-8vbascjthm7kzhp3****\\\\n\\",\\n \\"resourcePath\\": \\"Instance/i-8vbascjthm7kzhp3****\\\\nInstance/r-8vbf5abe31c9c4d4/Account/cctest\\",\\n \\"resourceType\\": \\"Instance\\",\\n \\"status\\": \\"Succeeded\\",\\n \\"taskAction\\": \\"Create\\",\\n \\"taskId\\": \\"task-433aead756057fff8189a7ce5****\\"\\n }\\n}","type":"json"}]', - 'title' => '查询任务', - 'description' => 'GET /api/v1/tasks/{taskId}。', - ], - 'CancelTask' => [ - 'summary' => '通过此接口取消指定异步任务。', - 'path' => '/api/v1/tasks/{taskId}/operation/cancel', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'title' => '任务id', - 'description' => '任务id。', - 'type' => 'string', - 'required' => true, - 'example' => 'task-433aead756057fff2913e7ce5****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', - 'title' => '取消任务', - 'description' => '仅状态为Pending或Running的Task可以被取消。'."\n" - ."\n" - .'调用CancelTask可以取消Cloud Control API 执行的任务，但是不会终止已经在下游云产品服务上启动的任务。', - ], - 'ListDataSources' => [ - 'summary' => '用户通过此接口查询资源属性可选值（RegionID、ZoneId等）。', - 'path' => '/api/v1/providers/{provider}/products/{product}/dataSources/*', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'requestPath', - 'in' => 'path', - 'schema' => [ - 'description' => '请求路径。格式为：'."\n" - .' /api/v1/providers/{provider}/products/{product}/dataSources/{resourceType}'."\n" - ."\n" - .'请求路径中变量说明：'."\n" - ."\n" - .'provider: 云厂商，目前只支持Aliyun。'."\n" - ."\n" - .'product: 产品Code。'."\n" - ."\n" - .'resourceType: 资源类型。'."\n" - ."\n" - .'示例如下：'."\n" - ."\n" - .'Redis DBInstance: /api/v1/providers/Aliyun/products/Redis/dataSources/DBInstance', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '/api/v1/providers/Aliyun/products/Redis/dataSources/DBInstance', - ], - ], - [ - 'name' => 'attributeName', - 'in' => 'query', - 'schema' => [ - 'description' => '属性名称（当前支持RegionId）。', - 'type' => 'string', - 'required' => true, - 'example' => 'RegionId', - ], - ], - [ - 'name' => 'filter', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '在当前版本下，该参数暂不生效', - 'description' => '指定过滤条件。json格式：{"key1":"value1"}。', - 'type' => 'object', - 'required' => false, - ], - ], + 'changeSet' => [ + ['createdAt' => '2023-01-10T02:34:37.000Z', 'description' => '请求参数发生变更'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构。', - 'type' => 'object', - 'properties' => [ - 'dataSources' => [ - 'description' => '数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - ], - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResource'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"dataSources\\": [\\n {\\n \\"id\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', - 'title' => '查询资源属性可选值', - ], - 'GetPrice' => [ - 'summary' => '该接口为询价接口，用户可通过此接口查询资源价格。', - 'path' => '/api/v1/providers/{provider}/products/{product}/price/*', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'requestPath', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '请求路径。格式为： /api/v1/providers/{provider}/products/{product}/price/{resourceType}'."\n" - ."\n" - .'请求路径中变量说明：'."\n" - ."\n" - .'provider: 云厂商，目前只支持Aliyun。'."\n" - ."\n" - .'product: 产品Code。'."\n" - ."\n" - .'resourceType: 资源Type。以Redis Account为例，resourceType为DBInstance/Account'."\n" - ."\n" - .'目前支持询价的资源列表如下：'."\n" - ."\n" - .'Redis DBInstance: /api/v1/providers/aliyun/products/Redis/price/DBInstance'."\n" - ."\n" - .'ECS Instance: /api/v1/providers/aliyun/products/ECS/price/Instance'."\n" - ."\n" - .'RDS DBInstance: /api/v1/providers/aliyun/products/RDS/price/DBInstance'."\n" - ."\n" - .'SLB LoadBalancer: /api/v1/providers/aliyun/products/SLB/price/LoadBalancer'."\n" - ."\n" - .'ClickHouse DBCluster: /api/v1/providers/aliyun/products/ClickHouse/price/DBCluster'."\n" - ."\n" - .'AliKafka Instance: /api/v1/providers/aliyun/products/AliKafka/price/Instance', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '/api/v1/providers/aliyun/products/Redis/price/DBInstance' => 'Redis DBInstance', - '/api/v1/providers/aliyun/products/AliKafka/price/Instance' => 'AliKafka Instance', - '/api/v1/providers/aliyun/products/ECS/price/Instance' => 'ECS Instance', - '/api/v1/providers/aliyun/products/ClickHouse/price/DBCluster' => 'ClickHouse DBCluster', - '/api/v1/providers/aliyun/products/RDS/price/DBInstance' => 'RDS DBInstance', - '/api/v1/providers/aliyun/products/SLB/price/LoadBalancer' => 'SLB LoadBalancer', - ], - 'example' => '/api/v1/providers/aliyun/products/SLB/price/LoadBalancer', - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。若云产品是region化产品，则此参数为必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing'."\n", - ], - ], - [ - 'name' => 'resourceAttributes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '询价属性（json格式）。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "LoadBalancerName": "cc-test",'."\n" - .' "LoadBalancerSpec": "slb.s3.small",'."\n" - .' "InternetChargeType": "paybybandwidth",'."\n" - .' "AddressType": "internet",'."\n" - .' "PaymentType": "PayAsYouGo",'."\n" - .' "Bandwidth": 6'."\n" - .' }', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'price' => [ - 'description' => '价格', - 'type' => 'object', - 'properties' => [ - 'currency' => [ - 'description' => '币种。取值范围：CNY：人民币。USD：美元。JPY：日元。', - 'type' => 'string', - 'enumValueTitles' => [ - 'JPY' => 'JPY', - 'USD' => 'USD', - 'CNY' => 'CNY', - ], - 'example' => 'CNY', - ], - 'discountPrice' => [ - 'description' => '折扣', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'moduleDetails' => [ - 'description' => '计价模块价格详情', - 'type' => 'array', - 'items' => [ - 'description' => '计价模块价格详情', - 'type' => 'object', - 'properties' => [ - 'costAfterDiscount' => [ - 'description' => '优惠价', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.02', - ], - 'invoiceDiscount' => [ - 'description' => '折扣', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'moduleCode' => [ - 'description' => '计价模块标识', - 'type' => 'string', - 'example' => 'InstanceRent', - ], - 'moduleName' => [ - 'description' => '计价模块名称', - 'type' => 'string', - 'example' => 'InstanceRent', - ], - 'originalCost' => [ - 'description' => '原价', - 'type' => 'number', - 'format' => 'float', - 'example' => '1000.0', - ], - 'priceType' => [ - 'description' => '价格类型', - 'type' => 'string', - 'example' => '1.0', - ], - ], - ], - ], - 'originalPrice' => [ - 'description' => '原价', - 'type' => 'number', - 'format' => 'float', - 'example' => '760.0', - ], - 'promotionDetails' => [ - 'description' => '优惠详情', - 'type' => 'array', - 'items' => [ - 'description' => '优惠详情', - 'type' => 'object', - 'properties' => [ - 'promotionDesc' => [ - 'description' => '优惠描述', - 'type' => 'string', - 'example' => '37284', - ], - 'promotionId' => [ - 'description' => '优惠标识', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '数据盘享8.5折', - ], - 'promotionName' => [ - 'description' => '优惠名称', - 'type' => 'string', - 'example' => '数据盘享8.5折', - ], - ], - ], - ], - 'tradePrice' => [ - 'description' => '优惠价', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"price\\": {\\n \\"currency\\": \\"CNY\\",\\n \\"discountPrice\\": 0,\\n \\"moduleDetails\\": [\\n {\\n \\"costAfterDiscount\\": 0.02,\\n \\"invoiceDiscount\\": 0,\\n \\"moduleCode\\": \\"InstanceRent\\",\\n \\"moduleName\\": \\"InstanceRent\\",\\n \\"originalCost\\": 1000,\\n \\"priceType\\": \\"1.0\\"\\n }\\n ],\\n \\"originalPrice\\": 760,\\n \\"promotionDetails\\": [\\n {\\n \\"promotionDesc\\": \\"37284\\",\\n \\"promotionId\\": 0,\\n \\"promotionName\\": \\"数据盘享8.5折\\"\\n }\\n ],\\n \\"tradePrice\\": 0\\n },\\n \\"requestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', - 'title' => '资源询价', ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'cloudcontrol.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => 'cloudcontrol-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-6', 'regionName' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-7', 'regionName' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-fuzhou', 'regionName' => '华东6（福州-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-nanjing', 'regionName' => '华东5（南京-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudcontrol.aliyuncs.com', 'endpoint' => 'cloudcontrol.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-central-1', 'regionName' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudcontrol.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'InternalFailure', 'message' => 'The request processing has failed because of an unknown error, exception or failure.', 'http_code' => 500, 'description' => '服务内部错误'], + ['code' => 'InvalidDomain.NotFound', 'message' => 'The specified domain does not exist.', 'http_code' => 400, 'description' => '这个Domain不存在'], + ['code' => 'InvalidParameter.RequiredNotExisted', 'message' => 'The Required parameter for the Create operation of resource of type do not existed.', 'http_code' => 400, 'description' => '有必填属性没有提供'], + ['code' => 'InvalidRamUser.NoPermission', 'message' => 'Ram user is not authorized to perform the operation.', 'http_code' => 403, 'description' => 'Ram用户鉴权失败'], + ['code' => 'InvalidRegion.NotFound', 'message' => 'The specified region does not exist.', 'http_code' => 400, 'description' => '指定的Region不存在'], + ['code' => 'InvalidRequestPath', 'message' => 'The request path is invalid.', 'http_code' => 400, 'description' => '请求的path校验不通过'], + ['code' => 'InvalidResource.NotFound', 'message' => 'The specified resource does not exist.', 'http_code' => 400, 'description' => '指定的资源不存在'], + ['code' => 'InvalidResourceType.NotFound', 'message' => 'The specified resource type does not exist.', 'http_code' => 400, 'description' => '指定的资源类型不存在'], + ['code' => 'InvalidTask.NotFound', 'message' => 'The specified task does not exist.', 'http_code' => 400, 'description' => '指定的任务不存在'], + ['code' => 'MissingParameter', 'message' => 'some input parameter that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少必填参数'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceTypes'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceType'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataSources'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrice'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResource'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResource'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResources'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResource'], ], ], ]; |