diff options
Diffstat (limited to 'data/zh_cn/computenest')
| -rw-r--r-- | data/zh_cn/computenest/2021-06-01/api-docs.php | 9755 |
1 files changed, 9755 insertions, 0 deletions
diff --git a/data/zh_cn/computenest/2021-06-01/api-docs.php b/data/zh_cn/computenest/2021-06-01/api-docs.php new file mode 100644 index 0000000..2ced650 --- /dev/null +++ b/data/zh_cn/computenest/2021-06-01/api-docs.php @@ -0,0 +1,9755 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ComputeNest', + 'version' => '2021-06-01', + ], + 'directories' => [ + [ + 'id' => 305053, + 'title' => '服务', + 'type' => 'directory', + 'children' => [ + 'GetService', + 'GetServiceTemplateParameterConstraints', + 'GetServiceEstimateCost', + 'GenerateServicePolicy', + 'GetServiceProvisions', + 'ListServices', + ], + ], + [ + 'id' => 305060, + 'title' => '服务类别', + 'type' => 'directory', + 'children' => [ + 'ListServiceCategories', + ], + ], + [ + 'id' => 305062, + 'title' => '服务实例', + 'type' => 'directory', + 'children' => [ + 'UpgradeServiceInstance', + 'CreateServiceInstance', + 'GetServiceInstance', + 'ContinueDeployServiceInstance', + 'DeleteServiceInstances', + 'ListServiceInstanceLogs', + 'ListServiceInstanceResources', + 'ListServiceInstances', + 'StartServiceInstance', + 'StopServiceInstance', + 'RestartServiceInstance', + 'UpdateServiceInstanceSpec', + 'ListServiceInstanceUpgradeHistory', + 'RollbackServiceInstance', + 'UpdateServiceInstanceAttributes', + 'ValidateServiceInstanceName', + ], + ], + [ + 'id' => 305079, + 'title' => '标签和资源组', + 'type' => 'directory', + 'children' => [ + 'ListTagKeys', + 'UnTagResources', + 'TagResources', + 'ListTagValues', + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 305085, + 'title' => '用户信息', + 'type' => 'directory', + 'children' => [ + 'UpdateUserInformation', + 'GetUserInformation', + ], + ], + [ + 'id' => 305088, + 'title' => '服务使用申请', + 'type' => 'directory', + 'children' => [ + 'ListServiceUsages', + 'CancelServiceUsage', + 'CreateServiceUsage', + 'UpdateServiceUsage', + ], + ], + [ + 'id' => 305093, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DeployServiceInstance', + 'DescribeRegions', + 'ListPolicies', + 'GetNetworkAvailableZones', + 'ListTagResources', + 'GetServiceInstanceSubscriptionEstimateCost', + 'RenewServiceInstanceResources', + 'ListServiceInstanceBill', + 'CheckServiceDeployable', + 'CreateRestoreTask', + 'GetBackup', + 'ListRestoreTasks', + 'ListBackups', + 'CreateBackup', + 'DeleteBackup', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetService' => [ + 'summary' => '查询指定服务的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36940', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'service-0e6fca6a51a544xxxxxx', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'ShowDetails', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '是否透出服务详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '是否透出服务详细信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'ServiceInstanceRoleInfo', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Wordpress社区版', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-b58c874912fc4294****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '服务状态。可能的值:'."\n" + ."\n" + .'- Draft:草稿状态。'."\n" + .'- Beta: 预发布状态。不允许修改,可分享给其他用户使用。'."\n" + .'- Submitted:已提交审核。不允许修改。'."\n" + ."\n" + .'- Approved:已通过审核。不允许修改,可以发布上线。'."\n" + ."\n" + .'- Launching:服务上线中。'."\n" + ."\n" + .'- Online:已上线。'."\n" + ."\n" + .'- Offline:已下线。'."\n" + ."\n" + .'- Creating: 服务创建中。'."\n" + .'- CreateFailed:服务创建失败。'."\n" + .'- Updating:服务更新中。'."\n" + .'- UpdateFailed:服务更新失败。', + 'type' => 'string', + 'example' => 'Online', + ], + 'DeployMetadata' => [ + 'description' => '存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用JSON String格式进行数据存储。', + 'type' => 'string', + 'example' => '{\\"TemplateUrl\\": \\"http://tidbRosFile\\"}', + ], + 'PublishTime' => [ + 'description' => '发布时间。', + 'type' => 'string', + 'example' => '2021-05-21T00:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + 'Version' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'example' => '1.0', + ], + 'DeployType' => [ + 'description' => '部署类型。可能值:'."\n" + ."\n" + .'- ros:通过ROS部署。'."\n" + ."\n" + .'- terraform:通过Terraform部署。'."\n" + ."\n" + .'- spi:调用SPI部署。'."\n" + ."\n" + .'- operation:代运维服务部署。'."\n" + ."\n" + .'- container:通过容器部署。'."\n" + ."\n" + .'- pkg:包服务。', + 'type' => 'string', + 'example' => 'ros', + ], + 'ServiceId' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'example' => 'service-0e6fca6a51a544xxxxxx', + ], + 'SupplierUrl' => [ + 'description' => '服务商地址。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'ServiceType' => [ + 'description' => '服务类型。可能值:'."\n" + ."\n" + .'- private:部署在用户账户下。'."\n" + ."\n" + .'- managed:托管在服务商账户下。'."\n" + ."\n" + .'- operation:代运维服务。', + 'type' => 'string', + 'example' => 'private', + ], + 'ServiceProductUrl' => [ + 'description' => '产品页URL。', + 'type' => 'string', + 'example' => 'http://example1.com', + ], + 'SupplierName' => [ + 'description' => '服务商名称。', + 'type' => 'string', + 'example' => 'A公司', + ], + 'ServiceInfos' => [ + 'description' => '服务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务信息。', + 'type' => 'object', + 'properties' => [ + 'Locale' => [ + 'description' => '服务配置语言。可能的值:'."\n" + ."\n" + .'- zh-CN:中文。'."\n" + ."\n" + .'- en-US:英文。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'Image' => [ + 'description' => '服务图标地址。', + 'type' => 'string', + 'example' => 'https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png', + ], + 'Name' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'B数据库', + ], + 'ShortDescription' => [ + 'description' => '服务概述。', + 'type' => 'string', + 'example' => 'B是A公司自主设计并研发的开源分布式的关系型数据库', + ], + 'Agreements' => [ + 'description' => '服务的协议文档信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务的协议文档信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '协议名称。', + 'type' => 'string', + 'example' => '用户协议', + ], + 'Url' => [ + 'description' => '协议链接。', + 'type' => 'string', + 'example' => 'https://url', + ], + ], + ], + ], + 'Softwares' => [ + 'description' => '服务软件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务软件信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => 'wordpress', + ], + 'Version' => [ + 'description' => '软件版本。', + 'type' => 'string', + 'example' => '6.0.1', + ], + ], + ], + ], + ], + ], + ], + 'IsSupportOperated' => [ + 'description' => '是否代运维,默认为:false。可能的值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false:关闭。'."\n" + .'> 当**ServiceType**为**private**时需要填入该值。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PolicyNames' => [ + 'description' => '策略名称。单个策略名称长度不超过128个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。', + 'type' => 'string', + 'example' => 'policyName1, policyName2', + ], + 'Duration' => [ + 'description' => '代运维时间。单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '259200', + ], + 'ShareType' => [ + 'description' => '共享类型。可能的值:'."\n" + ."\n" + .'- Public:公开的,正式部署和试用部署都不受限。'."\n" + ."\n" + .'- Restricted:受限的,正式部署和试用部署都受限。'."\n" + ."\n" + .'- OnlyFormalRestricted:仅正式部署受限。'."\n" + ."\n" + .'- OnlyTrailRestricted:仅试用部署受限。'."\n" + ."\n" + .'- Hidden:隐藏的,不可见且不可申请部署权限。', + 'type' => 'string', + 'example' => 'Public', + ], + 'Permission' => [ + 'description' => '权限类型。可能的值:'."\n" + ."\n" + .'- Deployable:可部署。'."\n" + ."\n" + .'- Accessible:可访问。', + 'type' => 'string', + 'example' => 'Deployable', + ], + 'AlarmMetadata' => [ + 'description' => '服务报警配置。'."\n" + .'> 当**PolicyNames**中配置了报警权限策略后,该配置才会生效。', + 'type' => 'string', + 'example' => '{ "TemplateUrl": "http://template.file.url", // 应用分组级别告警元数据 "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] }', + ], + 'VersionName' => [ + 'description' => '版本名称。', + 'type' => 'string', + 'example' => 'v1', + ], + 'Tags' => [ + 'description' => '服务标签。', + 'type' => 'array', + 'items' => [ + 'description' => '服务标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'TrialDuration' => [ + 'description' => '试用时长。单位:天。试用时长的最长天数不超过30天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'SupplierDesc' => [ + 'description' => '服务商描述。', + 'type' => 'string', + 'example' => '阿里云计算巢团队', + ], + 'TrialType' => [ + 'description' => '试用类型。可选值:'."\n" + ."\n" + .'- Trial:支持试用。'."\n" + ."\n" + .'- NotTrial:不支持试用。', + 'type' => 'string', + 'example' => 'Trial', + ], + 'TenantType' => [ + 'description' => '租户类型。可选值:'."\n" + ."\n" + .'- SingleTenant:单租户。'."\n" + ."\n" + .'- MultiTenant:多租户。', + 'type' => 'string', + 'example' => 'SingleTenant', + ], + 'LicenseMetadata' => [ + 'description' => '许可证元数据。', + 'type' => 'string', + 'example' => '{\\"PayType\\":\\"CustomFixTime\\",\\"DefaultLicenseDays\\":7,\\"CustomMetadata\\":[{\\"TemplateName\\":\\"模板1\\",\\"SpecificationName\\":\\"bandwith-0\\",\\"CustomData\\":\\"1\\"}]}', + ], + 'OperationMetadata' => [ + 'description' => '代运维配置。', + 'type' => 'string', + 'example' => '{\\"PrometheusConfigMap\\":{\\"New_Vpc_Ack_And_Jumpserver\\":{}}}', + ], + 'LogMetadata' => [ + 'description' => '应用日志配置。', + 'type' => 'string', + 'example' => '{\\"Logstores\\":[]}', + ], + 'SupplierLogo' => [ + 'description' => '服务商图标。', + 'type' => 'string', + 'example' => 'https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png', + ], + 'DeployFrom' => [ + 'description' => '服务部署途径。可选值:'."\n" + ."\n" + .'- NoWhere:没有部署途径。'."\n" + ."\n" + .'- Marketplace:从云市场部署。'."\n" + ."\n" + .'- ComputeNest:从计算巢部署。', + 'type' => 'string', + 'example' => 'Marketplace', + ], + 'Categories' => [ + 'description' => '服务类别名称', + 'type' => 'string', + 'example' => 'AI', + ], + 'SupplierUid' => [ + 'description' => '服务商AliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158927391332*****', + ], + 'Commodity' => [ + 'description' => '商品规格。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '类型。'."\n" + ."\n" + .'取值:'."\n" + ."\n" + .'Marketplace:云市场。'."\n" + ."\n" + .'Css:凌霄。', + 'type' => 'string', + 'example' => 'Marketplace', + ], + 'ChargeType' => [ + 'description' => '付费类型。'."\n" + ."\n" + .'取值:'."\n" + ."\n" + .'**PREPAY**(默认值):预付费,即包年包月。'."\n" + ."\n" + .'**POSTPAY**:后付费,即按量付费。', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'OrderTime' => [ + 'description' => '订购时间', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '[1:Month]', + 'description' => '订购时间', + ], + 'description' => '订购时间', + ], + ], + 'CommodityCode' => [ + 'description' => '商品规格码。', + 'type' => 'string', + 'example' => 'cmjj00****', + ], + 'Specifications' => [ + 'description' => '云市场规格详情。', + 'type' => 'array', + 'items' => [ + 'description' => '云市场规格详情。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '商品code。', + 'type' => 'string', + 'example' => 'cmjj00****'."\n", + ], + 'Name' => [ + 'description' => '规格名称。', + 'type' => 'string', + 'example' => 'specifications1'."\n", + ], + 'Times' => [ + 'description' => '允许购买的时长。单位:周或者年。', + 'type' => 'array', + 'items' => [ + 'description' => '允许购买的时长。单位:周或者年。', + 'type' => 'string', + 'example' => '[1:Month]', + ], + ], + ], + ], + ], + 'MarketplaceMetadata' => [ + 'description' => '云市场元数据信息。', + 'type' => 'object', + 'properties' => [ + 'SpecificationMappings' => [ + 'description' => '商品规格与模板或套餐的关系。', + 'type' => 'array', + 'items' => [ + 'description' => '商品规格与模板或套餐的关系。', + 'type' => 'object', + 'properties' => [ + 'SpecificationCode' => [ + 'description' => '云市场商品规格code。', + 'type' => 'string', + 'example' => 'cmjj00****', + ], + 'TemplateName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => '单机版', + ], + 'SpecificationName' => [ + 'description' => '套餐名称', + 'type' => 'string', + 'example' => '套餐一', + ], + ], + ], + ], + ], + ], + 'CssMetadata' => [ + 'description' => '凌霄配置元数据。', + 'type' => 'object', + 'properties' => [ + 'ComponentsMappings' => [ + 'description' => '计费项映射。', + 'type' => 'array', + 'items' => [ + 'description' => '计费项映射。', + 'type' => 'object', + 'properties' => [ + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '单机版', + ], + 'Mappings' => [ + 'description' => '映射关系。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{{DBInstanceStorage}}'."\n", + 'description' => '映射关系。', + ], + ], + ], + ], + ], + ], + ], + 'SaasBoostMetadata' => [ + 'description' => 'SaasBoost配置元数据。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Enabled":false'."\n" + .' //公网交互地址'."\n" + .' "PublicAccessUrl":"https://example.com"'."\n" + .'}', + ], + 'DeployPage' => [ + 'description' => '部署页面', + 'type' => 'string', + 'example' => 'Order: 下单页'."\n" + .'Detail: 详情页', + ], + ], + ], + 'InstanceRoleInfos' => [ + 'description' => '服务模板中创建的角色信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'example' => 'ram-for-dts', + ], + 'PolicyDocument' => [ + 'description' => '管控策略内容。', + 'type' => 'string', + 'example' => '{\\n \\"Version\\": \\"1\\",\\n \\"Statement\\": [\\n {\\n \\"Effect\\": \\"Allow\\",\\n \\"Action\\": \\"*\\",\\n \\"Principal\\": \\"*\\",\\n \\"Resource\\": \\"*\\"\\n }\\n ]\\n}', + ], + 'Principals' => [ + 'description' => 'RAM实体信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'RAM实体信息。', + 'type' => 'string', + 'example' => '[{\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}, {\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}]', + ], + ], + ], + ], + ], + 'ServiceDocumentInfos' => [ + 'description' => '服务文档信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务文档信息。', + 'type' => 'object', + 'properties' => [ + 'Locale' => [ + 'description' => '服务文档语言。可能的值:'."\n" + ."\n" + .'- zh-CN:中文。'."\n" + ."\n" + .'- en-US:英文。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '单机版', + ], + 'DocumentUrl' => [ + 'description' => '文档链接。', + 'type' => 'string', + 'example' => 'https://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2', + ], + ], + ], + ], + 'SupportContacts' => [ + 'description' => '服务商的联系方式', + 'type' => 'array', + 'items' => [ + 'description' => '服务商的联系方式', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '联系方式的类型', + 'type' => 'string', + 'example' => 'Email'."\n", + ], + 'Value' => [ + 'description' => '联系方式', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'ComplianceMetadata' => [ + 'description' => '合规包元数据', + 'type' => 'object', + 'properties' => [ + 'CompliancePacks' => [ + 'description' => '合规包列表', + 'type' => 'array', + 'items' => [ + 'description' => '合规包', + 'type' => 'string', + 'example' => 'VpcDataRisk', + ], + ], + ], + ], + 'ServiceLocaleConfigs' => [ + 'description' => '服务多语言配置', + 'type' => 'array', + 'items' => [ + 'description' => '服务多语言配置', + 'type' => 'object', + 'properties' => [ + 'OriginalValue' => [ + 'description' => '业务信息原始数据值', + 'type' => 'string', + 'example' => 'Service Name', + ], + 'ZhValue' => [ + 'description' => '业务信息对应的中文数据值', + 'type' => 'string', + 'example' => '服务名称', + ], + 'EnValue' => [ + 'description' => '业务信息对应的英文数据值', + 'type' => 'string', + 'example' => 'Service Name', + ], + ], + ], + ], + ], + ], + ], + [], + [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Online\\",\\n \\"DeployMetadata\\": \\"{\\\\\\\\\\\\\\"TemplateUrl\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"http://tidbRosFile\\\\\\\\\\\\\\"}\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"Version\\": \\"1.0\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-0e6fca6a51a544xxxxxx\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"ServiceProductUrl\\": \\"http://example1.com\\",\\n \\"SupplierName\\": \\"A公司\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png\\",\\n \\"Name\\": \\"B数据库\\",\\n \\"ShortDescription\\": \\"B是A公司自主设计并研发的开源分布式的关系型数据库\\",\\n \\"Agreements\\": [\\n {\\n \\"Name\\": \\"用户协议\\",\\n \\"Url\\": \\"https://url\\"\\n }\\n ],\\n \\"Softwares\\": [\\n {\\n \\"Name\\": \\"wordpress\\",\\n \\"Version\\": \\"6.0.1\\"\\n }\\n ]\\n }\\n ],\\n \\"IsSupportOperated\\": false,\\n \\"PolicyNames\\": \\"policyName1, policyName2\\",\\n \\"Duration\\": 259200,\\n \\"ShareType\\": \\"Public\\",\\n \\"Permission\\": \\"Deployable\\",\\n \\"AlarmMetadata\\": \\"{ \\\\\\"TemplateUrl\\\\\\": \\\\\\"http://template.file.url\\\\\\", // 应用分组级别告警元数据 \\\\\\"ApplicationGroups\\\\\\": [ { \\\\\\"Name\\\\\\": \\\\\\"applicationGroup1\\\\\\", \\\\\\"TemplateUrl\\\\\\": \\\\\\"url1\\\\\\" }, { \\\\\\"Name\\\\\\": \\\\\\"applicationGroup2\\\\\\", \\\\\\"TemplateUrl\\\\\\": \\\\\\"url2\\\\\\" } ] }\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"TrialDuration\\": 7,\\n \\"SupplierDesc\\": \\"阿里云计算巢团队\\",\\n \\"TrialType\\": \\"Trial\\",\\n \\"TenantType\\": \\"SingleTenant\\",\\n \\"LicenseMetadata\\": \\"{\\\\\\\\\\\\\\"PayType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CustomFixTime\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DefaultLicenseDays\\\\\\\\\\\\\\":7,\\\\\\\\\\\\\\"CustomMetadata\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"TemplateName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"模板1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SpecificationName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bandwith-0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CustomData\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}]}\\",\\n \\"OperationMetadata\\": \\"{\\\\\\\\\\\\\\"PrometheusConfigMap\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"New_Vpc_Ack_And_Jumpserver\\\\\\\\\\\\\\":{}}}\\",\\n \\"LogMetadata\\": \\"{\\\\\\\\\\\\\\"Logstores\\\\\\\\\\\\\\":[]}\\",\\n \\"SupplierLogo\\": \\"https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png\\",\\n \\"DeployFrom\\": \\"Marketplace\\",\\n \\"Categories\\": \\"AI\\",\\n \\"SupplierUid\\": 0,\\n \\"Commodity\\": {\\n \\"Type\\": \\"Marketplace\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"OrderTime\\": {\\n \\"key\\": [\\n \\"[1:Month]\\"\\n ]\\n },\\n \\"CommodityCode\\": \\"cmjj00****\\",\\n \\"Specifications\\": [\\n {\\n \\"Code\\": \\"cmjj00****\\\\n\\",\\n \\"Name\\": \\"specifications1\\\\n\\",\\n \\"Times\\": [\\n \\"[1:Month]\\"\\n ]\\n }\\n ],\\n \\"MarketplaceMetadata\\": {\\n \\"SpecificationMappings\\": [\\n {\\n \\"SpecificationCode\\": \\"cmjj00****\\",\\n \\"TemplateName\\": \\"单机版\\",\\n \\"SpecificationName\\": \\"套餐一\\"\\n }\\n ]\\n },\\n \\"CssMetadata\\": {\\n \\"ComponentsMappings\\": [\\n {\\n \\"TemplateName\\": \\"单机版\\",\\n \\"Mappings\\": {\\n \\"key\\": \\"{{DBInstanceStorage}}\\\\n\\"\\n }\\n }\\n ]\\n },\\n \\"SaasBoostMetadata\\": \\"{\\\\n \\\\\\"Enabled\\\\\\":false\\\\n //公网交互地址\\\\n \\\\\\"PublicAccessUrl\\\\\\":\\\\\\"https://example.com\\\\\\"\\\\n}\\",\\n \\"DeployPage\\": \\"Order: 下单页\\\\nDetail: 详情页\\"\\n },\\n \\"InstanceRoleInfos\\": [\\n {\\n \\"TemplateName\\": \\"模板1\\",\\n \\"RoleName\\": \\"ram-for-dts\\",\\n \\"PolicyDocument\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\": [\\\\\\\\n {\\\\\\\\n \\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Principal\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Resource\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\"\\\\\\\\n }\\\\\\\\n ]\\\\\\\\n}\\",\\n \\"Principals\\": [\\n \\"[{\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}, {\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}]\\"\\n ]\\n }\\n ],\\n \\"ServiceDocumentInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"TemplateName\\": \\"单机版\\",\\n \\"DocumentUrl\\": \\"https://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2\\"\\n }\\n ],\\n \\"SupportContacts\\": [\\n {\\n \\"Type\\": \\"Email\\\\n\\",\\n \\"Value\\": \\"[email protected]\\"\\n }\\n ],\\n \\"ComplianceMetadata\\": {\\n \\"CompliancePacks\\": [\\n \\"VpcDataRisk\\"\\n ]\\n },\\n \\"ServiceLocaleConfigs\\": [\\n {\\n \\"OriginalValue\\": \\"Service Name\\",\\n \\"ZhValue\\": \\"服务名称\\",\\n \\"EnValue\\": \\"Service Name\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询服务详细信息', + ], + 'GetServiceTemplateParameterConstraints' => [ + 'summary' => '通过模板名称、服务 ID查询指定地域下的ROS模板参数限定值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136289', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + 'FEATUREcomputenestVUFVAC', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'service-731f788406024axxxxxx', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => '模板1', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '服务实例配置参数。', + 'type' => 'array', + 'items' => [ + 'description' => '服务实例配置参数。', + 'type' => 'object', + 'properties' => [ + 'ParameterKey' => [ + 'description' => '参数的名称。如果未指定参数的名称和值,则ROS将使用模板中指定的默认值。'."\n" + ."\n" + .'> Parameters为可选参数。若指定了Parameters,则ParameterKey为必选参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'InstanceType', + ], + 'ParameterValue' => [ + 'description' => '模板中已定义的参数的取值。'."\n" + ."\n" + .'> Parameters为可选参数。若指定了Parameters,则ParameterValue为必选参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DeployRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '部署地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TrialType', + 'in' => 'query', + 'schema' => [ + 'description' => '使用类型。可选值:'."\n" + ."\n" + .'- Trial:支持试用。'."\n" + ."\n" + .'- NotTrial:不支持试用。', + 'type' => 'string', + 'required' => false, + 'example' => 'NotTrial', + ], + ], + [ + 'name' => 'SpecificationName', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐规格名称。', + 'type' => 'string', + 'required' => false, + 'example' => '套餐一', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-461ee95f46ca46xxxxxx', + ], + ], + [ + 'name' => 'EnablePrivateVpcConnection', + 'in' => 'query', + 'schema' => [ + 'description' => '是否已开启私网连接。可能的值:'."\n" + ."\n" + .'- true:已开启'."\n" + ."\n" + .'- false:未开启', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C', + ], + 'ParameterConstraints' => [ + 'description' => '参数约束信息。', + 'type' => 'array', + 'items' => [ + 'description' => '参数约束信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '参数的类型。', + 'type' => 'string', + 'example' => 'String', + ], + 'AllowedValues' => [ + 'description' => '参数的取值。', + 'type' => 'array', + 'items' => [ + 'description' => '参数的取值。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + ], + 'AssociationParameterNames' => [ + 'description' => '关联参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联参数列表。', + 'type' => 'string', + 'example' => 'InstanceType', + ], + ], + 'ParameterKey' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'ZoneInfo', + ], + 'Behavior' => [ + 'description' => '参数的行为。取值:'."\n" + ."\n" + .'- NoLimit:无限制,此参数没有取值限制。'."\n" + ."\n" + .'- NotSupport:不支持,此参数不支持查询取值。'."\n" + ."\n" + .'- QueryError:查询失败。'."\n" + ."\n" + .'> 当查询结果没有返回AllowedValues时,会额外返回Behavior和BehaviorReason,说明参数的行为和原因。', + 'type' => 'string', + 'example' => 'NoLimit', + ], + 'BehaviorReason' => [ + 'description' => '参数行为出现的原因。', + 'type' => 'string', + 'example' => 'No resource property refer to the parameter', + ], + 'OriginalConstraints' => [ + 'description' => '原始约束信息。', + 'type' => 'array', + 'items' => [ + 'description' => '原始约束信息。', + 'type' => 'object', + 'properties' => [ + 'AllowedValues' => [ + 'description' => '参数的取值。', + 'type' => 'array', + 'items' => [ + 'description' => '参数的取值。', + 'type' => 'string', + 'example' => 'cn-hangzhou-a', + ], + ], + 'PropertyName' => [ + 'description' => '属性名称。', + 'type' => 'string', + 'example' => 'ZoneId', + ], + 'ResourceName' => [ + 'description' => '模板中定义的资源名称。', + 'type' => 'string', + 'example' => 'MyECS', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ALIYUN::ECS::InstanceGroup', + ], + ], + ], + ], + 'QueryErrors' => [ + 'description' => '查询失败的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '查询失败的详情。', + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误详情。', + 'type' => 'string', + 'example' => 'record not exist', + ], + 'ResourceName' => [ + 'description' => '资源名称。', + 'type' => 'string', + 'example' => 'MyECS', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ALIYUN::ECS::InstanceGroup', + ], + ], + ], + ], + ], + ], + ], + 'FamilyConstraints' => [ + 'description' => '套餐族约束。', + 'type' => 'array', + 'items' => [ + 'description' => '套餐族约束。', + 'type' => 'string', + 'example' => '约束族1', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C\\",\\n \\"ParameterConstraints\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"AllowedValues\\": [\\n \\"cn-hangzhou-h\\"\\n ],\\n \\"AssociationParameterNames\\": [\\n \\"InstanceType\\"\\n ],\\n \\"ParameterKey\\": \\"ZoneInfo\\",\\n \\"Behavior\\": \\"NoLimit\\",\\n \\"BehaviorReason\\": \\"No resource property refer to the parameter\\",\\n \\"OriginalConstraints\\": [\\n {\\n \\"AllowedValues\\": [\\n \\"cn-hangzhou-a\\"\\n ],\\n \\"PropertyName\\": \\"ZoneId\\",\\n \\"ResourceName\\": \\"MyECS\\",\\n \\"ResourceType\\": \\"ALIYUN::ECS::InstanceGroup\\"\\n }\\n ],\\n \\"QueryErrors\\": [\\n {\\n \\"ErrorMessage\\": \\"record not exist\\",\\n \\"ResourceName\\": \\"MyECS\\",\\n \\"ResourceType\\": \\"ALIYUN::ECS::InstanceGroup\\"\\n }\\n ]\\n }\\n ],\\n \\"FamilyConstraints\\": [\\n \\"约束族1\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询服务模板参数限定值', + ], + 'GetServiceEstimateCost' => [ + 'summary' => '查询创建服务实例的预估价格。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '113848', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'service-12xxxxxx', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板1', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '部署服务实例输入的参数。', + 'type' => 'object', + 'required' => false, + 'example' => '{ \\"RegionId\\": \\"cn-hangzhou\\", \\"InstanceType\\": \\"ecs.g5.large\\"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'qwertyuiop', + ], + ], + [ + 'name' => 'TrialType', + 'in' => 'query', + 'schema' => [ + 'description' => '使用类型。可选值:'."\n" + ."\n" + .'- Trial:支持试用。'."\n" + ."\n" + .'- NotTrial:不支持试用。', + 'type' => 'string', + 'required' => false, + 'example' => 'NotTrial', + ], + ], + [ + 'name' => 'SpecificationName', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐规格名称。', + 'type' => 'string', + 'required' => false, + 'example' => '套餐一', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-d6ab3a63ccbb4b17xxxx', + ], + ], + [ + 'name' => 'Commodity', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '购买订单时间信息。', + 'type' => 'object', + 'properties' => [ + 'PayPeriodUnit' => [ + 'description' => '购买时长的单位,可选值:'."\n" + ."\n" + .'- Year:年。'."\n" + ."\n" + .'- Month:月。'."\n" + ."\n" + .'- Day:日。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + 'PayPeriod' => [ + 'description' => '购买时长。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'CouponId' => [ + 'description' => '优惠券ID', + 'type' => 'string', + 'required' => false, + 'example' => '302070970220', + ], + 'QuotationId' => [ + 'description' => '云市场PrivateOffer Id', + 'type' => 'string', + 'required' => false, + 'example' => ' 17cde2e8-2f5d-xxxx-xxxx-5120dd215d66', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'OperationName', + 'in' => 'query', + 'schema' => [ + 'description' => '变配操作名称。', + 'type' => 'string', + 'required' => false, + 'example' => '参数变配', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '08ABBB67-39C9-5EE7-98E5-80486F75CE8D', + ], + 'Resources' => [ + 'description' => '资源列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{'."\n" + .' "EcsInstance" : {'."\n" + .' "Type" : "ALIYUN::ECS::Instance",'."\n" + .' "Success" : true,'."\n" + .' "Result" : {'."\n" + .' "Order" : {'."\n" + .' "Currency" : "CNY",'."\n" + .' "RuleIds" : [ "102111101338****" ],'."\n" + .' "DetailInfos" : {'."\n" + .' "ResourcePriceModel" : [ {'."\n" + .' "OriginalPrice" : 0,'."\n" + .' "DiscountPrice" : 0,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "bandwidth",'."\n" + .' "TradePrice" : 0'."\n" + .' }, {'."\n" + .' "OriginalPrice" : 0,'."\n" + .' "DiscountPrice" : 0,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "image",'."\n" + .' "TradePrice" : 0'."\n" + .' }, {'."\n" + .' "OriginalPrice" : 0.366666,'."\n" + .' "DiscountPrice" : 0.249012,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "instanceType",'."\n" + .' "TradePrice" : 0.117654'."\n" + .' }, {'."\n" + .' "OriginalPrice" : 0.055555,'."\n" + .' "DiscountPrice" : 0.037729,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "systemDisk",'."\n" + .' "TradePrice" : 0.017826'."\n" + .' } ]'."\n" + .' },'."\n" + .' "TradeAmount" : 0.135,'."\n" + .' "OriginalAmount" : 0.422,'."\n" + .' "Coupons" : {'."\n" + .' "Coupon" : [ ]'."\n" + .' },'."\n" + .' "DiscountAmount" : 0.287'."\n" + .' },'."\n" + .' "OrderSupplement" : {'."\n" + .' "PriceUnit" : "/Hour",'."\n" + .' "ChargeType" : "PostPaid",'."\n" + .' "Quantity" : 1,'."\n" + .' "PriceType" : "Total"'."\n" + .' },'."\n" + .' "Rules" : {'."\n" + .' "Rule" : [ {'."\n" + .' "RuleDescId" : "102111101338****",'."\n" + .' "Name" : "合同优惠_多计费项优惠_3.208750折"'."\n" + .' } ]'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' }', + 'description' => '资源列表。', + ], + 'example' => '{'."\n" + .' "EcsInstance" : {'."\n" + .' "Type" : "ALIYUN::ECS::Instance",'."\n" + .' "Success" : true,'."\n" + .' "Result" : {'."\n" + .' "Order" : {'."\n" + .' "Currency" : "CNY",'."\n" + .' "RuleIds" : [ "102111101338****" ],'."\n" + .' "DetailInfos" : {'."\n" + .' "ResourcePriceModel" : [ {'."\n" + .' "OriginalPrice" : 0,'."\n" + .' "DiscountPrice" : 0,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "bandwidth",'."\n" + .' "TradePrice" : 0'."\n" + .' }, {'."\n" + .' "OriginalPrice" : 0,'."\n" + .' "DiscountPrice" : 0,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "image",'."\n" + .' "TradePrice" : 0'."\n" + .' }, {'."\n" + .' "OriginalPrice" : 0.366666,'."\n" + .' "DiscountPrice" : 0.249012,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "instanceType",'."\n" + .' "TradePrice" : 0.117654'."\n" + .' }, {'."\n" + .' "OriginalPrice" : 0.055555,'."\n" + .' "DiscountPrice" : 0.037729,'."\n" + .' "SubRules" : {'."\n" + .' "Rule" : [ ]'."\n" + .' },'."\n" + .' "Resource" : "systemDisk",'."\n" + .' "TradePrice" : 0.017826'."\n" + .' } ]'."\n" + .' },'."\n" + .' "TradeAmount" : 0.135,'."\n" + .' "OriginalAmount" : 0.422,'."\n" + .' "Coupons" : {'."\n" + .' "Coupon" : [ ]'."\n" + .' },'."\n" + .' "DiscountAmount" : 0.287'."\n" + .' },'."\n" + .' "OrderSupplement" : {'."\n" + .' "PriceUnit" : "/Hour",'."\n" + .' "ChargeType" : "PostPaid",'."\n" + .' "Quantity" : 1,'."\n" + .' "PriceType" : "Total"'."\n" + .' },'."\n" + .' "Rules" : {'."\n" + .' "Rule" : [ {'."\n" + .' "RuleDescId" : "102111101338****",'."\n" + .' "Name" : "合同优惠_多计费项优惠_3.208750折"'."\n" + .' } ]'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' }', + ], + 'Commodity' => [ + 'description' => '云市场购买订单信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'type' => 'object', + 'properties' => [ + 'Currency' => [ + 'type' => 'string', + 'description' => '货币代码。', + 'example' => 'CNY', + ], + 'TradeAmount' => [ + 'type' => 'string', + 'description' => '优惠后。', + 'example' => '9.99', + ], + 'DiscountAmount' => [ + 'type' => 'string', + 'description' => '抵扣金额。', + 'example' => '1.99', + ], + 'OriginalAmount' => [ + 'type' => 'string', + 'example' => '11.98', + 'description' => '优惠前。', + ], + ], + 'description' => '订单信息。', + ], + 'InquiryType' => [ + 'type' => 'string', + 'description' => '询价类型,可选值:'."\n" + .'1. Buy:新购询价。'."\n" + .'2. ModificationBuy:变配询价。', + 'example' => 'Buy', + ], + 'SubOrders' => [ + 'type' => 'object', + 'properties' => [ + 'SubOrder' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleInstance' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleId' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + 'description' => '模块ID。', + ], + 'ModuleName' => [ + 'type' => 'string', + 'example' => '数据库类型', + 'description' => '模块名称。', + ], + 'ModuleCode' => [ + 'type' => 'string', + 'example' => 'rds_dbtype', + 'description' => '模块代码。', + ], + 'TotalProductFee' => [ + 'type' => 'number', + 'format' => 'double', + 'description' => '产品原价(元)。', + 'example' => '10.00', + ], + 'DiscountFee' => [ + 'type' => 'number', + 'format' => 'double', + 'example' => '1.99', + 'description' => '折扣费用(元)。', + ], + 'PayFee' => [ + 'type' => 'number', + 'format' => 'double', + 'example' => '8.01', + 'description' => '实付金额(元)。', + ], + 'PriceUnit' => [ + 'type' => 'string', + 'description' => '价格单位。', + 'example' => '元/GB/小时', + ], + 'IsPricingModule' => [ + 'type' => 'boolean', + 'example' => 'true', + 'description' => '是否计价项。', + ], + 'NeedOrderPay' => [ + 'type' => 'boolean', + 'example' => 'true', + 'description' => '在订单中是否需要支付。', + ], + 'PriceType' => [ + 'type' => 'string', + 'description' => '定价类型。', + 'example' => 'hourPrice', + ], + 'ModuleAttrs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '属性类型,可选值:'."\n" + ."\n" + .'1. 1:商品属性 '."\n" + .'2. 2:规格属性 '."\n" + .'3. 3:模块属性 '."\n" + .'4. 4:外部参数(备用)', + 'example' => '3', + ], + 'Name' => [ + 'type' => 'string', + 'description' => '属性名称', + 'example' => '20GB', + ], + 'Code' => [ + 'type' => 'string', + 'example' => 'rds_storage', + 'description' => '属性代码', + ], + 'Value' => [ + 'type' => 'string', + 'example' => '20', + 'description' => '属性值', + ], + 'Unit' => [ + 'type' => 'string', + 'example' => 'GB', + 'description' => '值单位', + ], + ], + 'description' => '模块属性对象。', + ], + 'description' => '模块属性。', + ], + 'ModuleNameEn' => [ + 'type' => 'string', + 'description' => '模块英文名称。', + 'example' => '数据单元', + ], + 'PriceUnitEn' => [ + 'type' => 'string', + 'description' => '价格单位英文名称', + 'example' => '元/月', + ], + ], + 'description' => '模块(实例)对象。', + ], + 'description' => '模块(实例)信息。', + ], + ], + 'description' => '订单子项对象。', + ], + 'description' => '订单子项。', + ], + ], + 'description' => '订单子项。', + ], + 'Coupons' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CanPromFee' => [ + 'type' => 'number', + 'format' => 'double', + 'example' => '9.99', + 'description' => '可支付金额。', + ], + 'CouponDesc' => [ + 'type' => 'string', + 'example' => '10元优惠券(有效期至2024年9月8日)', + 'description' => '优惠券描述', + ], + 'CouponName' => [ + 'type' => 'string', + 'description' => '优惠券名称', + 'example' => '10元优惠券', + ], + 'CouponOptionNo' => [ + 'type' => 'string', + 'description' => '优惠券编号。', + 'example' => '50008800000xxxx', + ], + 'Selected' => [ + 'type' => 'boolean', + 'example' => 'true', + 'description' => '是否选中。', + ], + ], + 'description' => '优惠券。', + ], + 'description' => '优惠券。', + ], + ], + 'description' => 'Result模型。', + ], + ], + 'description' => '云市场购买订单信息。', + ], + 'example' => '{\'cmgj00059839\': {\'Result\': {\'InquiryType\': \'Buy\', \'Order\': {\'Currency\': \'CNY\', \'DiscountAmount\': \'0.0\', \'TradeAmount\': \'0.01\', \'OriginalAmount\': \'0.01\'}}}}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08ABBB67-39C9-5EE7-98E5-80486F75CE8D\\",\\n \\"Resources\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"EcsInstance\\\\\\" : {\\\\n \\\\\\"Type\\\\\\" : \\\\\\"ALIYUN::ECS::Instance\\\\\\",\\\\n \\\\\\"Success\\\\\\" : true,\\\\n \\\\\\"Result\\\\\\" : {\\\\n \\\\\\"Order\\\\\\" : {\\\\n \\\\\\"Currency\\\\\\" : \\\\\\"CNY\\\\\\",\\\\n \\\\\\"RuleIds\\\\\\" : [ \\\\\\"102111101338****\\\\\\" ],\\\\n \\\\\\"DetailInfos\\\\\\" : {\\\\n \\\\\\"ResourcePriceModel\\\\\\" : [ {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"bandwidth\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0\\\\n }, {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"image\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0\\\\n }, {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0.366666,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0.249012,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"instanceType\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0.117654\\\\n }, {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0.055555,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0.037729,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"systemDisk\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0.017826\\\\n } ]\\\\n },\\\\n \\\\\\"TradeAmount\\\\\\" : 0.135,\\\\n \\\\\\"OriginalAmount\\\\\\" : 0.422,\\\\n \\\\\\"Coupons\\\\\\" : {\\\\n \\\\\\"Coupon\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"DiscountAmount\\\\\\" : 0.287\\\\n },\\\\n \\\\\\"OrderSupplement\\\\\\" : {\\\\n \\\\\\"PriceUnit\\\\\\" : \\\\\\"/Hour\\\\\\",\\\\n \\\\\\"ChargeType\\\\\\" : \\\\\\"PostPaid\\\\\\",\\\\n \\\\\\"Quantity\\\\\\" : 1,\\\\n \\\\\\"PriceType\\\\\\" : \\\\\\"Total\\\\\\"\\\\n },\\\\n \\\\\\"Rules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ {\\\\n \\\\\\"RuleDescId\\\\\\" : \\\\\\"102111101338****\\\\\\",\\\\n \\\\\\"Name\\\\\\" : \\\\\\"合同优惠_多计费项优惠_3.208750折\\\\\\"\\\\n } ]\\\\n }\\\\n }\\\\n }\\\\n }\\"\\n },\\n \\"Commodity\\": {\\n \\"key\\": {\\n \\"Result\\": {\\n \\"Order\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"TradeAmount\\": \\"9.99\\",\\n \\"DiscountAmount\\": \\"1.99\\",\\n \\"OriginalAmount\\": \\"11.98\\"\\n },\\n \\"InquiryType\\": \\"Buy\\",\\n \\"SubOrders\\": {\\n \\"SubOrder\\": [\\n {\\n \\"ModuleInstance\\": [\\n {\\n \\"ModuleId\\": 1234,\\n \\"ModuleName\\": \\"数据库类型\\",\\n \\"ModuleCode\\": \\"rds_dbtype\\",\\n \\"TotalProductFee\\": 10,\\n \\"DiscountFee\\": 1.99,\\n \\"PayFee\\": 8.01,\\n \\"PriceUnit\\": \\"元/GB/小时\\",\\n \\"IsPricingModule\\": true,\\n \\"NeedOrderPay\\": true,\\n \\"PriceType\\": \\"hourPrice\\",\\n \\"ModuleAttrs\\": [\\n {\\n \\"Type\\": 3,\\n \\"Name\\": \\"20GB\\",\\n \\"Code\\": \\"rds_storage\\",\\n \\"Value\\": \\"20\\",\\n \\"Unit\\": \\"GB\\"\\n }\\n ],\\n \\"ModuleNameEn\\": \\"数据单元\\",\\n \\"PriceUnitEn\\": \\"元/月\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Coupons\\": [\\n {\\n \\"CanPromFee\\": 9.99,\\n \\"CouponDesc\\": \\"10元优惠券(有效期至2024年9月8日)\\",\\n \\"CouponName\\": \\"10元优惠券\\",\\n \\"CouponOptionNo\\": \\"50008800000xxxx\\",\\n \\"Selected\\": true\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询创建服务实例的预估价格', + ], + 'GenerateServicePolicy' => [ + 'summary' => '创建服务实例前查询缺少的权限策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest2G0818', + 'FEATUREcomputenest1Z49ZW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'service-b3e9ed878b0c4xxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'draft', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板1', + ], + ], + [ + 'name' => 'TrialType', + 'in' => 'query', + 'schema' => [ + 'description' => '试用类型,默认值为NotTrial。可选值:'."\n" + ."\n" + .'- Trial:支持试用。'."\n" + ."\n" + .'- NotTrial:不支持试用。', + 'type' => 'string', + 'required' => false, + 'example' => 'NotTrial', + ], + ], + [ + 'name' => 'OperationTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要生成策略信息的操作类型。', + 'type' => 'array', + 'items' => [ + 'description' => '需要生成策略信息的操作类型。可选值:'."\n" + ."\n" + .'- CreateServiceInstance:创建服务实例。'."\n" + .'- UpdateServiceInstance:更新服务实例。'."\n" + .'- DeleteServiceInstance:删除服务实例。'."\n" + .'> 默认值为所有取值。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateServiceInstance', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => '所需要权限策略的自定义属性。', + 'type' => 'string', + 'example' => '{Statement": [{ "Action": ["oos:*"], "Effect": "Allow", "Resource": "*"},{ "Action": ["ecs:DescribeInstances"], "Effect": "Allow", "Resource": "*"},{ "Action": ["ecs:RunInstance"], "Effect": "Allow", "Resource": "*"}], "Version": "1"}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5040BE9E-8DA2-5C9D-9B70-0EE6027A14BC', + ], + 'MissingPolicy' => [ + 'description' => '缺少的权限策略。', + 'type' => 'array', + 'items' => [ + 'description' => '缺少的权限策略。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '权限策略所属的服务名称。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'Resource' => [ + 'description' => '被授权的具体对象。星号(*)表示所有资源。', + 'type' => 'string', + 'example' => '*', + ], + 'Action' => [ + 'description' => '权限策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '权限策略信息。', + 'type' => 'string', + 'example' => '['."\n" + .' "ecs:DescribeInstances",'."\n" + .' "ecs:RunInstance"'."\n" + .' ]', + ], + ], + ], + ], + ], + ], + ], + ], + [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Policy\\": \\"{Statement\\\\\\": [{ \\\\\\"Action\\\\\\": [\\\\\\"oos:*\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"},{ \\\\\\"Action\\\\\\": [\\\\\\"ecs:DescribeInstances\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"},{ \\\\\\"Action\\\\\\": [\\\\\\"ecs:RunInstance\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"}], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"RequestId\\": \\"5040BE9E-8DA2-5C9D-9B70-0EE6027A14BC\\",\\n \\"MissingPolicy\\": [\\n {\\n \\"ServiceName\\": \\"ecs\\",\\n \\"Resource\\": \\"*\\",\\n \\"Action\\": [\\n \\"[\\\\n \\\\\\"ecs:DescribeInstances\\\\\\",\\\\n \\\\\\"ecs:RunInstance\\\\\\"\\\\n ]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询服务权限策略', + ], + 'GetServiceProvisions' => [ + 'summary' => '获取服务开通状态、服务角色等预置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest2G0818', + 'FEATUREcomputenest1Z49ZW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'service-0efc0db451794bxxxxxx', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板一', + ], + ], + [ + 'name' => 'TrialType', + 'in' => 'query', + 'schema' => [ + 'description' => '使用类型。可选值:'."\n" + ."\n" + .'- Trial:支持试用。'."\n" + ."\n" + .'- NotTrial:不支持试用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Trial', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户实例部署的参数。', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"RegionId\\":\\"cn-hangzhou\\",\\"ZoneId\\":\\"cn-hangzhou-g\\",\\"EcsInstanceType\\":\\"ecs.g5.large\\",\\"InstancePassword\\":\\"xxxxxxxx\\",\\"PayType\\":\\"PostPaid\\",\\"PayPeriodUnit\\":\\"Month\\",\\"PayPeriod\\":1}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8C27145F-C9F4-545D-A355-DCDDAD63D548', + ], + 'ServiceProvisions' => [ + 'description' => '服务详情。', + 'type' => 'array', + 'items' => [ + 'description' => '服务详情。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'CS', + ], + 'Status' => [ + 'description' => '服务开通状态。可能值:'."\n" + ."\n" + .'- Enabled:已开通。'."\n" + ."\n" + .'- EnabledByDefault:默认开通。'."\n" + ."\n" + .'- Disabled:未开通。'."\n" + ."\n" + .'- Unknown:未知。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'AutoEnableService' => [ + 'description' => '是否在模板中定义了自动开通服务。取值:'."\n" + ."\n" + .'- true:自动开通。'."\n" + ."\n" + .'- false:手动开通。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RoleProvision' => [ + 'description' => '服务角色信息。若为空表示没有服务角色。', + 'type' => 'object', + 'properties' => [ + 'Roles' => [ + 'description' => '服务角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务角色列表。', + 'type' => 'object', + 'properties' => [ + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'example' => 'AliyunCSManagedVKRole', + ], + 'Created' => [ + 'description' => '角色是否已创建。取值:'."\n" + ."\n" + .'- true:已创建。'."\n" + ."\n" + .'- false:未创建。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Function' => [ + 'description' => '角色用途。'."\n" + .'默认值:Default,表示该角色为服务默认角色。', + 'type' => 'string', + 'example' => 'Default', + ], + 'ApiForCreation' => [ + 'description' => '创建角色用到的API信息。', + 'type' => 'object', + 'properties' => [ + 'ApiName' => [ + 'description' => 'API名称。', + 'type' => 'string', + 'example' => 'CreateServiceLinkedRole', + ], + 'ApiProductId' => [ + 'description' => 'API所属产品ID。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ApiType' => [ + 'description' => 'API类型。'."\n" + .'取值:'."\n" + ."\n" + .'- Open:开放API。'."\n" + ."\n" + .'- Inner:内部API。', + 'type' => 'string', + 'example' => 'Open', + ], + 'parameters' => [ + 'description' => 'API参数信息。${变量名}表示动态参数。', + 'type' => 'object', + 'example' => '{ "ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs", "RegionId": "${RegionId}" }', + ], + ], + ], + ], + ], + ], + 'AuthorizationURL' => [ + 'description' => '服务云资源访问授权链接。'."\n" + .'若角色未创建,会返回此链接。', + 'type' => 'string', + 'example' => 'https://ram.console.aliyun.com/role/authorization?request={"Services":[{"Service":"CS","Roles":[{"RoleName":"AliyunCSManagedVKRole","TemplateId":"AliyunCSManagedVKRole"},{"RoleName":"AliyunCSDefaultRole","TemplateId":"Default"}]}],"ReturnUrl":"https://cs.console.aliyun.com/"}', + ], + ], + ], + 'StatusReason' => [ + 'description' => '云服务未开通或开通状态未知的原因。'."\n" + ."\n\n" + .'> 当Status取值为Disabled或Unknown时,返回该参数。', + 'type' => 'string', + 'example' => 'No permission', + ], + 'EnableURL' => [ + 'description' => '云服务开通链接。'."\n" + .'> 当Status取值为Disabled时,返回该参数。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=sls', + ], + 'CommodityProvisions' => [ + 'description' => '商品详情。部分服务(如 ACS)会涉及多个商品的开通。', + 'type' => 'array', + 'items' => [ + 'description' => '商品详情。部分服务(如 ACS)会涉及多个商品的开通。', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '商品码。', + 'type' => 'string', + 'example' => 'acs_postpaid_public_cn', + ], + 'Status' => [ + 'description' => '云服务开通状态。可能的值:'."\n" + ."\n" + .'- Enabled:已开通。'."\n" + .'- Disabled:未开通。', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'EnableURL' => [ + 'description' => '商品开通链接。', + 'type' => 'string', + 'example' => 'https://common-buy.aliyun.com/?commodityCode=acs_postpaid_public_cn', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27145F-C9F4-545D-A355-DCDDAD63D548\\",\\n \\"ServiceProvisions\\": [\\n {\\n \\"ServiceName\\": \\"CS\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"AutoEnableService\\": true,\\n \\"RoleProvision\\": {\\n \\"Roles\\": [\\n {\\n \\"RoleName\\": \\"AliyunCSManagedVKRole\\",\\n \\"Created\\": true,\\n \\"Function\\": \\"Default\\",\\n \\"ApiForCreation\\": {\\n \\"ApiName\\": \\"CreateServiceLinkedRole\\",\\n \\"ApiProductId\\": \\"rds\\",\\n \\"ApiType\\": \\"Open\\",\\n \\"parameters\\": {\\n \\"ServiceLinkedRole\\": \\"AliyunServiceRoleForRdsPgsqlOnEcs\\",\\n \\"RegionId\\": \\"${RegionId}\\"\\n }\\n }\\n }\\n ],\\n \\"AuthorizationURL\\": \\"https://ram.console.aliyun.com/role/authorization?request={\\\\\\"Services\\\\\\":[{\\\\\\"Service\\\\\\":\\\\\\"CS\\\\\\",\\\\\\"Roles\\\\\\":[{\\\\\\"RoleName\\\\\\":\\\\\\"AliyunCSManagedVKRole\\\\\\",\\\\\\"TemplateId\\\\\\":\\\\\\"AliyunCSManagedVKRole\\\\\\"},{\\\\\\"RoleName\\\\\\":\\\\\\"AliyunCSDefaultRole\\\\\\",\\\\\\"TemplateId\\\\\\":\\\\\\"Default\\\\\\"}]}],\\\\\\"ReturnUrl\\\\\\":\\\\\\"https://cs.console.aliyun.com/\\\\\\"}\\"\\n },\\n \\"StatusReason\\": \\"No permission\\",\\n \\"EnableURL\\": \\"https://common-buy.aliyun.com/?commodityCode=sls\\",\\n \\"CommodityProvisions\\": [\\n {\\n \\"CommodityCode\\": \\"acs_postpaid_public_cn\\",\\n \\"Status\\": \\"Disabled\\",\\n \\"EnableURL\\": \\"https://common-buy.aliyun.com/?commodityCode=acs_postpaid_public_cn\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取服务开通状态和服务角色等预置信息', + ], + 'ListServices' => [ + 'summary' => '查询当前服务信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118470', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤器。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '过滤器值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器值列表。N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 10, + ], + 'Name' => [ + 'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n" + ."\n" + .'- ServiceId:服务ID。'."\n" + ."\n" + .'- Name:服务名称。'."\n" + ."\n" + .'- Status:服务状态。'."\n" + ."\n" + .'- SupplierName:服务商名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Status', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InUsed', + 'in' => 'query', + 'schema' => [ + 'description' => '是否被使用。可选值:'."\n" + ."\n" + .'- false:没有被使用。'."\n" + ."\n" + .'- true:已被使用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'FuzzyKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '关键词模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'ServiceAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '服务访问类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'OrderByType', + 'in' => 'query', + 'schema' => [ + 'description' => '服务排序类型', + 'type' => 'string', + 'required' => false, + 'example' => 'UpdateTime', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI41', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F976EF8-C10A-57DC-917C-BB7BEB508FFB', + ], + 'TotalCount' => [ + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxResults' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Services' => [ + 'description' => '服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '服务状态。可能的值:'."\n" + ."\n" + .'- Draft:草稿状态。'."\n" + ."\n" + .'- Submitted:已提交审核。不允许修改。'."\n" + ."\n" + .'- Approved:已通过审核。不允许修改,可以发布上线。'."\n" + ."\n" + .'- Launching:服务上线中。'."\n" + ."\n" + .'- Online:已上线。'."\n" + ."\n" + .'- Offline:已下线。', + 'type' => 'string', + 'example' => 'Online', + ], + 'PublishTime' => [ + 'description' => '发布时间。', + 'type' => 'string', + 'example' => '2022-01-21T10:35:44Z', + ], + 'Version' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'example' => '4', + ], + 'DeployType' => [ + 'description' => '部署类型。可能值:'."\n" + ."\n" + .'- ros:通过ROS部署。'."\n" + ."\n" + .'- terraform:通过Terraform部署。'."\n" + ."\n" + .'- spi:调用SPI部署。', + 'type' => 'string', + 'example' => 'ros', + ], + 'ServiceId' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'example' => 'service-6b5d632edd394dxxxxxx', + ], + 'SupplierUrl' => [ + 'description' => '服务商地址。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'ServiceType' => [ + 'description' => '服务类型。可能值:'."\n" + ."\n" + .'- private:部署在用户账户下。'."\n" + ."\n" + .'- managed:托管在服务商账户下。'."\n" + ."\n" + .'- operation:代运维服务。', + 'type' => 'string', + 'example' => 'private', + ], + 'SupplierName' => [ + 'description' => '服务商名称。', + 'type' => 'string', + 'example' => 'A有限公司', + ], + 'ServiceInfos' => [ + 'description' => '服务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务信息。', + 'type' => 'object', + 'properties' => [ + 'Locale' => [ + 'description' => '服务配置语言。可能的值:'."\n" + ."\n" + .'- zh-CN:中文。'."\n" + ."\n" + .'- en-US:英文。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'Image' => [ + 'description' => '服务图标地址。', + 'type' => 'string', + 'example' => 'http://img.tidb.oss.url', + ], + 'Name' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'B数据库', + ], + 'ShortDescription' => [ + 'description' => '服务概述。', + 'type' => 'string', + 'example' => 'B是A公司自主设计并研发的开源分布式的关系型数据库', + ], + 'Softwares' => [ + 'description' => '服务软件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务软件信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => 'wordpress', + ], + 'Version' => [ + 'description' => '软件版本。', + 'type' => 'string', + 'example' => '6.0.1', + ], + ], + ], + ], + ], + ], + ], + 'CommodityCode' => [ + 'description' => '云市场商品code。', + 'type' => 'string', + 'example' => 'cmjj00xxxx', + ], + 'ServiceProductUrl' => [ + 'description' => '产品页URL。', + 'type' => 'string', + 'example' => 'http://example1.com', + ], + 'Categories' => [ + 'description' => '数据盘的种类。取值范围:'."\n" + ."\n" + .'- cloud_efficiency:高效云盘。'."\n" + ."\n" + .'- cloud_ssd:SSD云盘。'."\n" + ."\n" + .'- cloud_essd:ESSD云盘。'."\n" + ."\n" + .'- cloud:普通云盘。', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'VersionName' => [ + 'description' => '服务商自定义版本名称。', + 'type' => 'string', + 'example' => 'v2.0.0', + ], + 'DeployFrom' => [ + 'description' => '服务部署途径。可选值:'."\n" + ."\n" + .'- NoWhere:没有部署途径。'."\n" + ."\n" + .'- Marketplace:从云市场部署。'."\n" + ."\n" + .'- ComputeNest:从计算巢部署。', + 'type' => 'string', + 'example' => 'ComputeNest', + ], + 'Score' => [ + 'description' => '服务分数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Tags' => [ + 'description' => '服务标签。', + 'type' => 'array', + 'items' => [ + 'description' => '服务标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'TrialDuration' => [ + 'description' => '试用时长。单位:天。试用时长的最长天数不超过30天。', + 'type' => 'string', + 'example' => '7', + ], + 'TrialType' => [ + 'description' => '试用类型。可选值:'."\n" + ."\n" + .'- Trial:支持试用。'."\n" + ."\n" + .'- NotTrial:不支持试用。', + 'type' => 'string', + 'example' => 'Trial', + ], + 'TenantType' => [ + 'description' => '租户类型。可选值:'."\n" + ."\n" + .'- SingleTenant:单租户。'."\n" + ."\n" + .'- MultiTenant:多租户。', + 'type' => 'string', + 'example' => 'SingleTenant', + ], + 'VirtualInternetService' => [ + 'description' => '是否是虚拟互联网服务。可能的值:'."\n" + ."\n" + .'- false:否。'."\n" + ."\n" + .'- true:是。', + 'type' => 'string', + 'example' => 'false', + ], + 'SupplierUid' => [ + 'description' => '服务商AliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1436322xxxxx', + ], + 'Commodity' => [ + 'description' => '商品规格。', + 'type' => 'object', + 'properties' => [ + 'DeployPage' => [ + 'description' => '部署页面。', + 'type' => 'string', + 'example' => 'Order: 下单页'."\n" + .'Detail: 详情页', + ], + 'CommodityCode' => [ + 'description' => '商品规格码。', + 'type' => 'string', + 'example' => 'cmjj00****'."\n" + ."\n", + ], + ], + ], + 'SupplierNameEng' => [ + 'description' => '服务商英文名称。', + 'type' => 'string', + 'example' => 'Alibaba Cloud', + ], + 'ServiceLocaleConfigs' => [ + 'description' => '服务多语言配置', + 'type' => 'array', + 'items' => [ + 'description' => '服务多语言配置', + 'type' => 'object', + 'properties' => [ + 'OriginalValue' => [ + 'description' => '业务信息原始数据值', + 'type' => 'string', + 'example' => 'Service Name'."\n", + ], + 'ZhValue' => [ + 'description' => '业务信息对应的中文数据值', + 'type' => 'string', + 'example' => '服务名称', + ], + 'EnValue' => [ + 'description' => '业务信息对应的英文数据值', + 'type' => 'string', + 'example' => 'Service Name'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI41\\",\\n \\"RequestId\\": \\"3F976EF8-C10A-57DC-917C-BB7BEB508FFB\\",\\n \\"TotalCount\\": 1,\\n \\"MaxResults\\": 20,\\n \\"Services\\": [\\n {\\n \\"Status\\": \\"Online\\",\\n \\"PublishTime\\": \\"2022-01-21T10:35:44Z\\",\\n \\"Version\\": \\"4\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-6b5d632edd394dxxxxxx\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"SupplierName\\": \\"A有限公司\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"http://img.tidb.oss.url\\",\\n \\"Name\\": \\"B数据库\\",\\n \\"ShortDescription\\": \\"B是A公司自主设计并研发的开源分布式的关系型数据库\\",\\n \\"Softwares\\": [\\n {\\n \\"Name\\": \\"wordpress\\",\\n \\"Version\\": \\"6.0.1\\"\\n }\\n ]\\n }\\n ],\\n \\"CommodityCode\\": \\"cmjj00xxxx\\",\\n \\"ServiceProductUrl\\": \\"http://example1.com\\",\\n \\"Categories\\": \\"cloud_ssd\\",\\n \\"VersionName\\": \\"v2.0.0\\",\\n \\"DeployFrom\\": \\"ComputeNest\\",\\n \\"Score\\": 5,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"TrialDuration\\": \\"7\\",\\n \\"TrialType\\": \\"Trial\\",\\n \\"TenantType\\": \\"SingleTenant\\",\\n \\"VirtualInternetService\\": \\"false\\",\\n \\"SupplierUid\\": 0,\\n \\"Commodity\\": {\\n \\"DeployPage\\": \\"Order: 下单页\\\\nDetail: 详情页\\",\\n \\"CommodityCode\\": \\"cmjj00****\\\\n\\\\n\\"\\n },\\n \\"SupplierNameEng\\": \\"Alibaba Cloud\\",\\n \\"ServiceLocaleConfigs\\": [\\n {\\n \\"OriginalValue\\": \\"Service Name\\\\n\\",\\n \\"ZhValue\\": \\"服务名称\\",\\n \\"EnValue\\": \\"Service Name\\\\n\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询服务信息', + ], + 'ListServiceCategories' => [ + 'summary' => '查询服务类别', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203728', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestB2MIVU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果结构', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7', + ], + 'Categories' => [ + 'description' => '服务分类名称列表', + 'type' => 'array', + 'items' => [ + 'description' => '服务类别名称', + 'type' => 'string', + 'example' => 'AI', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"Categories\\": [\\n \\"AI\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询服务类别名称', + ], + 'UpgradeServiceInstance' => [ + 'summary' => '升级服务实例的版本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '122810', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestYPH9R9', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'si-d6ab3a63ccbb4bxxxxxx', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '要升级到的服务版本。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '升级时所需参数,用于新版本服务有新增参数时。', + 'type' => 'object', + 'required' => false, + 'example' => '{ \\"RegionId\\": \\"cn-hangzhou\\", \\"InstanceType\\": \\"ecs.g5.large\\"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检,包括权限、实例状态校验等。可能的值:'."\n" + ."\n" + .'- true:发送请求,不创建服务实例。'."\n" + ."\n" + .'- false:发送请求,检查通过后创建服务实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + 'UpgradeRequiredParameters' => [ + 'description' => '升级到新版本服务需要新增的参数,只在DryRun为true时返回,用于正式升级时补充新增的参数', + 'type' => 'array', + 'items' => [ + 'description' => '升级需要的参数名称。', + 'type' => 'string', + 'example' => 'InstancePassword', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"UpgradeRequiredParameters\\": [\\n \\"InstancePassword\\"\\n ]\\n}","type":"json"}]', + 'title' => '升级服务实例版本', + ], + 'CreateServiceInstance' => [ + 'summary' => '通过配置地域ID、服务实例名称、服务 ID等参数,在计算巢中创建并部署服务实例。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '36939', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + 'FEATUREcomputenestVUFVAC', + 'FEATUREcomputenestZFWIMH', + 'FEATUREcomputenestQKB5Y7', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。可能的值:'."\n" + ."\n" + .'- cn-hangzhou:华东1(杭州) 。'."\n" + ."\n" + .'- ap-southeast-1:新加坡。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例名称。格式要求如下:'."\n" + ."\n" + .'- 长度不超过64个字符。'."\n" + ."\n" + .'- 必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestName', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'service-0e6fca6a51a54420****', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户实例部署的参数。'."\n" + ."\n" + .'> 若服务实例包含部署地域信息,需在部署参数中填写。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "RegionId": "cn-hangzhou"'."\n" + .' "NodeCount": 3,'."\n" + .' "SystemDiskSize": 40,'."\n" + .' "InstancePassword": "******"'."\n" + .'}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EnableInstanceOps', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例是否有代运维功能。取值范围:'."\n" + ."\n" + .'- **true**:服务实例有代运维功能。'."\n" + ."\n" + .'- **false**:服务实例没有代运维功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称,服务支持多模板时需要指定模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板1', + ], + ], + [ + 'name' => 'OperationMetadata', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '代运维配置。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '运维开始时间,只在纯代运维模式下有效。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-29T06:48:56Z', + ], + 'EndTime' => [ + 'description' => '运维结束时间,只在纯代运维模式下有效。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-28T06:48:56Z', + ], + 'Resources' => [ + 'description' => '导入的资源列表。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "RegionId": "cn-hangzhou", "Type": "ResourceIds", "ResourceIds": { "ALIYUN::ECS::INSTANCE": ["i-xxx", "i-yyy"], "ALIYUN::RDS::INSTANCE": ["rm-xxx", "rm-yyy"], "ALIYUN::VPC::VPC": ["vpc-xxx", "vpc-yyy"], "ALIYUN::SLB::INSTANCE": ["lb-xxx", "lb-yyy"] } }', + ], + 'ServiceInstanceId' => [ + 'description' => '导入的服务实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + 'ExtraInfo' => [ + 'description' => '代运维服务附加信息。', + 'type' => 'string', + 'required' => false, + 'example' => ' ```json'."\n" + .' {'."\n" + .' "vncInfo": ['."\n" + .' {'."\n" + .' "instanceId": "i-001",'."\n" + .' "username": "admin",'."\n" + .' "password": "******",'."\n" + .' "vncPassword": "******"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ```', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-bp67acfmxazb4p****', + ], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '接收告警的云监控联系人组。', + 'type' => 'string', + 'required' => false, + 'example' => '云账号报警联系人', + ], + ], + [ + 'name' => 'TrialType', + 'in' => 'query', + 'schema' => [ + 'description' => '当前服务实例的类型。可选值:'."\n" + ."\n" + .'- **Trial**:支持试用。'."\n" + ."\n" + .'- **NotTrial**:不支持试用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Trial', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'SpecificationName', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐规格名称。', + 'type' => 'string', + 'required' => false, + 'example' => '套餐一', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检,包括权限、实例状态校验等。可能的值:'."\n" + ."\n" + .'- **true**:发送请求,不创建服务实例。'."\n" + ."\n" + .'- **false**:发送请求,检查通过后创建服务实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SpecificationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品规格码。', + 'type' => 'string', + 'required' => false, + 'example' => 'yuncode5425200001', + ], + ], + [ + 'name' => 'EnableUserPrometheus', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用Prometheus监控,可能的值:'."\n" + ."\n" + .'- **true**:启用。'."\n" + ."\n" + .'- **false**:不启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Commodity', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '云市场购买订单信息,服务未上云市场或按量计费不必传。', + 'type' => 'object', + 'properties' => [ + 'PayPeriodUnit' => [ + 'description' => '购买时间单位,取值:'."\n" + ."\n" + .'- **Year**:年。'."\n" + ."\n" + .'- **Month**:月。'."\n" + ."\n" + .'- **Day**:日。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + 'PayPeriod' => [ + 'description' => '购买时间长度。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'AutoRenew' => [ + 'description' => '是否开启自动续费,取值:'."\n" + .'* **true**:开启。'."\n" + .'* **false**:不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'AutoPay' => [ + 'description' => '订单是否自动支付。取值:'."\n" + ."\n" + .'- **true**:自动支付。'."\n" + .'- **false**:不自动支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'CouponId' => [ + 'description' => '优惠券ID。', + 'type' => 'string', + 'required' => false, + 'example' => '302070970220', + ], + 'QuotationId' => [ + 'description' => '云市场PrivateOffer ID', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceAutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '资源是否自动从余额中扣款支付。取值:'."\n" + .'- **true**:自动支付。'."\n" + .'- **false**:不自动支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需转正式的服务实例id', + 'type' => 'string', + 'required' => false, + 'example' => 'si-d32fbcef30664721b785', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '服务实例状态。取值:'."\n" + ."\n" + .'- **Created**:已创建。'."\n" + ."\n" + .'- **Deploying**:部署中。'."\n" + ."\n" + .'- **DeployedFailed**:部署失败。'."\n" + ."\n" + .'- **Deployed**:已部署。'."\n" + ."\n" + .'- **Upgrading**:升级中。'."\n" + ."\n" + .'- **Deleting**:删除中。'."\n" + ."\n" + .'- **Deleted**:已删除。'."\n" + ."\n" + .'- **DeletedFailed**:删除失败。', + 'type' => 'string', + 'example' => 'Created', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D****', + ], + 'ServiceInstanceId' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + 'MarketInstanceId' => [ + 'description' => '云市场实例ID。', + 'type' => 'string', + 'example' => '786***45', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2306175xxxxxxxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Created\\",\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D****\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"MarketInstanceId\\": \\"786***45\\",\\n \\"OrderId\\": \\"2306175xxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceInstanceResponse>\\n <Status>Created</Status>\\n <RequestId>4DB0F536-B3BE-4F0D-BD29-E83FB56D****</RequestId>\\n <ServiceInstanceId>si-d6ab3a63ccbb4b17****</ServiceInstanceId>\\n</CreateServiceInstanceResponse>","errorExample":""}]', + 'title' => '创建并部署服务实例', + ], + 'GetServiceInstance' => [ + 'summary' => '通过地域ID、服务实例iD或者云市场实例ID、查询服务实例的详细信息,例如服务状态、模板名称、资源列表等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36936', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '服务实例ID。'."\n" + .'>输入参数时, `ServiceInstanceId`或`MarketInstanceId`其中一个参数必须填写,否则将无法查询服务实例的详细信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MarketInstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '云市场实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '704***59', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Outputs' => [ + 'description' => '创建服务实例返回的输出字段。'."\n" + ."\n" + .'- ROS模式下,返回模板所有输出字段。'."\n" + ."\n" + .'- SPI模式下,返回ISV输出字段和计算巢附加功能输出字段。', + 'type' => 'string', + 'example' => '{"InstanceIds":["i-hp38ofxl0dsyfi7z****"]}', + ], + 'Status' => [ + 'description' => '服务实例的部署状态。可能值:'."\n" + ."\n" + .'- Created:已创建。'."\n" + ."\n" + .'- Deploying:部署中。'."\n" + ."\n" + .'- DeployedFailed:部署失败。'."\n" + ."\n" + .'- Deployed:已部署。'."\n" + ."\n" + .'- Upgrading:升级中。'."\n" + ."\n" + .'- Deleting:删除中。'."\n" + ."\n" + .'- Deleted:已删除。'."\n" + ."\n" + .'- DeletedFailed:删除失败。', + 'type' => 'string', + 'example' => 'Deployed', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2021-05-20T00:00:00Z', + ], + 'Progress' => [ + 'description' => '服务实例的部署进度,单位:%。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'Parameters' => [ + 'description' => '部署服务实例输入的参数。', + 'type' => 'string', + 'example' => '{"param":"value"}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + 'ServiceInstanceId' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2021-05-20T00:00:00Z', + ], + 'StatusDetail' => [ + 'description' => '部署实例的状态描述。', + 'type' => 'string', + 'example' => 'deploy successfully', + ], + 'Resources' => [ + 'description' => '资源列表。', + 'type' => 'string', + 'example' => '[{"StackId": "stack-xxx"}]', + ], + 'Service' => [ + 'description' => '服务详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '服务状态。可能的值:'."\n" + ."\n" + .'- Draft:待提交注册。'."\n" + ."\n" + .'- Submited:已提交注册。'."\n" + ."\n" + .'- Approved:已通过注册审核。'."\n" + ."\n" + .'- Online:已上线。'."\n" + ."\n" + .'- Offline:已下线。'."\n" + ."\n" + .'- Deleted:已删除。'."\n" + ."\n" + .'- Launching:服务上线中。', + 'type' => 'string', + 'example' => 'Online', + ], + 'PublishTime' => [ + 'description' => '发布时间。', + 'type' => 'string', + 'example' => '2021-05-21T00:00:00Z', + ], + 'Version' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'example' => '1', + ], + 'DeployMetadata' => [ + 'description' => '存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用JSON String格式进行数据存储。 ', + 'type' => 'string', + 'example' => '{"EstimateTime":null,"SupplierDeployMetadata":{"DeployTimeout":null},"TemplateConfigs":[{"Name":"模板1","Url":"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json","PredefinedParameters":[],"AllowedRegions":["cn-hangzhou"]}]}', + ], + 'DeployType' => [ + 'description' => '部署类型。可能值:'."\n" + ."\n" + .'- ros:通过ROS部署。'."\n" + ."\n" + .'- terraform:通过Terraform部署。'."\n" + ."\n" + .'- ack:通过ACK部署。'."\n" + ."\n" + .'- spi:调用SPI部署。'."\n" + ."\n" + .'- operation:代运维服务部署。', + 'type' => 'string', + 'example' => 'ros', + ], + 'ServiceId' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'example' => 'service-9c8a3522528b4fe8****', + ], + 'SupplierUrl' => [ + 'description' => '服务商地址。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'ServiceType' => [ + 'description' => '服务类型。可能值:'."\n" + ."\n" + .'- private:部署在用户账户下。'."\n" + ."\n" + .'- managed:托管在服务商账户下。'."\n" + ."\n" + .'- operation:代运维服务。', + 'type' => 'string', + 'example' => 'private', + ], + 'SupplierName' => [ + 'description' => '服务商名称。', + 'type' => 'string', + 'example' => 'A公司', + ], + 'ServiceInfos' => [ + 'description' => '服务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务信息。', + 'type' => 'object', + 'properties' => [ + 'Locale' => [ + 'description' => '服务实例语言。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'Image' => [ + 'description' => '服务图标地址。', + 'type' => 'string', + 'example' => 'https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png', + ], + 'Name' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'B数据库', + ], + 'ShortDescription' => [ + 'description' => '服务概述。', + 'type' => 'string', + 'example' => 'B是A公司自主设计并研发的开源分布式的关系型数据库', + ], + ], + ], + ], + 'VersionName' => [ + 'description' => '服务商自定义版本名称。', + 'type' => 'string', + 'example' => '版本A', + ], + 'UpgradeMetadata' => [ + 'description' => '升级元数据。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Type": "OOS",'."\n" + .' "Description": "Changelog or something description",'."\n" + .' "SupportUpgradeFromVersions": [1, 2],'."\n" + .' "UpgradeSteps": {'."\n" + .' "PreUpgradeStage": {'."\n" + .' "Description": "初始化数据库",'."\n" + .' "Type": "RunCommand",'."\n" + .' "ResourceName": "EcsRole1",'."\n" + .' "CommandType": "runShellScript",'."\n" + .' "CommandContent": "echo hello"'."\n" + .' },'."\n" + .' "UpgradeStage": [{'."\n" + .' "Description": "更新EcsRole1实例",'."\n" + .' "Type": "RunCommand",'."\n" + .' "ResourceName": "EcsRole1",'."\n" + .' "ArtifactsDownloadDirectory": "/home/admin",'."\n" + .' "CommandType": "runShellScript",'."\n" + .' "CommandContent": "echo hello"'."\n" + .' }],'."\n" + .' "PostUpgradeStage": {'."\n" + .' "Description": "部署后post check",'."\n" + .' "Type": "None/RunCommand",'."\n" + .' "ResourceName": "EcsRole1",'."\n" + .' "CommandType": "runShellScript",'."\n" + .' "CommandContent": "echo hello"'."\n" + .' }'."\n" + .' }'."\n" + .'}', + ], + 'UpgradableServiceVersions' => [ + 'description' => '可升级的服务版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可升级的服务版本号。', + 'type' => 'string', + 'example' => '1', + ], + ], + 'UpgradableServiceInfos' => [ + 'description' => '可升级的服务版本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '可升级的服务版本信息。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'example' => 'draft', + ], + 'VersionName' => [ + 'description' => '版本名称。', + 'type' => 'string', + 'example' => '20241112', + ], + ], + ], + ], + 'ServiceProductUrl' => [ + 'description' => '产品页URL。', + 'type' => 'string', + 'example' => 'https://service-info-private.oss-cn-hangzhou.aliyuncs.com', + ], + 'ServiceDocUrl' => [ + 'description' => '产品文档的URL。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'OperationMetadata' => [ + 'description' => '运维操作相关参数,包括变配、prometheus、日志配置等', + 'type' => 'string', + 'example' => '{"SupportBackup":false,"PrometheusConfigMap":{},"ModifyParametersConfig":[{"TemplateName":"国内版","Operation":[{"Name":"套餐变配","Description":"套餐变配","Type":"Custom","SupportPredefinedParameters":true,"EnableLogging":false},{"Name":"参数变配","Description":"参数变配","Type":"Custom","SupportPredefinedParameters":false,"EnableLogging":false,"Parameters":["DataDiskSize"]}]}]}', + ], + ], + ], + 'OperationStartTime' => [ + 'description' => '代运维开始时间。', + 'type' => 'string', + 'example' => '2021-12-29T06:48:56Z', + ], + 'OperationEndTime' => [ + 'description' => '代运维结束时间。', + 'type' => 'string', + 'example' => '2022-01-28T06:48:56Z', + ], + 'OperatedServiceInstanceId' => [ + 'description' => '被代运维的服务实例ID。', + 'type' => 'string', + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + 'EnableInstanceOps' => [ + 'description' => '服务实例是否有代运维功能。可能的值:'."\n" + ."\n" + .'- true:服务实例有代运维功能。'."\n" + ."\n" + .'- false:服务实例没有代运维功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsOperated' => [ + 'description' => '服务实例的代运维功能是否开启。可能的值:'."\n" + ."\n" + .'- true:服务实例的代运维功能已开启。'."\n" + ."\n" + .'- false:服务实例的代运维功能未开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NetworkConfig' => [ + 'description' => '网络配置信息。'."\n" + ."\n" + .'> 该参数已废弃。'."\n", + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'description' => '私网连接的终端节点ID。'."\n" + ."\n" + .'> 该参数已废弃。', + 'type' => 'string', + 'example' => 'ep-m5ei37240541816b****', + ], + 'PrivateZoneId' => [ + 'description' => '自定义私网域名云解析privatezone的ID。'."\n" + ."\n" + .'> 该参数已废弃。', + 'type' => 'string', + 'example' => 'cb7f214f80ac348d87daaeac1f35****', + ], + 'PrivateVpcConnections' => [ + 'description' => '私网连接信息。', + 'type' => 'array', + 'items' => [ + 'description' => '私网连接信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'description' => '私网连接的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-m5ei37240541816b****', + ], + 'PrivateZoneId' => [ + 'description' => '自定义私网域名云解析privatezone的ID。', + 'type' => 'string', + 'example' => 'cb7f214f80ac348d87daaeac1f35****', + ], + 'PrivateZoneName' => [ + 'description' => '自定义域名。', + 'type' => 'string', + 'example' => 'test.computenest.aliyuncs.com', + ], + 'ConnectionConfigs' => [ + 'description' => '网络配置信息。'."\n" + .'主要用于私网连接。', + 'type' => 'array', + 'items' => [ + 'description' => '网络配置信息。'."\n" + .'主要用于私网连接。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1vwnn14rqpyiczj****', + ], + 'SecurityGroups' => [ + 'description' => '安全组名称。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组名称。', + 'type' => 'string', + 'example' => '\'sg-m5ec4mvoq9egn7xxxxxx', + ], + ], + 'VSwitches' => [ + 'description' => '虚拟交换机名称。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机名称。', + 'type' => 'string', + 'example' => 'vsw-uf6iqwohr05dw4mxxxxxx', + ], + ], + 'IngressEndpointStatus' => [ + 'description' => 'IngressEndpoint状态。可能的值:'."\n" + ."\n" + .'- Ready(已连接)。'."\n" + ."\n" + .'- Pending(连接中)。'."\n" + ."\n" + .'- Failed(连接失败)。'."\n" + ."\n" + .'- Deleted(已删除)。'."\n" + ."\n" + .'- Deleting(删除中)。', + 'type' => 'string', + 'example' => 'Ready', + ], + 'NetworkServiceStatus' => [ + 'description' => 'NetworkServiceStatus状态。可能的值:'."\n" + ."\n" + .'- Ready(已连接)。'."\n" + ."\n" + .'- Pending(连接中)。'."\n" + ."\n" + .'- Failed(连接失败)。'."\n" + ."\n" + .'- Deleted(已删除)。'."\n" + ."\n" + .'- Deleting(删除中)。', + 'type' => 'string', + 'example' => 'Ready', + ], + 'EndpointIps' => [ + 'description' => '私网连接终端节点IP。', + 'type' => 'array', + 'items' => [ + 'description' => '私网连接终端节点IP。', + 'type' => 'string', + 'example' => '192.xxx.xxx.xxx', + ], + ], + 'DomainName' => [ + 'description' => '域名名称。', + 'type' => 'string', + 'example' => 'ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com', + ], + 'RegionId' => [ + 'description' => '基于计算巢内网互联模式构建私网互联时,终端节点所在VPC的地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ConnectBandwidth' => [ + 'description' => '使用计算巢内网互联建立连接的限速带宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1536Mbps', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '基于PrivateLink构建私网连接时终端节点所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'ReversePrivateVpcConnections' => [ + 'description' => '反向私网连接信息。', + 'type' => 'array', + 'items' => [ + 'description' => '反向私网连接信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'description' => '反向私网连接的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-m5ei42370541816b****', + ], + ], + ], + ], + ], + ], + 'Tags' => [ + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'LicenseEndTime' => [ + 'description' => '许可到期时间。', + 'type' => 'string', + 'example' => '2022-01-01T12:00:00', + ], + 'UserId' => [ + 'description' => '用户的AliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '130920852836****', + ], + 'SupplierUid' => [ + 'description' => '服务商AliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158927391332*****', + ], + 'EndTime' => [ + 'description' => '服务实例过期时间。', + 'type' => 'string', + 'example' => '2022-01-01T12:00:00', + ], + 'Source' => [ + 'description' => '服务实例来源。可能的值:'."\n" + ."\n" + .'- User:计算巢用户。'."\n" + ."\n" + .'- Market:云市场。'."\n" + ."\n" + .'- Supplier:计算巢服务商。', + 'type' => 'string', + 'example' => 'User', + ], + 'ServiceType' => [ + 'description' => '服务类型。可能的值:'."\n" + ."\n" + .'- private:部署在用户账户下的服务实例。'."\n" + ."\n" + .'- managed:托管在服务商账户下的服务实例。'."\n" + ."\n" + .'- operation:代运维服务实例'."\n" + ."\n" + .'- poc:试用服务实例。', + 'type' => 'string', + 'example' => 'private', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围:'."\n" + ."\n" + .'- Permanent:永久购买。'."\n" + ."\n" + .'- Subscription:云市场包年包月。'."\n" + ."\n" + .'- PayAsYouGo:云市场按量付费。'."\n" + ."\n" + .'- CustomFixTime:商家自定义固定时长。'."\n", + 'type' => 'string', + 'example' => 'Subscription', + ], + 'Name' => [ + 'description' => '服务实例名称。', + 'type' => 'string', + 'example' => 'TestName', + ], + 'EnableUserPrometheus' => [ + 'description' => '是否启用Prometheus监控。可能的值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:不启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Components' => [ + 'description' => '云市场额外计费项。', + 'type' => 'string', + 'example' => '{"TiKVServerCount":"3","package_version":"yuncode5398300001","PDServerCount":"3","TiDBServerCount":"2"}', + ], + 'PredefinedParameterName' => [ + 'description' => '套餐名称。', + 'type' => 'string', + 'example' => '套餐一', + ], + 'MarketInstanceId' => [ + 'description' => '云市场实例ID。', + 'type' => 'string', + 'example' => '704***59', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-bp67acfmxazb4p****', + ], + 'BizStatus' => [ + 'description' => '服务实例的业务状态。可能的值:'."\n" + ."\n" + .'- Normal:正常。'."\n" + ."\n" + .'- Renewing:续费中。'."\n" + ."\n" + .'- RenewFoiled:续费失败。'."\n" + ."\n" + .'- Expired:已过期。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'GrafanaDashBoardUrl' => [ + 'description' => 'grafana大盘链接。', + 'type' => 'string', + 'example' => 'https://g.console.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s', + ], + 'SupportTrialToPrivate' => [ + 'description' => '是否支持试用转正式', + 'type' => 'boolean', + ], + 'PolicyNames' => [ + 'type' => 'string', + ], + 'GrantedPermission' => [ + 'type' => 'object', + 'properties' => [ + 'OperationEndTime' => [ + 'type' => 'string', + ], + 'PolicyNames' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Outputs\\": \\"{\\\\\\"InstanceIds\\\\\\":[\\\\\\"i-hp38ofxl0dsyfi7z****\\\\\\"]}\\",\\n \\"Status\\": \\"Deployed\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"Progress\\": 90,\\n \\"Parameters\\": \\"{\\\\\\"param\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"StatusDetail\\": \\"deploy successfully\\",\\n \\"Resources\\": \\"[{\\\\\\"StackId\\\\\\": \\\\\\"stack-xxx\\\\\\"}]\\",\\n \\"Service\\": {\\n \\"Status\\": \\"Online\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Version\\": \\"1\\",\\n \\"DeployMetadata\\": \\"{\\\\\\"EstimateTime\\\\\\":null,\\\\\\"SupplierDeployMetadata\\\\\\":{\\\\\\"DeployTimeout\\\\\\":null},\\\\\\"TemplateConfigs\\\\\\":[{\\\\\\"Name\\\\\\":\\\\\\"模板1\\\\\\",\\\\\\"Url\\\\\\":\\\\\\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\\\\\\",\\\\\\"PredefinedParameters\\\\\\":[],\\\\\\"AllowedRegions\\\\\\":[\\\\\\"cn-hangzhou\\\\\\"]}]}\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-9c8a3522528b4fe8****\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"SupplierName\\": \\"A公司\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png\\",\\n \\"Name\\": \\"B数据库\\",\\n \\"ShortDescription\\": \\"B是A公司自主设计并研发的开源分布式的关系型数据库\\"\\n }\\n ],\\n \\"VersionName\\": \\"版本A\\",\\n \\"UpgradeMetadata\\": \\"{\\\\n \\\\\\"Type\\\\\\": \\\\\\"OOS\\\\\\",\\\\n \\\\\\"Description\\\\\\": \\\\\\"Changelog or something description\\\\\\",\\\\n \\\\\\"SupportUpgradeFromVersions\\\\\\": [1, 2],\\\\n \\\\\\"UpgradeSteps\\\\\\": {\\\\n \\\\\\"PreUpgradeStage\\\\\\": {\\\\n \\\\\\"Description\\\\\\": \\\\\\"初始化数据库\\\\\\",\\\\n \\\\\\"Type\\\\\\": \\\\\\"RunCommand\\\\\\",\\\\n \\\\\\"ResourceName\\\\\\": \\\\\\"EcsRole1\\\\\\",\\\\n \\\\\\"CommandType\\\\\\": \\\\\\"runShellScript\\\\\\",\\\\n \\\\\\"CommandContent\\\\\\": \\\\\\"echo hello\\\\\\"\\\\n },\\\\n \\\\\\"UpgradeStage\\\\\\": [{\\\\n \\\\\\"Description\\\\\\": \\\\\\"更新EcsRole1实例\\\\\\",\\\\n \\\\\\"Type\\\\\\": \\\\\\"RunCommand\\\\\\",\\\\n \\\\\\"ResourceName\\\\\\": \\\\\\"EcsRole1\\\\\\",\\\\n \\\\\\"ArtifactsDownloadDirectory\\\\\\": \\\\\\"/home/admin\\\\\\",\\\\n \\\\\\"CommandType\\\\\\": \\\\\\"runShellScript\\\\\\",\\\\n \\\\\\"CommandContent\\\\\\": \\\\\\"echo hello\\\\\\"\\\\n }],\\\\n \\\\\\"PostUpgradeStage\\\\\\": {\\\\n \\\\\\"Description\\\\\\": \\\\\\"部署后post check\\\\\\",\\\\n \\\\\\"Type\\\\\\": \\\\\\"None/RunCommand\\\\\\",\\\\n \\\\\\"ResourceName\\\\\\": \\\\\\"EcsRole1\\\\\\",\\\\n \\\\\\"CommandType\\\\\\": \\\\\\"runShellScript\\\\\\",\\\\n \\\\\\"CommandContent\\\\\\": \\\\\\"echo hello\\\\\\"\\\\n }\\\\n }\\\\n}\\",\\n \\"UpgradableServiceVersions\\": [\\n \\"1\\"\\n ],\\n \\"UpgradableServiceInfos\\": [\\n {\\n \\"Version\\": \\"draft\\",\\n \\"VersionName\\": \\"20241112\\"\\n }\\n ],\\n \\"ServiceProductUrl\\": \\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"ServiceDocUrl\\": \\"http://example.com\\",\\n \\"OperationMetadata\\": \\"{\\\\\\"SupportBackup\\\\\\":false,\\\\\\"PrometheusConfigMap\\\\\\":{},\\\\\\"ModifyParametersConfig\\\\\\":[{\\\\\\"TemplateName\\\\\\":\\\\\\"国内版\\\\\\",\\\\\\"Operation\\\\\\":[{\\\\\\"Name\\\\\\":\\\\\\"套餐变配\\\\\\",\\\\\\"Description\\\\\\":\\\\\\"套餐变配\\\\\\",\\\\\\"Type\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"SupportPredefinedParameters\\\\\\":true,\\\\\\"EnableLogging\\\\\\":false},{\\\\\\"Name\\\\\\":\\\\\\"参数变配\\\\\\",\\\\\\"Description\\\\\\":\\\\\\"参数变配\\\\\\",\\\\\\"Type\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"SupportPredefinedParameters\\\\\\":false,\\\\\\"EnableLogging\\\\\\":false,\\\\\\"Parameters\\\\\\":[\\\\\\"DataDiskSize\\\\\\"]}]}]}\\"\\n },\\n \\"OperationStartTime\\": \\"2021-12-29T06:48:56Z\\",\\n \\"OperationEndTime\\": \\"2022-01-28T06:48:56Z\\",\\n \\"OperatedServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"EnableInstanceOps\\": true,\\n \\"IsOperated\\": true,\\n \\"NetworkConfig\\": {\\n \\"EndpointId\\": \\"ep-m5ei37240541816b****\\",\\n \\"PrivateZoneId\\": \\"cb7f214f80ac348d87daaeac1f35****\\",\\n \\"PrivateVpcConnections\\": [\\n {\\n \\"EndpointId\\": \\"ep-m5ei37240541816b****\\",\\n \\"PrivateZoneId\\": \\"cb7f214f80ac348d87daaeac1f35****\\",\\n \\"PrivateZoneName\\": \\"test.computenest.aliyuncs.com\\",\\n \\"ConnectionConfigs\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1vwnn14rqpyiczj****\\",\\n \\"SecurityGroups\\": [\\n \\"\'sg-m5ec4mvoq9egn7xxxxxx\\"\\n ],\\n \\"VSwitches\\": [\\n \\"vsw-uf6iqwohr05dw4mxxxxxx\\"\\n ],\\n \\"IngressEndpointStatus\\": \\"Ready\\",\\n \\"NetworkServiceStatus\\": \\"Ready\\",\\n \\"EndpointIps\\": [\\n \\"192.xxx.xxx.xxx\\"\\n ],\\n \\"DomainName\\": \\"ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ConnectBandwidth\\": 0\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ReversePrivateVpcConnections\\": [\\n {\\n \\"EndpointId\\": \\"ep-m5ei42370541816b****\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"LicenseEndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"UserId\\": 0,\\n \\"SupplierUid\\": 0,\\n \\"EndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"Source\\": \\"User\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"Name\\": \\"TestName\\",\\n \\"EnableUserPrometheus\\": true,\\n \\"Components\\": \\"{\\\\\\"TiKVServerCount\\\\\\":\\\\\\"3\\\\\\",\\\\\\"package_version\\\\\\":\\\\\\"yuncode5398300001\\\\\\",\\\\\\"PDServerCount\\\\\\":\\\\\\"3\\\\\\",\\\\\\"TiDBServerCount\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"PredefinedParameterName\\": \\"套餐一\\",\\n \\"MarketInstanceId\\": \\"704***59\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"BizStatus\\": \\"Normal\\",\\n \\"GrafanaDashBoardUrl\\": \\"https://g.console.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s\\",\\n \\"SupportTrialToPrivate\\": true,\\n \\"PolicyNames\\": \\"\\",\\n \\"GrantedPermission\\": {\\n \\"OperationEndTime\\": \\"\\",\\n \\"PolicyNames\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetServiceInstanceResponse>\\n <Outputs>{\\"InstanceIds\\":[\\"i-hp38ofxl0dsyfi7z****\\"]}</Outputs>\\n <Status>Deployed</Status>\\n <TemplateName>模板1</TemplateName>\\n <UpdateTime>2021-05-20T00:00:00Z</UpdateTime>\\n <Progress>90</Progress>\\n <Parameters>{\\"param\\":\\"value\\"}</Parameters>\\n <RequestId>4DB0F536-B3BE-4F0D-BD29-E83FB56D550C</RequestId>\\n <ServiceInstanceId>si-d6ab3a63ccbb4b17****</ServiceInstanceId>\\n <CreateTime>2021-05-20T00:00:00Z</CreateTime>\\n <StatusDetail>deploy successfully</StatusDetail>\\n <Resources>[{\\"StackId\\": \\"stack-xxx\\"}]</Resources>\\n <Service>\\n <Status>Online</Status>\\n <PublishTime>2021-05-21T00:00:00Z</PublishTime>\\n <Version>1</Version>\\n <DeployMetadata>{\\"EstimateTime\\":null,\\"SupplierDeployMetadata\\":{\\"DeployTimeout\\":null},\\"TemplateConfigs\\":[{\\"Name\\":\\"模板1\\",\\"Url\\":\\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\\",\\"PredefinedParameters\\":[],\\"AllowedRegions\\":[\\"cn-hangzhou\\"]}]}</DeployMetadata>\\n <DeployType>ros</DeployType>\\n <ServiceId>service-9c8a3522528b4fe8****</ServiceId>\\n <SupplierUrl>http://example.com</SupplierUrl>\\n <ServiceType>private</ServiceType>\\n <SupplierName>A公司</SupplierName>\\n <ServiceInfos>\\n <Locale>zh-CN</Locale>\\n <Image>https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png</Image>\\n <Name>B数据库</Name>\\n <ShortDescription>B是A公司自主设计并研发的开源分布式的关系型数据库</ShortDescription>\\n </ServiceInfos>\\n </Service>\\n <OperationStartTime>2021-12-29T06:48:56Z</OperationStartTime>\\n <OperationEndTime>2022-01-28T06:48:56Z</OperationEndTime>\\n <OperatedServiceInstanceId>si-d6ab3a63ccbb4b17****</OperatedServiceInstanceId>\\n <EnableInstanceOps>true</EnableInstanceOps>\\n <IsOperated>true</IsOperated>\\n</GetServiceInstanceResponse>","errorExample":""}]', + 'title' => '查询服务实例的详细信息', + ], + 'ContinueDeployServiceInstance' => [ + 'summary' => '服务实例部署失败后,调用ContinueDeployServiceInstance继续部署该服务实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '43087', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + 'FEATUREcomputenestVUFVAC', + 'FEATUREcomputenestZFWIMH', + 'FEATUREcomputenestQKB5Y7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'si-0e6fca6a51a54420****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例配置参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******"}', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检,包括权限、实例状态校验等。可能的值:'."\n" + ."\n" + .'- true:发送请求,不创建服务实例。'."\n" + ."\n" + .'- false:发送请求,检查通过后创建服务实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Option', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '重新创建选项。', + 'type' => 'array', + 'items' => [ + 'description' => '重新创建选项。可能的值:'."\n" + ."\n" + .'- TryToFixSignalFailureByRerunEcsCommand:尝试修复已存在的信号失败。当ALIYUN::ROS::WaitCondition类型资源创建失败时,找到与之关联且创建成功的ALIYUN::ECS::RunCommand和ALIYUN::ECS::Invocation类型的资源,对这些资源及依赖其的资源进行重建。'."\n" + ."\n" + .'- IgnoreExistingSignalFailure:忽略已存在的信号失败。如果之前存在创建失败的ALIYUN::ROS::WaitCondition类型的资源,新一次的创建过程中会直接创建成功。'."\n" + ."\n" + .'- AutoRecreatingResources:自动重新创建模板内容或引用参数发生变化的资源,包括依赖其的资源。使用该选项,可以简化RecreatingResources.N参数的设置,但也可能造成意料之外的资源重建。'."\n" + ."\n" + .'> 仅对ROS类型的资源栈生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'TryToFixSignalFailureByRerunEcsCommand', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + 'DryRunResult' => [ + 'description' => '校验结果。', + 'type' => 'object', + 'properties' => [ + 'ParametersNotAllowedToBeModified' => [ + 'description' => '不允许修改的参数。修改参数一定会引发校验错误。'."\n" + .'> 仅在DryRun为true时返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '不允许修改的参数。修改参数一定会引发校验错误。'."\n" + .'> 仅在DryRun为true时返回结果。', + 'type' => 'string', + 'example' => 'cidr', + ], + ], + 'ParametersConditionallyAllowedToBeModified' => [ + 'description' => '可能允许修改的参数。'."\n" + .'修改参数是否引起校验错误,取决于参数的取值。'."\n" + .'> 仅在DryRun为true时返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '可能允许修改的参数。'."\n" + .'修改参数是否引起校验错误,取决于参数的取值。'."\n" + .'> 仅在DryRun为true时返回结果。', + 'type' => 'string', + 'example' => 'name', + ], + ], + 'ParametersAllowedToBeModified' => [ + 'description' => '允许修改的参数。修改参数不会引发校验错误。'."\n" + .'> 仅在DryRun为true时返回值。', + 'type' => 'array', + 'items' => [ + 'description' => '允许修改的参数。修改参数不会引发校验错误。'."\n" + .'> 仅在DryRun为true时返回值。', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + 'ServiceInstanceId' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"DryRunResult\\": {\\n \\"ParametersNotAllowedToBeModified\\": [\\n \\"cidr\\"\\n ],\\n \\"ParametersConditionallyAllowedToBeModified\\": [\\n \\"name\\"\\n ],\\n \\"ParametersAllowedToBeModified\\": [\\n \\"description\\"\\n ]\\n },\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\"\\n}","errorExample":""},{"type":"xml","example":"<ContinueDeployServiceInstanceResponse>\\n <RequestId>4DB0F536-B3BE-4F0D-BD29-E83FB56D550C</RequestId>\\n</ContinueDeployServiceInstanceResponse>","errorExample":""}]', + 'title' => '继续部署服务实例', + 'description' => '待部署服务实例的服务类型为private、部署类型为ros时,部署失败后可调用ContinueDeployServiceInstance继续部署该服务实例。', + ], + 'DeleteServiceInstances' => [ + 'summary' => '通过地域ID、服务实例ID,精确删除对应的服务实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '36935', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '服务实例ID。N的取值范围:1~100。'."\n" + ."\n" + .'> 若要删除多个服务实例,服务实例间用&&隔开。例如:ServiceInstanceId.1=xxx&&ServiceInstanceId.2=yyy。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'ComputeNest::2021-06-01::GetServiceInstance', + 'callbackInterval' => 2000, + 'maxCallbackTimes' => 500, + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceInstancesResponse>\\n <RequestId>4DB0F536-B3BE-4F0D-BD29-E83FB56D550C</RequestId>\\n</DeleteServiceInstancesResponse>","errorExample":""}]', + 'title' => '删除服务实例', + ], + 'ListServiceInstanceLogs' => [ + 'summary' => '通过地域 ID、服务实例 ID等参数查询服务实例的部署和升级日志', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55519', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-70a3b15bb626435b****', + ], + ], + [ + 'name' => 'LogSource', + 'in' => 'query', + 'schema' => [ + 'description' => '选择日志源。可选值:'."\n" + ."\n" + .'- computeNest(默认值):服务实例部署、升级的日志。'."\n" + ."\n" + .'- application:应用产生的日志。'."\n" + ."\n" + .'- actionTrail: 操作审计日志'."\n" + ."\n" + .'- ros: ROS日志'."\n" + ."\n" + .'- compliancePack: 合规包日志', + 'type' => 'string', + 'required' => false, + 'example' => 'computeNest', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => 'Logstore信息。'."\n" + .'查询应用日志时,需要指定Logstore。', + 'type' => 'string', + 'required' => false, + 'example' => 'logabc', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤器。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '过滤器值列表。N的取值范围:1~10。', + 'type' => 'array', + 'items' => [ + 'description' => '指定过滤条件Value。', + 'type' => 'string', + 'required' => false, + 'example' => '- StartTime:2024-07-01T02:41:20Z'."\n" + .'- EndTime:2024-07-01T02:41:20Z'."\n" + .'- EventName:DeleteInstance'."\n" + .'- ResourceName:i-bp1dgfcx8vl4w9m7a1st'."\n" + .'- ApplicationGroupName:groupA', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'Name' => [ + 'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n" + ."\n" + .'- StartTime: 按日志事件的开始时间查询。'."\n" + .'- EndTime: 按ActionTrail事件的结束时间查询。'."\n" + .'- EventName: 按ActionTrail事件的名称查询。'."\n" + .'- ResourceName: 按ActionTrail资源名称查询。'."\n" + .'- ApplicationGroupName: 按应用程序组名称查询。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'EndTime' => 'EndTime', + 'ResourceName' => 'ResourceName', + 'StartTime' => 'StartTime', + 'EventName' => 'EventName', + ], + 'example' => '- StartTime'."\n" + .'- EndTime'."\n" + .'- EventName'."\n" + .'- ResourceName'."\n" + .'- ApplicationGroupName', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向。取值范围:'."\n" + .'+ Ascending:升序'."\n" + .'+ Descending(默认值):降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Descending' => 'Descending', + 'Ascending' => 'Ascending', + ], + 'example' => '- Ascending'."\n" + .'- Descending', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '51945B04-6AA6-410D-93BA-236E0248B104', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ServiceInstancesLogs' => [ + 'description' => '服务实例日志。', + 'type' => 'array', + 'items' => [ + 'description' => '服务实例日志。', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '服务实例日志的时间戳。', + 'type' => 'string', + 'example' => '2021-05-21T00:00:00Z', + ], + 'Source' => [ + 'description' => '服务实例日志的来源。可能的值:'."\n" + ."\n" + .'computeNest:服务实例部署、升级的日志。'."\n" + ."\n" + .'application:应用产生的日志。'."\n" + ."\n" + .'actionTrail: 操作审计日志'."\n" + ."\n" + .'ros: ROS日志'."\n" + ."\n" + .'compliancePack: 合规包日志', + 'type' => 'string', + 'example' => 'ros', + ], + 'Content' => [ + 'description' => '日志内容。', + 'type' => 'string', + 'example' => 'Start creating service instance', + ], + 'LogType' => [ + 'description' => '日志类型。可能的值:'."\n" + .'- serviceInstance:服务实例产生的日志。'."\n" + ."\n" + .'- resource:ROS资源产生的日志。', + 'type' => 'string', + 'example' => 'serviceInstance', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ROS.Stack', + ], + 'ResourceId' => [ + 'description' => '关联ID。', + 'type' => 'string', + 'example' => 'si-5c6525c0589545c3****', + ], + 'Status' => [ + 'description' => '日志状态。可能的值:'."\n" + ."\n" + .'- Creating:创建中。'."\n" + ."\n" + .'- Created:已创建。'."\n" + ."\n" + .'- Deploying:部署中。'."\n" + ."\n" + .'- Deployed:已部署。'."\n" + ."\n" + .'- DeployedFailed:部署失败。'."\n" + ."\n" + .'- Expired:已过期。'."\n" + ."\n" + .'- ExtendSuccess:续费成功。'."\n" + ."\n" + .'- Upgrading:升级中。'."\n" + ."\n" + .'- UpgradeSuccess:升级成功。', + 'type' => 'string', + 'example' => 'Creating', + ], + 'CompliancePackType' => [ + 'description' => '合规包风险类型。如VPC内数据安全检查,VpcDataRisk', + 'type' => 'string', + 'example' => 'VpcDataRisk'."\n" + ."\n", + ], + 'ComplianceRuleName' => [ + 'description' => '合规包具体风险规则名。如ECS实例迁移出VPC-ecs-move-out-vpc', + 'type' => 'string', + 'example' => 'ecs-move-out-vpc', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"MaxResults\\": 20,\\n \\"ServiceInstancesLogs\\": [\\n {\\n \\"Timestamp\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Source\\": \\"ros\\",\\n \\"Content\\": \\"Start creating service instance\\",\\n \\"LogType\\": \\"serviceInstance\\",\\n \\"ResourceType\\": \\"ROS.Stack\\",\\n \\"ResourceId\\": \\"si-5c6525c0589545c3****\\",\\n \\"Status\\": \\"Creating\\",\\n \\"CompliancePackType\\": \\"VpcDataRisk\\\\n\\\\n\\",\\n \\"ComplianceRuleName\\": \\"ecs-move-out-vpc\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListServiceInstanceLogsResponse>\\n <NextToken>AAAAAfu+XtuBE55iRLHEYYuojI4=</NextToken>\\n <RequestId>51945B04-6AA6-410D-93BA-236E0248B104</RequestId>\\n <MaxResults>20</MaxResults>\\n <ServiceInstancesLogs>\\n <Timestamp>2021-05-21T00:00:00Z</Timestamp>\\n <ServiceInstanceId>si-ed37319d5b754f74****</ServiceInstanceId>\\n <Source>ros</Source>\\n <Content>Start creating service instance</Content>\\n </ServiceInstancesLogs>\\n</ListServiceInstanceLogsResponse>","errorExample":""}]', + 'title' => '查询服务实例的部署和升级日志', + ], + 'ListServiceInstanceResources' => [ + 'summary' => '通过服务实例 ID、资源 ARN(Aliyun Resource Name)、地域 ID等参数,查询满足条件服务实例资源列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '89603', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest2G0818', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。每页最大行数100行,默认行数20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-d8a0cc2a1ee04dce****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '资源的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例资源类型。可能的值:'."\n" + ."\n" + .'- AliyunResource:阿里云资源。'."\n" + ."\n" + .'- ContainerResource:容器组(Pod)资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunResource', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤条件。有效值:'."\n" + ."\n" + .'- ExpireTimeStart:预付费资源到期时间的查询开始时间'."\n" + .'><notice>只支持私有化部署服务实例查询。></notice>'."\n" + .'- ExpireTimeEnd:预付费资源到期时间的查询结束时间'."\n" + .'><notice>只支持私有化部署服务实例查询。></notice>'."\n" + ."\n" + .'- PayType:付费类型。><notice>只支持私有化部署服务实例查询。></notice>'."\n" + .'有效值:'."\n" + .' - Subscription:预付费。'."\n" + .' - PayAsYouGo:后付费。'."\n" + ."\n\n" + .'- ResourceARN:资源ARN(Aliyun'."\n" + ."\n" + .' Resource Name)。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n" + ."\n" + .'- ExpireTimeStart'."\n" + .'- ExpireTimeEnd'."\n" + .'- PayType '."\n" + .'- ResourceARN', + 'type' => 'string', + 'required' => false, + 'example' => 'ExpireTimeStart', + ], + 'Values' => [ + 'description' => '过滤条件值。', + 'type' => 'array', + 'items' => [ + 'description' => '查询过滤器中的待匹配的值。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-01T12:00:00'."\n" + .'Z', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B288A0BE-D927-4888-B0F7-B35EF84B6E6F', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。每页最大行数100行,默认行数20行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Resources' => [ + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceARN' => [ + 'description' => '资源ARN(Aliyun Resource Name)。', + 'type' => 'string', + 'example' => 'arn:acs:sag:cn-hangzhou:130920852836****:ccn/ccn-b3qf0q439sq2de****', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围:'."\n" + ."\n" + .'- Subscription:预付费。'."\n" + .'- PayAsYouGo:后付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'RenewStatus' => [ + 'description' => '续费状态,取值:'."\n" + .'- AutoRenewal:自动续费。'."\n" + .'- ManualRenewal:手动续费。'."\n" + .'- NotRenewal:不续费。', + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-01-01T12:00:00', + ], + 'ExpireTime' => [ + 'description' => '到期时间。', + 'type' => 'string', + 'example' => '2022-03-01T12:00:00', + ], + 'RenewalPeriod' => [ + 'description' => '续费周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RenewalPeriodUnit' => [ + 'description' => '续费周期单位。取值范围:'."\n" + ."\n" + .'- Month:月。'."\n" + .'- Year:年。', + 'type' => 'string', + 'example' => 'Month', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'RDS', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'Status' => [ + 'description' => '运行状态。可能的值:'."\n" + ."\n" + .'- running:运行中。'."\n" + ."\n" + .'- waiting:待运行。'."\n" + ."\n" + .'- terminated:停止运行。'."\n" + .'> 仅查询容器资源时,才会返回运行状态。', + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=\\",\\n \\"RequestId\\": \\"B288A0BE-D927-4888-B0F7-B35EF84B6E6F\\",\\n \\"MaxResults\\": 20,\\n \\"Resources\\": [\\n {\\n \\"ResourceARN\\": \\"arn:acs:sag:cn-hangzhou:130920852836****:ccn/ccn-b3qf0q439sq2de****\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"RenewStatus\\": \\"AutoRenewal\\",\\n \\"CreateTime\\": \\"2022-01-01T12:00:00\\",\\n \\"ExpireTime\\": \\"2022-03-01T12:00:00\\",\\n \\"RenewalPeriod\\": 1,\\n \\"RenewalPeriodUnit\\": \\"Month\\",\\n \\"ProductType\\": \\"RDS\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"Status\\": \\"running\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListServiceInstanceResourcesResponse>\\n <NextToken>AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=</NextToken>\\n <RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId>\\n <MaxResults>20</MaxResults>\\n <Resources>\\n <ResourceARN>arn:acs:sag:cn-hangzhou:130920852836****:ccn/ccn-b3qf0q439sq2de****</ResourceARN>\\n </Resources>\\n</ListServiceInstanceResourcesResponse>","errorExample":""}]', + 'title' => '查询服务实例包含的资源', + ], + 'ListServiceInstances' => [ + 'summary' => '通过地域 ID,资源ID等参数,查询当前账号在某地域下所有服务实例列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36941', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证(Token),取值为上一次API调用返回的**NextToken**参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤器。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '过滤器值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器值列表。N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'Name' => [ + 'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n" + ."\n" + .'- Name:按服务名称查询。'."\n" + .'若您需要模糊搜索,则在value处输入内容格式为:\\*xxx\\*。例如服务名称为我的服务,在模糊搜索时,可输入\\*我的\\*或者\\*服务\\*进行搜索。'."\n" + ."\n" + .'- ServiceInstanceName:按服务实例名称查询,当输入一个服务实例名称时进行模糊查询;当输入多个服务实例名称时进行精确查询。'."\n" + ."\n" + .'- ServiceInstanceId:服务实例ID。'."\n" + ."\n" + .'- ServiceId:服务ID。'."\n" + ."\n" + .'- Version:服务版本。'."\n" + ."\n" + .'- Status:服务实例状态。'."\n" + ."\n" + .'- DeployType:部署类型。'."\n" + ."\n" + .'- ServiceType:服务类型。'."\n" + ."\n" + .'- OperationStartTimeBefore:代运维服务开始前。'."\n" + ."\n" + .'- OperationStartTimeAfter:代运维服务开始后。'."\n" + ."\n" + .'- OperationEndTimeBefore:代运维服务结束前。'."\n" + ."\n" + .'- OperationEndTimeAfter:代运维服务结束后。'."\n" + ."\n" + .'- OperatedServiceInstanceId:私有部署服务下代运维服务实例ID。'."\n" + ."\n" + .'- OperationServiceInstanceId:纯代运维服务下的服务实例ID。'."\n" + ."\n" + .'- EnableInstanceOps:服务实例是否开通代运维服务的功能。', + 'type' => 'string', + 'required' => false, + 'example' => 'ServiceInstanceId', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-bp67acfmxazb4p****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E50287CB-AABF-4877-92C0-289B339A1546', + ], + 'TotalCount' => [ + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MaxResults' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ServiceInstances' => [ + 'description' => '服务实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务实例信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '服务实例名称。', + 'type' => 'string', + 'example' => 'TestName', + ], + 'Status' => [ + 'description' => '服务实例状态。可能值:'."\n" + ."\n" + .'- Created:已创建。'."\n" + ."\n" + .'- Deploying:部署中。'."\n" + ."\n" + .'- DeployedFailed:部署失败。'."\n" + ."\n" + .'- Deployed:已部署。'."\n" + ."\n" + .'- Upgrading:升级中。'."\n" + ."\n" + .'- Deleting:删除中。'."\n" + ."\n" + .'- Deleted:已删除。'."\n" + ."\n" + .'- DeletedFailed:删除失败。', + 'type' => 'string', + 'example' => 'Deployed', + ], + 'Outputs' => [ + 'description' => '服务实例输出信息。', + 'type' => 'string', + 'example' => '{"managementUrl": "http://xx.xx"}', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2021-05-20T00:00:00Z', + ], + 'Parameters' => [ + 'description' => '服务实例参数信息。', + 'type' => 'string', + 'example' => '{"param":"value"}', + ], + 'ServiceInstanceId' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2021-05-20T00:00:00Z', + ], + 'StatusDetail' => [ + 'description' => '服务实例的部署信息描述。', + 'type' => 'string', + 'example' => 'deploy successfully', + ], + 'Progress' => [ + 'description' => '服务实例的部署进度,单位:%。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'Resources' => [ + 'description' => '资源列表。', + 'type' => 'string', + 'example' => '[{"StackId": "stack-xxx"}]', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'OperatedServiceInstanceId' => [ + 'description' => '被代运维的服务实例ID。', + 'type' => 'string', + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + 'Service' => [ + 'description' => '服务。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '服务状态。', + 'type' => 'string', + 'example' => 'Online', + ], + 'PublishTime' => [ + 'description' => '发布时间。', + 'type' => 'string', + 'example' => '2021-05-21T00:00:00Z', + ], + 'Version' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'example' => '1.0', + ], + 'DeployType' => [ + 'description' => '部署类型。可能值:'."\n" + ."\n" + .'- ros:通过ROS部署。'."\n" + ."\n" + .'- terraform:通过Terraform部署。'."\n" + ."\n" + .'- ack:通过ACK部署。'."\n" + ."\n" + .'- spi:调用SPI部署。'."\n" + ."\n" + .'- operation:代运维服务部署。', + 'type' => 'string', + 'example' => 'ros', + ], + 'ServiceId' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'example' => 'service-0e6fca6a51a54420****', + ], + 'SupplierUrl' => [ + 'description' => '服务商地址。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'ServiceType' => [ + 'description' => '服务类型。可能值:'."\n" + ."\n" + .'- private:部署在用户账户下。'."\n" + ."\n" + .'- managed:托管在服务商账户下。'."\n" + ."\n" + .'- operation:代运维服务。', + 'type' => 'string', + 'example' => 'private', + ], + 'SupplierName' => [ + 'description' => '服务商名称。', + 'type' => 'string', + 'example' => 'A有限公司', + ], + 'ServiceInfos' => [ + 'description' => '服务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务信息。', + 'type' => 'object', + 'properties' => [ + 'Locale' => [ + 'description' => '服务实例语言。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'Image' => [ + 'description' => '服务图标地址。', + 'type' => 'string', + 'example' => 'https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png', + ], + 'Name' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'B数据库', + ], + 'ShortDescription' => [ + 'description' => '服务概述。', + 'type' => 'string', + 'example' => 'B是A公司自主设计并研发的开源分布式的关系型数据库', + ], + ], + ], + ], + 'VersionName' => [ + 'description' => '服务商自定义版本名称。', + 'type' => 'string', + 'example' => '版本A', + ], + 'Commodity' => [ + 'description' => '商品规格。', + 'type' => 'object', + 'properties' => [ + 'SaasBoostMetadata' => [ + 'description' => 'SaasBoost配置元数据。', + 'type' => 'string', + 'example' => '{'."\n" + .' //开启/关闭SaaS Boost绑定'."\n" + .' "Enabled":true/false,默认为false'."\n" + .' //公网交互地址'."\n" + .' "PublicAccessUrl":"https://example.com"'."\n" + .'}', + ], + 'Type' => [ + 'description' => '类型。可能的值:'."\n" + ."\n" + .'- Marketplace:云市场。'."\n" + ."\n" + .'- Css:凌霄。'."\n" + ."\n" + .'- SaasBoost:Saas Boost。', + 'type' => 'string', + 'example' => 'Marketplace', + ], + ], + ], + ], + ], + 'OperationStartTime' => [ + 'description' => '代运维开始时间。', + 'type' => 'string', + 'example' => '2021-12-29T06:48:56Z', + ], + 'OperationEndTime' => [ + 'description' => '代运维结束时间。', + 'type' => 'string', + 'example' => '2022-01-28T06:48:56Z', + ], + 'EnableInstanceOps' => [ + 'description' => '服务实例是否有代运维功能。可能的值:'."\n" + ."\n" + .'- true:服务实例有代运维功能。'."\n" + ."\n" + .'- false:服务实例没有代运维功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tags' => [ + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'Source' => [ + 'description' => '服务实例创建来源。', + 'type' => 'string', + 'example' => 'Supplier', + ], + 'EndTime' => [ + 'description' => '服务实例过期时间。', + 'type' => 'string', + 'example' => '2022-01-01T12:00:00', + ], + 'ServiceType' => [ + 'description' => '服务类型。可能的值:'."\n" + ."\n" + .'- private:部署在用户账户下。'."\n" + ."\n" + .'- managed:托管在服务商账户下。'."\n" + ."\n" + .'- operation:代运维服务。'."\n" + ."\n" + .'- poc:试用服务实例。', + 'type' => 'string', + 'example' => 'private', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围:'."\n" + ."\n" + .'- Permanent:永久购买。'."\n" + ."\n" + .'- Subscription:云市场包年包月。'."\n" + ."\n" + .'- PayAsYouGo:云市场按量付费。'."\n" + ."\n" + .'- CustomFixTime:商家自定义固定时长。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'MarketInstanceId' => [ + 'description' => '云市场实例ID。', + 'type' => 'string', + 'example' => '5827****', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekz6scpcxxxxxx', + ], + 'BizStatus' => [ + 'description' => '服务实例的业务状态。可能的值:'."\n" + ."\n" + .'- Normal:正常。'."\n" + ."\n" + .'- Renewing:续费中。'."\n" + ."\n" + .'- RenewFoiled:续费失败。'."\n" + ."\n" + .'- Expired:已过期。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2306175xxxxxxxx', + ], + 'SupportTrialToPrivate' => [ + 'description' => '是否支持试用转正式', + 'type' => 'boolean', + ], + 'PolicyNames' => [ + 'type' => 'string', + ], + 'GrantedPermission' => [ + 'type' => 'object', + 'properties' => [ + 'OperationEndTime' => [ + 'type' => 'string', + ], + 'PolicyNames' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"E50287CB-AABF-4877-92C0-289B339A1546\\",\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 20,\\n \\"ServiceInstances\\": [\\n {\\n \\"Name\\": \\"TestName\\",\\n \\"Status\\": \\"Deployed\\",\\n \\"Outputs\\": \\"{\\\\\\"managementUrl\\\\\\": \\\\\\"http://xx.xx\\\\\\"}\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"Parameters\\": \\"{\\\\\\"param\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"StatusDetail\\": \\"deploy successfully\\",\\n \\"Progress\\": 90,\\n \\"Resources\\": \\"[{\\\\\\"StackId\\\\\\": \\\\\\"stack-xxx\\\\\\"}]\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"OperatedServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"Service\\": {\\n \\"Status\\": \\"Online\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Version\\": \\"1.0\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-0e6fca6a51a54420****\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"SupplierName\\": \\"A有限公司\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png\\",\\n \\"Name\\": \\"B数据库\\",\\n \\"ShortDescription\\": \\"B是A公司自主设计并研发的开源分布式的关系型数据库\\"\\n }\\n ],\\n \\"VersionName\\": \\"版本A\\",\\n \\"Commodity\\": {\\n \\"SaasBoostMetadata\\": \\"{\\\\n //开启/关闭SaaS Boost绑定\\\\n \\\\\\"Enabled\\\\\\":true/false,默认为false\\\\n //公网交互地址\\\\n \\\\\\"PublicAccessUrl\\\\\\":\\\\\\"https://example.com\\\\\\"\\\\n}\\",\\n \\"Type\\": \\"Marketplace\\"\\n }\\n },\\n \\"OperationStartTime\\": \\"2021-12-29T06:48:56Z\\",\\n \\"OperationEndTime\\": \\"2022-01-28T06:48:56Z\\",\\n \\"EnableInstanceOps\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Source\\": \\"Supplier\\",\\n \\"EndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"MarketInstanceId\\": \\"5827****\\",\\n \\"ResourceGroupId\\": \\"rg-aekz6scpcxxxxxx\\",\\n \\"BizStatus\\": \\"Normal\\",\\n \\"OrderId\\": \\"2306175xxxxxxxx\\",\\n \\"SupportTrialToPrivate\\": true,\\n \\"PolicyNames\\": \\"\\",\\n \\"GrantedPermission\\": {\\n \\"OperationEndTime\\": \\"\\",\\n \\"PolicyNames\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListServiceInstancesResponse>\\n <NextToken>AAAAAfu+XtuBE55iRLHEYYuojI4=</NextToken>\\n <RequestId>E50287CB-AABF-4877-92C0-289B339A1546</RequestId>\\n <TotalCount>100</TotalCount>\\n <MaxResults>20</MaxResults>\\n <ServiceInstances>\\n <Status>Deployed</Status>\\n <Outputs>{\\"managementUrl\\": \\"http://xx.xx\\"}</Outputs>\\n <UpdateTime>2021-05-20T00:00:00Z</UpdateTime>\\n <Parameters>{\\"param\\":\\"value\\"}</Parameters>\\n <ServiceInstanceId>si-d6ab3a63ccbb4b17****</ServiceInstanceId>\\n <CreateTime>2021-05-20T00:00:00Z</CreateTime>\\n <StatusDetail>deploy successfully</StatusDetail>\\n <Progress>90</Progress>\\n <Resources>[{\\"StackId\\": \\"stack-xxx\\"}]</Resources>\\n <TemplateName>模板1</TemplateName>\\n <OperatedServiceInstanceId>si-d6ab3a63ccbb4b17****</OperatedServiceInstanceId>\\n <Service>\\n <Status>Online</Status>\\n <PublishTime>2021-05-21T00:00:00Z</PublishTime>\\n <Version>1.0</Version>\\n <DeployType>ros</DeployType>\\n <ServiceId>service-0e6fca6a51a54420****</ServiceId>\\n <SupplierUrl>http://example.com</SupplierUrl>\\n <ServiceType>private</ServiceType>\\n <SupplierName>A有限公司</SupplierName>\\n <ServiceInfos>\\n <Locale>zh-CN</Locale>\\n <Image>https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png</Image>\\n <Name>B数据库</Name>\\n <ShortDescription>B是A公司自主设计并研发的开源分布式的关系型数据库</ShortDescription>\\n </ServiceInfos>\\n </Service>\\n <OperationStartTime>2021-12-29T06:48:56Z</OperationStartTime>\\n <OperationEndTime>2022-01-28T06:48:56Z</OperationEndTime>\\n <EnableInstanceOps>true</EnableInstanceOps>\\n </ServiceInstances>\\n</ListServiceInstancesResponse>","errorExample":""}]', + 'title' => '查询服务实例列表', + ], + 'StartServiceInstance' => [ + 'summary' => '当服务实例状态为Stopped(已关机)、StartFailed(开机失败)时,调用StartServiceInstance接口启动服务实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213207', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例所在地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。'."\n" + ."\n" + .'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\"\\n}","type":"json"}]', + 'title' => '启动服务实例', + 'description' => '### 前提条件'."\n" + .'请先确保服务商在创建服务时配置了开机、关机的运维操作。', + ], + 'StopServiceInstance' => [ + 'summary' => '当服务实例状态为Deployed(已部署)、StopFailed(关机失败)时,调用StopServiceInstance接口关闭服务实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213173', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例所在地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。'."\n" + ."\n" + .'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-b58c874912fc4294****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]', + 'title' => '关闭服务实例', + 'description' => '### 前提条件'."\n" + .'请先确保服务商在创建服务时配置了开机、关机的运维操作。', + ], + 'RestartServiceInstance' => [ + 'summary' => '当服务实例状态为Deployed(已部署)时,调用RestartServiceInstance接口重启服务实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213219', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例所在地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。'."\n" + ."\n" + .'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\"\\n}","type":"json"}]', + 'title' => '重启服务实例', + 'description' => '### 前提条件'."\n" + .'请先确保服务商在创建服务时配置了重启的运维操作。', + ], + 'UpdateServiceInstanceSpec' => [ + 'summary' => '当服务实例的参数值或套餐设置不满足您的要求时,调用UpdateServiceInstanceSpec对服务实例执行变配操作。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '161941', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。'."\n" + ."\n" + .'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + ], + [ + 'name' => 'PredefinedParametersName', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例套餐名称。'."\n" + ."\n" + .'当服务商在添加变配操作时设置**变更类型**为**套餐变更**,您可以设置该参数。'."\n" + ."\n" + .'您可以通过查看[GetService - 查询服务详细信息](~~2340828~~)接口中返回参数**DeployMetadata**的**PredefinedParameters**属性获取服务设置的套餐名称。', + 'type' => 'string', + 'required' => false, + 'example' => '套餐一', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '服务实例变更参数。'."\n" + ."\n" + .'当服务商在添加变配操作时设置**变更类型**为**参数变更**,您可以设置该参数。'."\n" + ."\n" + .'> - 您可以通过查看[GetService - 查询服务详细信息](~~2340828~~)接口中返回参数**OperationMetadata**的**ModifyParametersConfig**属性获取服务设置的变更参数。'."\n" + .'> - 您还可以通过[计算巢控制台](https://computenest.console.aliyun.com/service/instance/cn-hangzhou)的**服务实例变更**页面查看服务设置的变更参数。'."\n" + ."\n" + .'例如,如果服务设置了ECS实例规格升配,此时您需要输入比原来服务实例更高的实例规格配置。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "InstanceType": "ecs.g8ise.2xlarge"'."\n" + .'}', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对此次创建请求执行预检,包括权限、实例状态校验等操作。'."\n" + ."\n" + .'取值:'."\n" + ."\n" + .'- true:发送请求,不创建服务实例。'."\n" + ."\n" + .'- false:发送请求,检查通过后创建服务实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableUserPrometheus', + 'in' => 'query', + 'schema' => [ + 'description' => '用户侧是否启用Prometheus监控。'."\n" + ."\n" + .'取值:'."\n" + ."\n" + .'true:启用。'."\n" + ."\n" + .'false:不启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OperationName', + 'in' => 'query', + 'schema' => [ + 'description' => '变配操作名称。'."\n" + ."\n" + .'您可以通过查看[GetService - 查询服务详细信息](~~2340828~~)接口中返回参数**OperationMetadata**的**ModifyParametersConfig**属性获取服务设置的变配操作名称和变配操作内容。', + 'type' => 'string', + 'required' => false, + 'example' => '套餐变配', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Commodity', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '云市场购买订单信息,服务未上云市场或按量计费不必传。', + 'type' => 'object', + 'properties' => [ + 'AutoPay' => [ + 'description' => '是否自动支付。'."\n" + ."\n" + .'取值:'."\n" + ."\n" + .'- **true**(默认值):自动支付。您需要确保账户余额充足。'."\n" + ."\n" + .'- **false**:只生成订单不扣费。如果您的支付方式余额不足,可以将参数AutoPay设置为false,此时会生成未支付订单,您可以登录[RDS管理控制台](https://rdsnext.console.aliyun.com/dashboard/cn-beijing)自行支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '23396265896****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"OrderId\\": \\"23396265896****\\"\\n}","type":"json"}]', + 'title' => '变配服务实例', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + 'ListServiceInstanceUpgradeHistory' => [ + 'summary' => '调用ListServiceInstanceUpgradeHistory查询服务实例升级信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest7EAOIM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌(Token)。取值:如果NextToken为空表示没有下一次查询。 如果NextToken有返回值,该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-70a3b15bb62643xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI41', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EE3EDF4E-B3B1-19B6-BD01-30D4D00F6E5D', + ], + 'MaxResults' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'UpgradeHistory' => [ + 'description' => '升级历史列表。', + 'type' => 'array', + 'items' => [ + 'description' => '升级历史列表。', + 'type' => 'object', + 'properties' => [ + 'UpgradeHistoryId' => [ + 'description' => '升级历史记录ID。', + 'type' => 'string', + 'example' => 'exec-123', + ], + 'Type' => [ + 'description' => '升级类型。可选值:'."\n" + ."\n" + .'- Upgrade: 升级'."\n" + .'- Rollback: 回滚', + 'type' => 'string', + 'example' => 'Upgrade', + ], + 'FromVersion' => [ + 'description' => '升级前的版本。', + 'type' => 'string', + 'example' => '1', + ], + 'ToVersion' => [ + 'description' => '升级后的版本。', + 'type' => 'string', + 'example' => '3', + ], + 'Status' => [ + 'description' => '升级状态。可选值:'."\n" + ."\n" + .'- upgrading:升级中。'."\n" + ."\n" + .'- UpgradeSuccessful:升级成功。'."\n" + ."\n" + .'- UpgradeFailed:升级失败。', + 'type' => 'string', + 'example' => 'UpgradeFailed', + ], + 'Results' => [ + 'description' => '升级结果。', + 'type' => 'string', + 'example' => '{\\"PreUpgradeExecutionId\\":\\"exec-123\\"}', + ], + 'StartTime' => [ + 'description' => '升级开始时间。', + 'type' => 'string', + 'example' => '2022-04-26T08:09:51Z', + ], + 'EndTime' => [ + 'description' => '升级结束时间。', + 'type' => 'string', + 'example' => '2022-04-26T09:09:51Z', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI41\\",\\n \\"RequestId\\": \\"EE3EDF4E-B3B1-19B6-BD01-30D4D00F6E5D\\",\\n \\"MaxResults\\": 20,\\n \\"UpgradeHistory\\": [\\n {\\n \\"UpgradeHistoryId\\": \\"exec-123\\",\\n \\"Type\\": \\"Upgrade\\",\\n \\"FromVersion\\": \\"1\\",\\n \\"ToVersion\\": \\"3\\",\\n \\"Status\\": \\"UpgradeFailed\\",\\n \\"Results\\": \\"{\\\\\\\\\\\\\\"PreUpgradeExecutionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec-123\\\\\\\\\\\\\\"}\\",\\n \\"StartTime\\": \\"2022-04-26T08:09:51Z\\",\\n \\"EndTime\\": \\"2022-04-26T09:09:51Z\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', + 'title' => '查询服务实例升级历史', + ], + 'RollbackServiceInstance' => [ + 'summary' => '回滚已升级的服务实例版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144097', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-d6ab3a63ccbb4bxxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]', + 'title' => '回滚服务实例版本', + ], + 'UpdateServiceInstanceAttributes' => [ + 'summary' => '更新服务实例属性', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226389', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。'."\n" + ."\n" + .'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-d6ab3a63ccbb4b17xxxx', + ], + ], + [ + 'name' => 'EnableOperation', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启代运维', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GrantedPermission', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OperationEndTime' => [ + 'type' => 'string', + 'required' => false, + ], + 'PolicyNames' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\"\\n}","type":"json"}]', + 'title' => '更新服务实例属性', + ], + 'ValidateServiceInstanceName' => [ + 'summary' => '校验服务实例名称', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '204410', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest2G0818', + 'FEATUREcomputenest1Z49ZW', + 'FEATUREcomputenest21Y74A', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务ID。', + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'service-12xxxxxx', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '服务版本。', + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ServiceInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '服务示例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'testName', + ], + ], + [ + 'name' => 'IsTrial', + 'in' => 'query', + 'schema' => [ + 'title' => '是否试用', + 'description' => '是否试用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称,服务支持多模板时需要指定模板名称。', + 'description' => '模板名称,服务支持多模板时需要指定模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板一', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D****\\"\\n}","type":"json"}]', + 'title' => '校验服务实例名称', + ], + 'ListTagKeys' => [ + 'summary' => '查询已有标签键信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117094', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。可能的值:'."\n" + ."\n" + .'- service:服务。'."\n" + ."\n" + .'- serviceinstance:服务实例。'."\n" + .'- artifact:部署物。'."\n" + .'- dataset:数据集。', + 'type' => 'string', + 'required' => true, + 'example' => 'service', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'AAAAAZ9FmxgN6wKfeK/GOKRnnjU=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8872ACE6-0297-54A4-8AAD-3A8623EC6C5D', + ], + 'Keys' => [ + 'description' => '标签键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键列表。', + 'type' => 'string', + 'example' => ' ['."\n" + .' 0 : "lzqtest-huhehaote"'."\n" + .' 1 : "lzqros"'."\n" + .' 2 : "aaa"'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAZ9FmxgN6wKfeK/GOKRnnjU=\\",\\n \\"RequestId\\": \\"8872ACE6-0297-54A4-8AAD-3A8623EC6C5D\\",\\n \\"Keys\\": [\\n \\" [\\\\n 0 : \\\\\\"lzqtest-huhehaote\\\\\\"\\\\n 1 : \\\\\\"lzqros\\\\\\"\\\\n 2 : \\\\\\"aaa\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询已有标签键信息', + ], + 'UnTagResources' => [ + 'summary' => '调用UntagResources为指定的资源列表统一解绑标签', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117186', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。可能的值:'."\n" + ."\n" + .'- service:服务。'."\n" + ."\n" + .'- serviceinstance:服务实例。'."\n" + .'- artifact:部署物。'."\n" + ."\n" + .'- dataset:数据集。', + 'type' => 'string', + 'required' => true, + 'example' => 'service', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。最多支持50个资源ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-xxx', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除资源上全部的标签。当请求中未设置TagKey时,该参数才有效。默认值:false。可选值:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源的标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'Key1', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\"\\n}","type":"json"}]', + 'title' => '删除标签', + ], + 'TagResources' => [ + 'summary' => '调用TagResources为资源列表统一创建并绑定标签', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117177', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Key1', + ], + 'Value' => [ + 'description' => '资源的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。可能的值:'."\n" + ."\n" + .'- service:服务。'."\n" + ."\n" + .'- serviceinstance:服务实例。'."\n" + .'- artifact:部署物。'."\n" + .'- dataset:数据集。', + 'type' => 'string', + 'required' => true, + 'example' => 'service', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。最多支持50个资源ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-xxx', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\"\\n}","type":"json"}]', + 'title' => '创建并绑定标签', + ], + 'ListTagValues' => [ + 'summary' => '查询标签键对应的标签值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117166', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAfmTH5rcd4YFfob4P0uDAAc=', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。可能的值:'."\n" + ."\n" + .'- service:服务。'."\n" + ."\n" + .'- serviceinstance:服务实例。'."\n" + .'- artifact:部署物。'."\n" + .'- dataset:数据集。', + 'type' => 'string', + 'required' => true, + 'example' => 'service', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始的Token。', + 'type' => 'string', + 'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0631D623-D917-1C2D-ACD6-5B3B19XXXXXX', + ], + 'Values' => [ + 'description' => '标签值信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => ' ['."\n" + .' 0 : "20211220"'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAVz7BQqj2xtiNSC3d3RAD38=\\",\\n \\"RequestId\\": \\"0631D623-D917-1C2D-ACD6-5B3B19XXXXXX\\",\\n \\"Values\\": [\\n \\" [\\\\n 0 : \\\\\\"20211220\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询标签键对应的标签值', + ], + 'ChangeResourceGroup' => [ + 'summary' => '通过云资源的资源 ID修改云资源所属的资源组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171476', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改资源组的云资源的资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-5dc794a7fd254e******', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要移动到的资源组ID。'."\n" + ."\n" + .'您可以通过[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups)查看资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzmhzo******', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。可能的值:'."\n" + ."\n" + .'- service:服务。'."\n" + ."\n" + .'- serviceinstance:服务实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'service', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\"\\n}","type":"json"}]', + 'title' => '更改资源组', + ], + 'UpdateUserInformation' => [ + 'summary' => '调用UpdateUserInformation更新用户信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136314', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DeliverySettings', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '修改的配置信息。', + 'type' => 'object', + 'properties' => [ + 'OssEnabled' => [ + 'description' => '用户是否开启oss投递。可选值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false:不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'OssBucketName' => [ + 'description' => '对象存储Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => '"mybucket"', + ], + 'OssPath' => [ + 'description' => 'OSS路径。', + 'type' => 'string', + 'required' => false, + 'example' => '"path1/path2/"', + ], + 'OssExpirationDays' => [ + 'description' => '录屏保存天数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7', + ], + 'ActiontrailDeliveryToOssEnabled' => [ + 'description' => '是否使用投递功能。可选值:'."\n" + .' - true:使用。'."\n" + .' - false:不使用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '51945B04-6AA6-410D-93BA-236E0248B104', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\"\\n}","type":"json"}]', + 'title' => '更新用户信息', + ], + 'GetUserInformation' => [ + 'summary' => '调用GetUserInformation查询用户相关信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest0EG8HU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '52EBAF16-22F6-53DB-AE1E-44764FC62AF0', + ], + 'DeliverySettings' => [ + 'description' => '修改的配置信息。', + 'type' => 'object', + 'properties' => [ + 'OssEnabled' => [ + 'description' => '用户是否开启oss投递。可选值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false:不开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OssBucketName' => [ + 'description' => '对象存储Bucket名称。', + 'type' => 'string', + 'example' => '0101data', + ], + 'OssPath' => [ + 'description' => 'OSS路径。', + 'type' => 'string', + 'example' => '/test', + ], + 'OssExpirationDays' => [ + 'description' => '录屏保存天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'ActiontrailDeliveryToOssEnabled' => [ + 'description' => '是否使用投递功能。可选值:'."\n" + .' - true:使用。'."\n" + .' - false:不使用。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52EBAF16-22F6-53DB-AE1E-44764FC62AF0\\",\\n \\"DeliverySettings\\": {\\n \\"OssEnabled\\": true,\\n \\"OssBucketName\\": \\"0101data\\",\\n \\"OssPath\\": \\"/test\\",\\n \\"OssExpirationDays\\": 7,\\n \\"ActiontrailDeliveryToOssEnabled\\": true\\n }\\n}","type":"json"}]', + 'title' => '查询用户信息', + ], + 'ListServiceUsages' => [ + 'summary' => '查看用户自己当前的服务使用申请。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '137236', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU=', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤器。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n" + ."\n" + .'- ServiceId:服务ID。'."\n" + ."\n" + .'- ServiceName:服务名称。'."\n" + ."\n" + .'- Status:服务状态。'."\n" + ."\n" + .'- SupplierName:服务商名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ServiceId', + ], + 'Value' => [ + 'description' => '过滤器值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器值列表。N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '18AD0960-A9FE-1AC8-ADF8-22131Fxxxxxx', + ], + 'NextToken' => [ + 'title' => 'NextToken', + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'example' => 'AAAAAYChudnQUoBH+mGWFpb6oP0=', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ServiceUsages' => [ + 'description' => '服务使用情况。', + 'type' => 'array', + 'items' => [ + 'description' => '服务使用情况。', + 'type' => 'object', + 'properties' => [ + 'UserAliUid' => [ + 'description' => '用户阿里云Uid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '127383705958xxxx', + ], + 'ServiceId' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'example' => 'service-c9f36ec6d19b4exxxxxx', + ], + 'ServiceName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => '部署链接权限申请', + ], + 'SupplierName' => [ + 'description' => '服务商名称。', + 'type' => 'string', + 'example' => '验收测试', + ], + 'Status' => [ + 'description' => '服务状态。可能值:'."\n" + ."\n" + .'- Submitted:已提交(待审批)。'."\n" + ."\n" + .'- Approved:已通过。'."\n" + ."\n" + .'- Rejected:已拒绝。'."\n" + ."\n" + .'- Canceled:已取消。', + 'type' => 'string', + 'example' => 'Submitted', + ], + 'Comments' => [ + 'description' => '审批的备注信息。', + 'type' => 'string', + 'example' => '审核通过。', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-05-25T02:02:02Z', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-05-25T02:02:02Z', + ], + 'UserInformation' => [ + 'description' => '用户信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "ServiceId": "xxx",'."\n" + .' "EmailAddress": "邮箱",'."\n" + .' "Company": "公司",'."\n" + .' "Country": "国家",'."\n" + .' "Telephone": "申请人的电话号码",'."\n" + .' "Name": "申请人名字",'."\n" + .' "Title": "申请人的职位",'."\n" + .' "Industry": "行业"'."\n" + .'}', + 'description' => '用户信息。', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18AD0960-A9FE-1AC8-ADF8-22131Fxxxxxx\\",\\n \\"NextToken\\": \\"AAAAAYChudnQUoBH+mGWFpb6oP0=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 1,\\n \\"ServiceUsages\\": [\\n {\\n \\"UserAliUid\\": 0,\\n \\"ServiceId\\": \\"service-c9f36ec6d19b4exxxxxx\\",\\n \\"ServiceName\\": \\"部署链接权限申请\\",\\n \\"SupplierName\\": \\"验收测试\\",\\n \\"Status\\": \\"Submitted\\",\\n \\"Comments\\": \\"审核通过。\\",\\n \\"CreateTime\\": \\"2022-05-25T02:02:02Z\\",\\n \\"UpdateTime\\": \\"2022-05-25T02:02:02Z\\",\\n \\"UserInformation\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"ServiceId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"EmailAddress\\\\\\": \\\\\\"邮箱\\\\\\",\\\\n \\\\\\"Company\\\\\\": \\\\\\"公司\\\\\\",\\\\n \\\\\\"Country\\\\\\": \\\\\\"国家\\\\\\",\\\\n \\\\\\"Telephone\\\\\\": \\\\\\"申请人的电话号码\\\\\\",\\\\n \\\\\\"Name\\\\\\": \\\\\\"申请人名字\\\\\\",\\\\n \\\\\\"Title\\\\\\": \\\\\\"申请人的职位\\\\\\",\\\\n \\\\\\"Industry\\\\\\": \\\\\\"行业\\\\\\"\\\\n}\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看当前服务使用申请', + ], + 'CancelServiceUsage' => [ + 'summary' => '当前用户取消对某个服务的使用申请。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '137527', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestHUKJ18', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'service-d6fc5f949a9246xxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'NeedDelete', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要删除该申请。'."\n" + .'> 删除后需要重新填写申请内容。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]', + 'title' => '取消服务使用申请', + ], + 'CreateServiceUsage' => [ + 'summary' => '创建使用服务的申请。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestJ4D829', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'service-d6fc5f949a9246xxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'UserInformation', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '申请信息', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '申请信息', + 'example' => '{'."\n" + .' "ServiceId": "xxx",'."\n" + .' "EmailAddress": "邮箱",'."\n" + .' "Company": "公司",'."\n" + .' "Country": "国家",'."\n" + .' "Telephone": "申请人的电话号码",'."\n" + .' "Name": "申请人名字",'."\n" + .' "Title": "申请人的职位",'."\n" + .' "Industry": "行业"'."\n" + .'}', + ], + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]', + 'title' => '创建服务使用申请', + ], + 'UpdateServiceUsage' => [ + 'summary' => '用户更新使用服务申请。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '137525', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'service-39f4f251e94843xxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAYChudnQUoBH+mGWFpb6oP0=', + ], + ], + [ + 'name' => 'UserInformation', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户信息。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用户信息。', + 'example' => '{'."\n" + .' "ServiceId": "xxx",'."\n" + .' "EmailAddress": "邮箱",'."\n" + .' "Company": "公司",'."\n" + .' "Country": "国家",'."\n" + .' "Telephone": "申请人的电话号码",'."\n" + .' "Name": "申请人名字",'."\n" + .' "Title": "申请人的职位",'."\n" + .' "Industry": "行业"'."\n" + .'}', + ], + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]', + 'title' => '更新使用服务申请', + ], + 'DeployServiceInstance' => [ + 'summary' => '部署已创建的服务实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '36959', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'si-b58c874912fc4294****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。可能的值:'."\n" + ."\n" + .'- cn-hangzhou:华东1(杭州) 。'."\n" + ."\n" + .'- ap-southeast-1:新加坡。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D****\\"\\n}","type":"json"}]', + 'title' => '部署服务实例', + ], + 'DescribeRegions' => [ + 'summary' => '查询可用地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36938', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest2G0818', + 'FEATUREcomputenest1Z49ZW', + 'FEATUREcomputenest21Y74A', + 'FEATUREcomputenestHX5MKK', + 'FEATUREcomputenestB2MIVU', + 'FEATUREcomputenestDWH8PE', + 'FEATUREcomputenest8XBPFA', + 'FEATUREcomputenestC6045N', + 'FEATUREcomputenestA4RHS0', + 'FEATUREcomputenestQE1OA6', + 'FEATUREcomputenest2LCZ5B', + 'FEATUREcomputenestJ4D829', + 'FEATUREcomputenest0EG8HU', + 'FEATUREcomputenest3Q4PWW', + 'FEATUREcomputenestHUKJ18', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + 'Regions' => [ + 'description' => '可用地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息。', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => '地域对应的接入地址(Endpoint)。', + 'type' => 'string', + 'example' => 'computenest.cn-hangzhou.aliyuncs.com', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"computenest.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可用地域', + ], + 'ListPolicies' => [ + 'summary' => '用户查询权限列表接口。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '43373', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestJ4D829', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始token,nexttoken为空说明没有下一个', + 'type' => 'string', + 'required' => false, + 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '51945B04-6AA6-410D-93BA-236E0248B104', + ], + 'NextToken' => [ + 'title' => 'NextToken', + 'description' => 'NextToken', + 'type' => 'string', + 'example' => 'AAAAAZ9FmxgN6wKfeK/GOKRnnjU=', + ], + 'Policies' => [ + 'description' => '权限策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '权限策略信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '权限策略描述。', + 'type' => 'string', + 'example' => '只读权限', + ], + 'PolicyName' => [ + 'description' => '权限策略名称。', + 'type' => 'string', + 'example' => 'AliyunComputeNestPolicyForReadOnly', + ], + 'PolicyType' => [ + 'description' => '权限策略类型。'."\n" + ."\n" + .'- Custom:自定义策略。'."\n" + .'- System:系统策略。', + 'type' => 'string', + 'example' => 'System', + ], + 'PolicyDocument' => [ + 'description' => '策略内容。', + 'type' => 'string', + 'example' => '{"Action":["*:Describe*","*:List*","*:Get*","*:BatchGet*","*:Query*","*:BatchQuery*","actiontrail:LookupEvents"],"Resource":["*"],"Effect":"Allow"}', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"NextToken\\": \\"AAAAAZ9FmxgN6wKfeK/GOKRnnjU=\\",\\n \\"Policies\\": [\\n {\\n \\"Description\\": \\"只读权限\\",\\n \\"PolicyName\\": \\"AliyunComputeNestPolicyForReadOnly\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"PolicyDocument\\": \\"{\\\\\\"Action\\\\\\":[\\\\\\"*:Describe*\\\\\\",\\\\\\"*:List*\\\\\\",\\\\\\"*:Get*\\\\\\",\\\\\\"*:BatchGet*\\\\\\",\\\\\\"*:Query*\\\\\\",\\\\\\"*:BatchQuery*\\\\\\",\\\\\\"actiontrail:LookupEvents\\\\\\"],\\\\\\"Resource\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"Effect\\\\\\":\\\\\\"Allow\\\\\\"}\\"\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '查询权限列表', + ], + 'GetNetworkAvailableZones' => [ + 'summary' => '根据指定的地域获取可用区列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172337', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestHX5MKK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PrivateVpcConnectionMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '连接模式 (PrivateLink: PrivateLink, OverlayLink: 基于ANSM的overlayLink)', + 'description' => '连接模式 (PrivateLink: PrivateLink, OverlayLink: 基于ANSM的overlayLink)', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivateLink', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '服务部署可用区', + 'description' => '服务部署可用区', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'NetworkRegionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '虚拟互联网地域', + 'description' => '虚拟互联网地域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceEndpointServiceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '正/反向私网访问 (Forward: 正向访问, Reverse: 反向访问)', + 'description' => '正/反向私网访问 (Forward: 正向访问, Reverse: 反向访问)', + 'type' => 'string', + 'required' => false, + 'example' => 'Forward', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务所在地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IsPoc', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否试用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'service-55fc2eabbce647fa976b', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<NetworkAvailableRegionOrZoneModel>', + 'description' => 'PlainResult<NetworkAvailableRegionOrZoneModel>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'RegionIdList' => [ + 'description' => '地域ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'ZoneIdList' => [ + 'description' => '可用区ID。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'A17F9930-E2DC-5E87-B6D6-B0BCD2B00834', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RegionIdList\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"ZoneIdList\\": [\\n \\"cn-hangzhou-i\\"\\n ]\\n },\\n \\"RequestId\\": \\"A17F9930-E2DC-5E87-B6D6-B0BCD2B00834\\"\\n}","type":"json"}]', + 'title' => '地域可用区的列表', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + 'ListTagResources' => [ + 'summary' => '查询标签资源列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117188', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。可能的值:'."\n" + ."\n" + .'- service:服务。'."\n" + .'- serviceinstance:服务实例。'."\n" + .'- artifact:部署物', + 'type' => 'string', + 'required' => true, + 'example' => 'service', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID,n的取值范围为1~50', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-5dc794a7fd254e******', + ], + 'required' => false, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始的Token。', + 'type' => 'string', + 'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + 'TagResources' => [ + 'description' => '由资源及其标签组成的合集,包含了资源ID、资源类型和标签键值等信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。可能的值:'."\n" + ."\n" + .'- service:服务。'."\n" + ."\n" + .'- serviceinstance:服务实例。'."\n" + .'- artifact: 部署物'."\n" + .'- dataset: 数据集', + 'type' => 'string', + 'example' => 'serviceinstance', + ], + 'ResourceId' => [ + 'description' => '资源ID', + 'type' => 'string', + 'example' => 'si-44b9923be2d048eb8f5f', + ], + 'TagKey' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'test', + ], + 'TagValue' => [ + 'description' => '标签值', + 'type' => 'string', + 'example' => 'major', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAVz7BQqj2xtiNSC3d3RAD38=\\",\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"serviceinstance\\",\\n \\"ResourceId\\": \\"si-44b9923be2d048eb8f5f\\",\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"major\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询计算巢资源和标签的绑定关系', + ], + 'GetServiceInstanceSubscriptionEstimateCost' => [ + 'summary' => '私有化部署服务实例预付费资源询价。目前支持续费询价,支持对指定服务实例ID下的全部预付费资源统一进行续费询价,或者对指定资源进行续费询价,两种方式只能使用一种', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136636', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-d6ab3a63ccbb4b17****', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型。可选值:Renewal(续费)。', + 'type' => 'string', + 'required' => true, + 'example' => 'Renewal', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例全部预付费资源的续费时长的时间单位,即参数Period的单位。取值范围:Month、Year。默认值:Month。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例全部预付费资源的续费时长。单位由PeriodUnit指定。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourcePeriod', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源续费配置。', + 'type' => 'array', + 'items' => [ + 'description' => '资源续费配置。', + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'description' => '资源 ARN(Aliyun Resource Name)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ecs:cn-guangzhou:1361753504587228:instance/i-7xv9pgeqvhxg10jji3vd', + ], + 'PeriodUnit' => [ + 'description' => '资源续费时长的时间单位,即参数Period的单位。取值范围:Month、Year。默认值:Month。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'Period' => [ + 'description' => '续费时长。单位由PeriodUnit指定。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21', + ], + 'ResourcePrices' => [ + 'description' => '资源价格信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源价格信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'description' => '资源 ARN(Aliyun Resource Name)。', + 'type' => 'string', + 'example' => 'acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2', + ], + 'PeriodUnit' => [ + 'description' => '续费时长的时间单位,即参数Period的单位。取值范围:Month、Year。默认值:Month。', + 'type' => 'string', + 'example' => 'Month', + ], + 'Period' => [ + 'description' => '续费时长。单位由PeriodUnit指定。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OriginalAmount' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '900', + ], + 'TradeAmount' => [ + 'description' => '优惠价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '500', + ], + 'DiscountAmount' => [ + 'description' => '折扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'Currency' => [ + 'description' => '币种。取值范围:'."\n" + .'- CNY:人民币。'."\n" + .'- USD:美元。'."\n" + .'- JPY:日元。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'DetailInfos' => [ + 'description' => '计价模块价格详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '900', + ], + 'TradeAmount' => [ + 'description' => '优惠价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '500', + ], + 'DiscountAmount' => [ + 'description' => '折扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'Resource' => [ + 'description' => '计价模块标识。', + 'type' => 'string', + 'example' => 'instance', + ], + ], + ], + ], + 'Rules' => [ + 'description' => '优惠详情。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '优惠名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RuleDescId' => [ + 'description' => '优惠标识。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1021199213', + ], + 'Description' => [ + 'description' => '优惠描述。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\",\\n \\"ResourcePrices\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"Period\\": 1,\\n \\"OriginalAmount\\": 900,\\n \\"TradeAmount\\": 500,\\n \\"DiscountAmount\\": 100,\\n \\"Currency\\": \\"CNY\\",\\n \\"DetailInfos\\": [\\n {\\n \\"OriginalAmount\\": 900,\\n \\"TradeAmount\\": 500,\\n \\"DiscountAmount\\": 100,\\n \\"Resource\\": \\"instance\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"RuleDescId\\": 1021199213,\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '服务实例预付费资源询价', + ], + 'RenewServiceInstanceResources' => [ + 'summary' => '为私有化部署服务实例包含的预付费资源续费。支持对指定服务实例ID下的全部预付费资源统一进行续费,也可以对指定资源进行续费,两种续费方式只能使用一种', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136231', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-b58c874912fc4294****', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例全部预付费资源的续费时长的时间单位,即参数Period的单位。取值范围:Month、Year。默认值:Month。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例全部预付费资源的续费时长。单位由PeriodUnit指定。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourcePeriod', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源续费列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源续费配置。', + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'description' => '资源 ARN(Aliyun Resource Name)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2', + ], + 'PeriodUnit' => [ + 'description' => '资源续费时长的时间单位,即参数Period的单位。取值范围:Month、Year。默认值:Month。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'Period' => [ + 'description' => '资源续费时长。单位由PeriodUnit指定。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7', + ], + 'RenewalResult' => [ + 'description' => '续费结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '续费资源个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Succeeded' => [ + 'description' => '续费成功资源个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'Failed' => [ + 'description' => '续费失败资源个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'FailureDetails' => [ + 'description' => '续费失败详情。', + 'type' => 'array', + 'items' => [ + 'description' => '续费失败详情。', + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'description' => '资源 ARN(Aliyun Resource Name)。', + 'type' => 'string', + 'example' => 'acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '续费失败的原因信息。', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidPeriod', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"RenewalResult\\": {\\n \\"TotalCount\\": 10,\\n \\"Succeeded\\": 9,\\n \\"Failed\\": 1\\n },\\n \\"FailureDetails\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2\\",\\n \\"ErrorMessage\\": \\"续费失败的原因信息。\\",\\n \\"ErrorCode\\": \\"InvalidPeriod\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '续费服务实例预付费资源', + ], + 'ListServiceInstanceBill' => [ + 'summary' => '调用ListServiceInstanceBill查询服务实例账单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177374', + 'abilityTreeNodes' => [ + 'FEATUREcomputenest18JMDW', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38=', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-49793f3bfa034ec6a990', + ], + ], + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '账期YYYY-MM。仅支持最近18个月账期。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-05', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '查询账单的颗粒度。取值:'."\n" + .'- MONTHLY:月。与“费用中心-费用账单-账单明细-账期”账单一致。'."\n" + .'- DAILY:日。与“费用中心-费用账单-账单明细-按天”账单一致。'."\n" + ."\n" + .'选择DAILY需指定**BillingDate**。', + 'type' => 'string', + 'required' => false, + 'example' => 'DAILY', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期,仅当**Granularity**为DAILY时必填,格式为YYYY-MM-DD。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-04-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2849EE73-AFFA-5AFD-9575-12FA886451DA', + ], + 'TotalCount' => [ + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaxResults' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Item' => [ + 'description' => '备份计划计费信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份计划计费信息列表。', + 'type' => 'object', + 'properties' => [ + 'SplitBillingCycle' => [ + 'description' => '分账月。', + 'type' => 'string', + 'example' => '2021-07', + ], + 'BillingDate' => [ + 'description' => '账单日期,仅当**Granularity**为DAILY时必填,格式为YYYY-MM-DD。', + 'type' => 'string', + 'example' => '2024-10-23', + ], + 'SubscriptionType' => [ + 'description' => '付费类型,取值:'."\n" + .'- Subscription:预付费。'."\n" + .'- PayAsYouGo:后付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'ProductName' => [ + 'description' => '设备所属的产品名称。', + 'type' => 'string', + 'example' => 'NLB', + ], + 'BillingItemCode' => [ + 'description' => '计费项代码。', + 'type' => 'string', + 'example' => 'disk'."\n", + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'sls', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => 'sls', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'rm-bp1z88pb48487907u', + ], + 'DeductedByResourcePackage' => [ + 'description' => '资源包抵扣。', + 'type' => 'string', + 'example' => '0', + ], + 'ListPriceUnit' => [ + 'description' => '单价单位。', + 'type' => 'string', + 'example' => '元/GB'."\n", + ], + 'Usage' => [ + 'description' => '输入Token数量', + 'type' => 'string', + 'example' => '{\'EmbeddingTokens\': 314}', + ], + 'ListPrice' => [ + 'description' => '单价。', + 'type' => 'string', + 'example' => '0.12', + ], + 'UsageUnit' => [ + 'description' => '用量单位', + 'type' => 'string', + 'example' => 'GB'."\n", + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'string', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'string', + 'example' => '0', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'string', + 'example' => '0', + ], + 'BillingCycle' => [ + 'description' => '实例计算资源计费周期,仅支持实例级后付费。'."\n" + .'取值'."\n" + ."\n" + .'- **Day**:按天计费。'."\n" + ."\n" + .'- **Month**:按月计费。', + 'type' => 'string', + 'example' => '2025-02', + ], + 'BillingItem' => [ + 'description' => '计费项。', + 'type' => 'string', + 'example' => '带宽'."\n", + ], + 'Currency' => [ + 'description' => '币种。取值范围:'."\n" + .'- CNY:人民币。'."\n" + .'- USD:美元。'."\n" + .'- JPY:日元。', + 'type' => 'string', + 'example' => 'RMB', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=\\",\\n \\"RequestId\\": \\"2849EE73-AFFA-5AFD-9575-12FA886451DA\\",\\n \\"TotalCount\\": 0,\\n \\"MaxResults\\": 10,\\n \\"Item\\": [\\n {\\n \\"SplitBillingCycle\\": \\"2021-07\\",\\n \\"BillingDate\\": \\"2024-10-23\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"ProductName\\": \\"NLB\\",\\n \\"BillingItemCode\\": \\"disk\\\\n\\",\\n \\"ProductCode\\": \\"sls\\",\\n \\"ProductDetail\\": \\"sls\\",\\n \\"InstanceID\\": \\"rm-bp1z88pb48487907u\\",\\n \\"DeductedByResourcePackage\\": \\"0\\",\\n \\"ListPriceUnit\\": \\"元/GB\\\\n\\",\\n \\"Usage\\": \\"{\'EmbeddingTokens\': 314}\\",\\n \\"ListPrice\\": \\"0.12\\",\\n \\"UsageUnit\\": \\"GB\\\\n\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"InvoiceDiscount\\": \\"0\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"BillingCycle\\": \\"2025-02\\",\\n \\"BillingItem\\": \\"带宽\\\\n\\",\\n \\"Currency\\": \\"RMB\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询服务实例账单', + ], + 'CheckServiceDeployable' => [ + 'summary' => '服务实例部署前的预检查。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225993', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestVIKWP9', + 'FEATUREcomputenestVUFVAC', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'service-0e6fca6a51a544xxxxxx', + ], + ], + [ + 'name' => 'TrialType', + 'in' => 'query', + 'schema' => [ + 'description' => '试用类型。可选值:'."\n" + ."\n" + .'- Trial:支持试用。'."\n" + ."\n" + .'- NotTrial:不支持试用。', + 'type' => 'string', + 'required' => false, + 'example' => 'NotTrial', + ], + ], + [ + 'name' => 'PrePaidAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费总金额', + 'type' => 'string', + 'required' => false, + 'example' => '0.0', + ], + ], + [ + 'name' => 'PostPaidAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '后付费总金额。', + 'type' => 'string', + 'required' => false, + 'example' => '1.29', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板1', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', + ], + 'CheckResults' => [ + 'description' => '检查结果。', + 'type' => 'array', + 'items' => [ + 'description' => '检查结果。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '前置检查的类型,可能的值'."\n" + ."\n" + .'- Balance:余额'."\n" + .'- Quota: 配额', + 'type' => 'string', + 'example' => 'Balance', + ], + 'Value' => [ + 'description' => '检查结果。', + 'type' => 'string', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"CheckResults\\": [\\n {\\n \\"Type\\": \\"Balance\\",\\n \\"Value\\": \\"true\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '部署服务实例的前置检查', + ], + 'CreateRestoreTask' => [ + 'summary' => '创建恢复任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232527', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestSE9C8Z', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务实例ID。'."\n" + ."\n" + .'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'si-49793f3bfa034ec6a990', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID', + 'type' => 'string', + 'required' => true, + 'example' => 'backup-385d35fb088f453c8fa1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7', + ], + 'RestoreTaskId' => [ + 'description' => '恢复任务ID。', + 'type' => 'string', + 'example' => 'restore-fdsafda', + ], + 'Status' => [ + 'description' => '服务实例状态。取值:'."\n" + ."\n" + .'- Restoring 恢复中'."\n" + ."\n" + .'- Restored 恢复成功'."\n" + ."\n" + .'- RestoreFailed 恢复失败', + 'type' => 'string', + 'example' => 'Restoring', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"RestoreTaskId\\": \\"restore-fdsafda\\",\\n \\"Status\\": \\"Restoring\\"\\n}","type":"json"}]', + 'title' => '创建恢复任务', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + 'GetBackup' => [ + 'summary' => '获取备份详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246769', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestL64NT4', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'backup-cad4a85ff5e340388b93', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'title' => 'Id of the request', + 'description' => '备份ID', + 'type' => 'string', + 'example' => 'backup-cad4a85ff5e340388b93', + ], + 'ServiceInstanceId' => [ + 'title' => 'Id of the request', + 'description' => '服务实例ID', + 'type' => 'string', + 'example' => 'si-b58c874912fc4294****', + ], + 'StartTime' => [ + 'title' => 'Id of the request', + 'description' => '备份开始时间', + 'type' => 'string', + 'example' => '2022-01-01T11:00:00', + ], + 'EndTime' => [ + 'title' => 'Id of the request', + 'description' => '备份结束时间', + 'type' => 'string', + 'example' => '2022-01-01T12:00:00', + ], + 'Status' => [ + 'title' => 'Id of the request', + 'description' => '状态'."\n" + .'- Creating 创建中'."\n" + .'- Created 创建成功'."\n" + .'- CreateFailed 创建失败'."\n" + .'- Deleting 删除中'."\n" + .'- Deleted 删除成功'."\n" + .'- DeleteFailed 删除失败', + 'type' => 'string', + 'example' => 'Creating', + ], + 'Description' => [ + 'title' => 'Id of the request', + 'description' => '备份描述', + 'type' => 'string', + 'example' => 'No description', + ], + 'CreateTime' => [ + 'title' => 'Id of the request', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-05-20T00:00:00Z', + ], + 'ModifiedTime' => [ + 'title' => 'Id of the request', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-03-10T19:26:20Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7', + ], + 'StatusDetail' => [ + 'title' => '', + 'description' => '部署实例的状态描述。', + 'type' => 'string', + 'example' => 'Disk i-xxxx backup failed, error message: error', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupId\\": \\"backup-cad4a85ff5e340388b93\\",\\n \\"ServiceInstanceId\\": \\"si-b58c874912fc4294****\\",\\n \\"StartTime\\": \\"2022-01-01T11:00:00\\",\\n \\"EndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Description\\": \\"No description\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"ModifiedTime\\": \\"2025-03-10T19:26:20Z\\",\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"StatusDetail\\": \\"Disk i-xxxx backup failed, error message: error\\"\\n}","type":"json"}]', + 'title' => '获取备份详情', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + 'ListRestoreTasks' => [ + 'summary' => '列表查询恢复任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232531', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestSE9C8Z', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'NextToken', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU=', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤器。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '过滤器值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器值列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-xxxx', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'Name' => [ + 'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n" + ."\n" + .'- RestoreTaskId:恢复ID。'."\n" + ."\n" + .'- ServiceInstanceId:服务实例ID。'."\n" + ."\n" + .'- Status:状态。'."\n" + ."\n" + .'- StartTime:开始时间。'."\n" + ."\n" + .'- EndTime:结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'ServiceInstanceId', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', + 'description' => 'TotalCount本次请求条件下的数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕', + 'description' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕', + 'type' => 'string', + 'required' => true, + 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', + ], + 'MaxResults' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'MaxResults本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RestoreTasks' => [ + 'description' => '恢复任务列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RestoreTaskId' => [ + 'description' => '恢复任务ID。', + 'type' => 'string', + 'example' => 'restore-xxxxxx', + ], + 'ServiceInstanceId' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'example' => 'si-8c367c27c84e44a79d36', + ], + 'BackupId' => [ + 'description' => '备份ID', + 'type' => 'string', + 'example' => 'backup-728f128bf92c4e3da970', + ], + 'EndTime' => [ + 'description' => '服务实例过期时间。', + 'type' => 'string', + 'example' => '2025-01-27T18:00:00Z', + ], + 'Status' => [ + 'description' => '服务实例状态。取值:'."\n" + ."\n" + .'- Restoring 恢复中'."\n" + ."\n" + .'- Restored 恢复成功'."\n" + ."\n" + .'- RestoreFailed 恢复失败', + 'type' => 'string', + 'example' => 'Restoring', + ], + 'StartTime' => [ + 'description' => '升级开始时间。', + 'type' => 'string', + 'example' => '2025-01-27T16:00:00Z', + ], + 'StatusDetail' => [ + 'description' => '服务实例的部署信息描述。', + 'type' => 'string', + 'example' => 'i-xxxx failed, error message: error', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-09-07T11:37:37Z', + ], + 'ModifiedTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-05-07T12:16:16Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\",\\n \\"NextToken\\": \\"BBBAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"MaxResults\\": 20,\\n \\"RestoreTasks\\": [\\n {\\n \\"RestoreTaskId\\": \\"restore-xxxxxx\\",\\n \\"ServiceInstanceId\\": \\"si-8c367c27c84e44a79d36\\",\\n \\"BackupId\\": \\"backup-728f128bf92c4e3da970\\",\\n \\"EndTime\\": \\"2025-01-27T18:00:00Z\\",\\n \\"Status\\": \\"Restoring\\",\\n \\"StartTime\\": \\"2025-01-27T16:00:00Z\\",\\n \\"StatusDetail\\": \\"i-xxxx failed, error message: error\\",\\n \\"CreateTime\\": \\"2023-09-07T11:37:37Z\\",\\n \\"ModifiedTime\\": \\"2025-05-07T12:16:16Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取恢复任务列表', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + 'ListBackups' => [ + 'summary' => '列表查询计算巢实例备份。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232493', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestSE9C8Z', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤器。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '过滤器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤器值列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'si-xxx', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'Name' => [ + 'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n" + ."\n" + .'- BackupId:备份ID。'."\n" + ."\n" + .'- ServiceInstanceId:服务实例ID。'."\n" + ."\n" + .'- Status:状态。'."\n" + ."\n" + .'- StartTime:开始时间。'."\n" + ."\n" + .'- EndTime:结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'ServiceInstanceId', + ], + ], + 'required' => false, + ], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', + 'description' => 'TotalCount本次请求条件下的数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'BB58FE53-ED8F-5D12-9746-CD3A5F463D95', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕', + 'description' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕', + 'type' => 'string', + 'required' => true, + 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=', + ], + 'MaxResults' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'MaxResults本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Backups' => [ + 'description' => '备份列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份详情。', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'description' => '备份ID', + 'type' => 'string', + 'example' => 'backup-4e13aa8ca6a34150addd', + ], + 'ServiceInstanceId' => [ + 'description' => '服务实例ID。', + 'type' => 'string', + 'example' => 'si-7b6138dfce1e4c41ab71', + ], + 'StartTime' => [ + 'description' => '备份开始时间', + 'type' => 'string', + 'example' => '2025-06-30T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '备份结束时间', + 'type' => 'string', + 'example' => '2024-08-15T02:24:00Z', + ], + 'Status' => [ + 'description' => '状态'."\n" + ."\n" + .'- Creating 创建中'."\n" + .'- Created 创建成功'."\n" + .'- CreateFailed 创建失败'."\n" + .'- Deleting 删除中'."\n" + .'- Deleted 删除成功'."\n" + .'- DeleteFailed 删除失败', + 'type' => 'string', + 'example' => 'Creating', + ], + 'Description' => [ + 'description' => '备份描述', + 'type' => 'string', + 'example' => 'No description', + ], + 'BackupMode' => [ + 'description' => '备份模式,返回值:'."\n" + .'* **Manual**:手动备份。', + 'type' => 'string', + 'example' => 'Manual', + ], + 'RetentionDays' => [ + 'description' => '保留天数。过期会被清理。默认为空不过期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StatusDetail' => [ + 'description' => '服务实例的部署信息描述。', + 'type' => 'string', + 'example' => 'Disk i-xxxx backup failed, error message: error ', + ], + 'ModifiedTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-09-03T19:54:38+08:00', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-09-03T19:54:38+08:00', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"BB58FE53-ED8F-5D12-9746-CD3A5F463D95\\",\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=\\",\\n \\"MaxResults\\": 100,\\n \\"Backups\\": [\\n {\\n \\"BackupId\\": \\"backup-4e13aa8ca6a34150addd\\",\\n \\"ServiceInstanceId\\": \\"si-7b6138dfce1e4c41ab71\\",\\n \\"StartTime\\": \\"2025-06-30T16:00:00Z\\",\\n \\"EndTime\\": \\"2024-08-15T02:24:00Z\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Description\\": \\"No description\\",\\n \\"BackupMode\\": \\"Manual\\",\\n \\"RetentionDays\\": 1,\\n \\"StatusDetail\\": \\"Disk i-xxxx backup failed, error message: error\\\\t\\",\\n \\"ModifiedTime\\": \\"2024-09-03T19:54:38+08:00\\",\\n \\"CreateTime\\": \\"2024-09-03T19:54:38+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取备份列表', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + 'CreateBackup' => [ + 'summary' => '创建计算巢实例备份。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232490', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestSE9C8Z', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '备份描述', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'No description', + ], + ], + [ + 'name' => 'ServiceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要备份的服务实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'si-56cfb7ec3a634448a96c', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8DC02957-A0FC-5AB2-8C54-496B636EAF12', + ], + 'BackupId' => [ + 'title' => 'Id of the request', + 'description' => '备份ID', + 'type' => 'string', + 'example' => 'backup-cad4a85ff5e340388b93', + ], + 'Description' => [ + 'title' => 'Id of the request', + 'description' => '描述', + 'type' => 'string', + 'example' => 'No description', + ], + 'Status' => [ + 'title' => 'Id of the request', + 'description' => '备份状态'."\n" + .'- Creating 创建中'."\n" + .'- Created 创建成功'."\n" + .'- CreateFailed 创建失败'."\n" + .'- Deleting 删除中'."\n" + .'- Deleted 删除成功'."\n" + .'- DeleteFailed 删除失败', + 'type' => 'string', + 'example' => 'Creating', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8DC02957-A0FC-5AB2-8C54-496B636EAF12\\",\\n \\"BackupId\\": \\"backup-cad4a85ff5e340388b93\\",\\n \\"Description\\": \\"No description\\",\\n \\"Status\\": \\"Creating\\"\\n}","type":"json"}]', + 'title' => '创建备份', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + 'DeleteBackup' => [ + 'summary' => '删除计算巢实例备份。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232519', + 'abilityTreeNodes' => [ + 'FEATUREcomputenestSE9C8Z', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID', + 'type' => 'string', + 'required' => true, + 'example' => 'backup-385d35fb088f453c8fa1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]', + 'title' => '删除备份', + 'description' => '### 前提条件'."\n" + .'请先确认服务商在创建服务时开启变配功能并完成变配参数设置。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'computenest.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'computenest.ap-southeast-1.aliyuncs.com', + ], + ], +]; |
