'1.0',
'info' => [
'style' => 'RPC',
'product' => 'ComputeNestSupplier',
'version' => '2021-05-21',
],
'directories' => [
[
'id' => 305644,
'title' => '服务 ',
'type' => 'directory',
'children' => [
'CreateService',
'DeleteService',
'UpdateService',
'GetService',
'ListServices',
'PreLaunchService',
'RegisterService',
'LaunchService',
'GetServiceProvisions',
'GetServiceTemplateParameterConstraints',
'GetServiceEstimateCost',
'WithdrawService',
'GenerateServicePolicy',
'CancelServiceRegistration',
'ListServiceRegistrations',
],
],
[
'id' => 305660,
'title' => '服务实例 ',
'type' => 'directory',
'children' => [
'ListServiceInstanceUpgradeHistory',
'RollbackServiceInstance',
'CreateServiceInstance',
'DeleteServiceInstances',
'UpdateServiceInstanceSpec',
'UpdateServiceInstanceAttribute',
'ModifyServiceInstanceResources',
'UpgradeServiceInstance',
'GetServiceInstance',
'ListServiceInstances',
'DeployServiceInstance',
'ContinueDeployServiceInstance',
'StartServiceInstance',
'StopServiceInstance',
'RestartServiceInstance',
'ListServiceInstanceDeployDetails',
'ListServiceInstanceResources',
'ListServiceInstanceBill',
'ListServiceInstanceLogs',
],
],
[
'id' => 305680,
'title' => '部署物 ',
'type' => 'directory',
'children' => [
'DeleteAcrImageRepositories',
'ListArtifactRisks',
'CreateArtifact',
'DeleteArtifact',
'UpdateArtifact',
'DeleteAcrImageTags',
'GetArtifact',
'ListArtifacts',
'ListArtifactVersions',
'ReleaseArtifact',
'GetUploadCredentials',
'GetArtifactRepositoryCredentials',
'ListAcrImageTags',
'ListAcrImageRepositories',
],
],
[
'id' => 305695,
'title' => '服务使用申请 ',
'type' => 'directory',
'children' => [
'CreateServiceUsage',
'RejectServiceUsage',
'ApproveServiceUsage',
'ListServiceUsages',
],
],
[
'id' => 305700,
'title' => '服务权限 ',
'type' => 'directory',
'children' => [
'AddServiceSharedAccounts',
'RemoveServiceSharedAccounts',
'ListServiceSharedAccounts',
'UpdateSharedAccountPermission',
],
],
[
'id' => 305705,
'title' => '标签和资源组 ',
'type' => 'directory',
'children' => [
'ListTagResources',
'TagResources',
'UnTagResources',
'ListTagValues',
'ListTagKeys',
],
],
[
'id' => 305711,
'title' => '服务商 ',
'type' => 'directory',
'children' => [
'GetSupplierInformation',
'CreateSupplierRegistration',
'ListSupplierRegistrations',
'UpdateSupplierInformation',
],
],
[
'id' => 305716,
'title' => '其他 ',
'type' => 'directory',
'children' => [
'PushMeteringData',
'CreateOpsNotice',
'CreateServiceTestTask',
'ListServiceTestTasks',
'ListServiceTestTaskLogs',
'GetServiceTestTask',
'GenerateDefaultServiceTestConfig',
'GetServiceRegistration',
'ListResellers',
'DeleteServiceTestCase',
'GetOpsNotice',
'UpdateServiceTestCase',
'GetNetworkAvailableZones',
'ListServiceTestCases',
'CreateServiceTestCase',
'GetServiceTemplateCriterionIssues',
'ListArtifactBuildLogs',
'ListServiceBuildLogs',
'ListOpsNotices',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateService' => [
'summary' => '通过地域ID、部署类型、服务类型、服务名称等参数,创建新的服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36949',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
'FEATUREcomputenest1Z49ZW',
'FEATUREcomputenest21Y74A',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => false,
'example' => 'service-0e6fca6a51a544xxxxxx',
],
],
[
'name' => 'DeployType',
'in' => 'query',
'schema' => [
'description' => '部署类型。可能值:'."\n"
."\n"
.'- ros:通过ROS部署。'."\n"
."\n"
.'- terraform:通过Terraform部署。'."\n"
."\n"
.'- ack:通过ACK部署。'."\n"
."\n"
.'- spi:调用SPI部署。'."\n"
."\n"
.'- operation:代运维服务部署。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ros',
],
],
[
'name' => 'DeployMetadata',
'in' => 'query',
'schema' => [
'description' => '存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用JSON String格式进行数据存储。 ',
'type' => 'string',
'required' => false,
'example' => '{\\"TemplateConfigs\\":[{\\"Name\\":\\"模板1\\",\\"Url\\":\\"oss://computenest-test/template" '."\n"
.' + ".json?RegionId=cn-beijing\\",\\"PredefinedParameters\\":[{\\"Name\\":\\"低配版\\"," '."\n"
.' + "\\"Parameters\\":{\\"InstanceType\\":\\"ecs.g5.large\\",\\"DataDiskSize\\":40}},{\\"Name\\":\\"高配版\\"," '."\n"
.' + "\\"Parameters\\":{\\"InstanceType\\":\\"ecs.g5.large\\",\\"DataDiskSize\\":200}}]}]}',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '服务类型。可能的值:'."\n"
."\n"
.'- private:部署在用户账户下的服务实例。'."\n"
."\n"
.'- managed:托管在服务商账户下的服务实例。'."\n"
."\n"
.'- operation:代运维服务实例'."\n"
."\n"
.'- poc:试用服务实例。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'private',
'default' => 'private',
],
],
[
'name' => 'ServiceInfo',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务详情。',
'type' => 'array',
'items' => [
'description' => '服务详情。',
'type' => 'object',
'properties' => [
'Locale' => [
'description' => '服务语言。可能的值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US:英文。',
'type' => 'string',
'required' => true,
'example' => 'zh-CN',
],
'ShortDescription' => [
'description' => '服务概述。',
'type' => 'string',
'required' => false,
'example' => 'TiDB是A公司自主设计、研发的开源分布式关系型数据库。',
],
'Image' => [
'description' => '服务图标地址。',
'type' => 'string',
'required' => false,
'example' => 'http://img.tidb.oss.url',
],
'Name' => [
'description' => '服务名称。',
'type' => 'string',
'required' => true,
'example' => 'TiDB Database',
],
'LongDescriptionUrl' => [
'description' => '服务详细描述',
'type' => 'string',
'required' => false,
'example' => 'http://description.tidb.oss.url'."\n",
],
'Agreements' => [
'description' => '服务的协议文档信息。',
'type' => 'array',
'items' => [
'description' => '服务的协议文档信息。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '协议名称。',
'type' => 'string',
'required' => false,
'example' => 'Name',
],
'Url' => [
'description' => '协议链接。',
'type' => 'string',
'required' => false,
'example' => 'https://aliyun.com/xxxxxxxx.html',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
'Softwares' => [
'description' => '服务中用到的软件信息。',
'type' => 'array',
'items' => [
'description' => '服务中用到的软件信息。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '软件名称。',
'type' => 'string',
'required' => false,
'example' => 'MySQL',
],
'Version' => [
'description' => '软件版本。',
'type' => 'string',
'required' => false,
'example' => '5.7',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'IsSupportOperated',
'in' => 'query',
'schema' => [
'description' => '是否代运维,默认为:false。可能的值:'."\n"
."\n"
.'- true:开启。'."\n"
."\n"
.'- false:关闭。'."\n"
.'> 当**ServiceType**为**private**时需要填入该值。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PolicyNames',
'in' => 'query',
'schema' => [
'description' => '策略名称。单个策略名称长度不超过128个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。',
'type' => 'string',
'required' => false,
'example' => 'policyName1, policyName2',
],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => [
'description' => '代运维时间。单位:秒。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'AlarmMetadata',
'in' => 'query',
'schema' => [
'description' => '服务报警配置。'."\n"
.'> 当**PolicyNames**中配置了报警权限策略后,该配置才会生效。',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "TemplateUrl": "http://template.file.url",'."\n"
.' // 应用分组级别告警元数据'."\n"
.' "ApplicationGroups": ['."\n"
.' {'."\n"
.' "Name": "applicationGroup1",'."\n"
.' "TemplateUrl": "url1"'."\n"
.' },'."\n"
.' {'."\n"
.' "Name": "applicationGroup2",'."\n"
.' "TemplateUrl": "url2"'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
],
[
'name' => 'ShareType',
'in' => 'query',
'schema' => [
'description' => '共享类型。可能的值:'."\n"
."\n"
.'- Public:公开的,正式部署和试用部署都不受限。'."\n"
."\n"
.'- Restricted:受限的,正式部署和试用部署都受限。'."\n"
."\n"
.'- OnlyFormalRestricted:仅正式部署受限。'."\n"
."\n"
.'- OnlyTrailRestricted:仅试用部署受限。'."\n"
."\n"
.'- Hidden:隐藏的,不可见且不可申请部署权限。',
'type' => 'string',
'required' => false,
'example' => 'Public',
],
],
[
'name' => 'ApprovalType',
'in' => 'query',
'schema' => [
'description' => '服务使用申请审批类型。可能的值:'."\n"
."\n"
.'- Manual:收到审批。'."\n"
."\n"
.'- AutoPass:自动通过。',
'type' => 'string',
'required' => false,
'example' => 'Manual',
],
],
[
'name' => 'VersionName',
'in' => 'query',
'schema' => [
'description' => '版本名称。',
'type' => 'string',
'required' => false,
'example' => 'Draft',
],
],
[
'name' => 'UpgradeMetadata',
'in' => 'query',
'schema' => [
'description' => '升级元数据。',
'type' => 'string',
'required' => false,
'example' => '{\\"Description\\":\\"xxx\\",\\"SupportRollback\\":true,\\"SupportUpgradeFromVersions\\":[],\\"UpgradeComponents\\":[\\"Configuration\\"]}',
],
],
[
'name' => 'TrialDuration',
'in' => 'query',
'schema' => [
'description' => '试用时长。单位:天。试用时长的最长天数不超过30天。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '7',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户自定义标签。',
'type' => 'array',
'items' => [
'description' => '用户自定义标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'Usage',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'Web',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'TenantType',
'in' => 'query',
'schema' => [
'description' => '租户类型。可能的值:'."\n"
."\n"
.'- SingleTenant:单租户。'."\n"
."\n"
.'- MultiTenant:多租户。',
'type' => 'string',
'required' => false,
'example' => 'SingleTenant',
],
],
[
'name' => 'LicenseMetadata',
'in' => 'query',
'schema' => [
'description' => '许可证元数据。',
'type' => 'string',
'required' => false,
'example' => '{\\"PayType\\":\\"CustomFixTime\\",\\"DefaultLicenseDays\\":7,\\"CustomMetadata\\":[{\\"TemplateName\\":\\"模板1\\",\\"SpecificationName\\":\\"bandwith-0\\",\\"CustomData\\":\\"1\\"}]}',
],
],
[
'name' => 'OperationMetadata',
'in' => 'query',
'schema' => [
'description' => '代运维配置。',
'type' => 'string',
'required' => false,
'example' => '{\\"PrometheusConfigMap\\":{\\"New_Vpc_Ack_And_Jumpserver\\":{}}}',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-aek25refu7r3opq',
],
],
[
'name' => 'LogMetadata',
'in' => 'query',
'schema' => [
'description' => '应用日志配置。',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "Logstores": ['."\n"
.' {'."\n"
.' "LogstoreName": "access-log",'."\n"
.' "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置'."\n"
.' "FilePattern": "access.log*" # 对容器不需要,在YAML中配置'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
],
[
'name' => 'SourceServiceId',
'in' => 'query',
'schema' => [
'description' => '分销源服务ID。',
'type' => 'string',
'required' => false,
'example' => 'service-70a3b15bb62643xxxxxx',
],
],
[
'name' => 'SourceServiceVersion',
'in' => 'query',
'schema' => [
'description' => '分销源服务版本。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Resellable',
'in' => 'query',
'schema' => [
'description' => '是否支持分销。可能的值:'."\n"
."\n"
.'- false:不支持。'."\n"
."\n"
.'- true:支持。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'BuildParameters',
'in' => 'query',
'schema' => [
'description' => '构建服务参数。',
'type' => 'string',
'required' => false,
'example' => '{ "ServiceTemplateId": "st-xxxxx"}',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否空跑检查。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ComplianceMetadata',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '合规检查元数据。',
'type' => 'object',
'properties' => [
'CompliancePacks' => [
'description' => '选择的合规包。',
'type' => 'array',
'items' => [
'description' => '选择的合规包。可选值:'."\n"
.'- VpcDataRisk: vpc内数据安全风险合规包',
'type' => 'string',
'required' => false,
'example' => 'VpcDataRisk',
],
'required' => false,
'maxItems' => 10,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '服务状态。',
'type' => 'string',
'example' => 'Created',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C',
],
'Version' => [
'description' => '服务版本。',
'type' => 'string',
'example' => 'draft',
],
'ServiceId' => [
'description' => '服务ID。',
'type' => 'string',
'example' => 'service-0e6fca6a51a544xxxxxx',
],
'DryRunResult' => [
'description' => '校验结果。',
'type' => 'object',
'properties' => [
'RolePolicy' => [
'description' => '部署角色的权限策略。',
'type' => 'object',
'properties' => [
'Policy' => [
'description' => '部署角色需要的权限策略。',
'type' => 'string',
'example' => '{'."\n"
.' "Statement": [{'."\n"
.' "Action": ["oos:CancelExecutions", "oos:DeleteExecutions", "oos:GetTemplate", "oos:ListExecutions", "oos:ListTemplates", "oos:NotifyExecution", "oos:StartExecution"],'."\n"
.' "Effect": "Allow",'."\n"
.' "Resource": "*"'."\n"
.' }, {'."\n"
.' "Action": ["ram:PassRole"],'."\n"
.' "Effect": "Allow",'."\n"
.' "Resource": "*"'."\n"
.' }, {'."\n"
.' "Action": ["ros:CreateStack", "ros:GetStack", "ros:UpdateStack", "ros:ListStackEvents", "ros:ListStackResources", "ros:ListStackResources", "ros:DeleteStack", "ram:GetRole"],'."\n"
.' "Effect": "Allow",'."\n"
.' "Resource": "*"'."\n"
.' }],'."\n"
.' "Version": "1"'."\n"
.'}',
],
'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' => 'CreateStack',
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Created\\",\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"Version\\": \\"draft\\",\\n \\"ServiceId\\": \\"service-0e6fca6a51a544xxxxxx\\",\\n \\"DryRunResult\\": {\\n \\"RolePolicy\\": {\\n \\"Policy\\": \\"{\\\\n\\\\t\\\\\\"Statement\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"oos:CancelExecutions\\\\\\", \\\\\\"oos:DeleteExecutions\\\\\\", \\\\\\"oos:GetTemplate\\\\\\", \\\\\\"oos:ListExecutions\\\\\\", \\\\\\"oos:ListTemplates\\\\\\", \\\\\\"oos:NotifyExecution\\\\\\", \\\\\\"oos:StartExecution\\\\\\"],\\\\n\\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n\\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"ram:PassRole\\\\\\"],\\\\n\\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n\\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"ros:CreateStack\\\\\\", \\\\\\"ros:GetStack\\\\\\", \\\\\\"ros:UpdateStack\\\\\\", \\\\\\"ros:ListStackEvents\\\\\\", \\\\\\"ros:ListStackResources\\\\\\", \\\\\\"ros:ListStackResources\\\\\\", \\\\\\"ros:DeleteStack\\\\\\", \\\\\\"ram:GetRole\\\\\\"],\\\\n\\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n\\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\",\\n \\"MissingPolicy\\": [\\n {\\n \\"ServiceName\\": \\"ecs\\",\\n \\"Resource\\": \\"*\\",\\n \\"Action\\": [\\n \\"CreateStack\\"\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '创建服务',
],
'DeleteService' => [
'summary' => '通过地域ID、服务ID、服务版本删除指定服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '36943',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
'FEATUREcomputenest1Z49ZW',
'FEATUREcomputenest21Y74A',
],
'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,
'docRequired' => true,
'example' => 'service-0e6fca6a51a54420****',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
],
'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' => '删除服务',
],
'UpdateService' => [
'summary' => '升级服务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36950',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DeployType',
'in' => 'query',
'schema' => [
'description' => '部署类型。可能值:'."\n"
."\n"
.'- ros:通过ROS部署。'."\n"
."\n"
.'- terraform:通过Terraform部署。'."\n"
."\n"
.'- spi:调用SPI部署。'."\n"
."\n"
.'- operation:代运维服务部署。'."\n"
."\n"
.'- container:通过容器部署。'."\n"
."\n"
.'- pkg:包服务。',
'type' => 'string',
'required' => false,
'example' => 'ros',
],
],
[
'name' => 'DeployMetadata',
'in' => 'query',
'schema' => [
'description' => '存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用JSON String格式进行数据存储。 ',
'type' => 'string',
'required' => false,
'example' => '{\\"EstimateTime\\":null,\\"SupplierDeployMetadata\\":{\\"DeployTimeout\\":7200},\\"EnableVnc\\":false}',
],
],
[
'name' => 'AlarmMetadata',
'in' => 'query',
'schema' => [
'description' => '服务报警配置。'."\n"
.'> 当**PolicyNames**中配置了报警权限策略后,该配置才会生效。',
'type' => 'string',
'required' => false,
'example' => '{\\"CmsTemplateId\\":1162921,\\"TemplateUrl\\":\\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/1760465342xxxxxx/template/c072ef50-6c03-4d9c-8f0e-d1c440xxxxxx.json\\"}',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '788E7CP0EN9D51P',
],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'service-1dda29c3eca648xxxxxx',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '服务类型。可能的值:'."\n"
."\n"
.'- private:部署在用户账户下的服务实例。'."\n"
."\n"
.'- managed:托管在服务商账户下的服务实例。'."\n"
."\n"
.'- operation:代运维服务实例'."\n"
."\n"
.'- poc:试用服务实例。',
'type' => 'string',
'required' => false,
'example' => 'private',
],
],
[
'name' => 'ServiceInfo',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务详情。',
'type' => 'array',
'items' => [
'description' => '服务详情。',
'type' => 'object',
'properties' => [
'Locale' => [
'description' => '服务语言。可能的值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US:英文。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
'ShortDescription' => [
'description' => '服务概述。',
'type' => 'string',
'required' => false,
'example' => 'B是A公司自主设计并研发的开源分布式的关系型数据库',
],
'Image' => [
'description' => '服务图标地址。',
'type' => 'string',
'required' => false,
'example' => 'http://img.tidb.oss.url',
],
'Name' => [
'description' => '服务名称。',
'type' => 'string',
'required' => false,
'example' => 'B数据库',
],
'LongDescriptionUrl' => [
'description' => '服务详细描述的地址。',
'type' => 'string',
'required' => false,
'example' => 'http://description.tidb.oss.url'."\n",
],
'Agreements' => [
'description' => '服务的协议文档信息。',
'type' => 'array',
'items' => [
'description' => '服务的协议文档信息。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '协议文档名称。',
'type' => 'string',
'required' => false,
'example' => 'Name',
],
'Url' => [
'description' => '协议链接。',
'type' => 'string',
'required' => false,
'example' => 'https://aliyun.com/xxxxxxxx.html',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
'Softwares' => [
'description' => '服务中用到的软件信息。',
'type' => 'array',
'items' => [
'description' => '服务中用到的软件信息。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '软件名称。',
'type' => 'string',
'required' => false,
'example' => 'MySQL',
],
'Version' => [
'description' => '软件版本。',
'type' => 'string',
'required' => false,
'example' => '5.7',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'IsSupportOperated',
'in' => 'query',
'schema' => [
'description' => '是否代运维,默认为:false。可能的值:'."\n"
."\n"
.'- true:开启。'."\n"
."\n"
.'- false:关闭。'."\n"
.'> 当**ServiceType**为**private**时需要填入该值。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PolicyNames',
'in' => 'query',
'schema' => [
'description' => '策略名称。单个策略名称长度不超过128个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。',
'type' => 'string',
'required' => false,
'example' => 'policyName1, policyName2',
],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => [
'description' => '代运维时间。单位:秒。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '259200',
],
],
[
'name' => 'VersionName',
'in' => 'query',
'schema' => [
'description' => '版本名称。',
'type' => 'string',
'required' => false,
'example' => 'Draft',
],
],
[
'name' => 'UpgradeMetadata',
'in' => 'query',
'schema' => [
'description' => '升级元数据。',
'type' => 'string',
'required' => false,
'example' => '{\\"Description\\":\\"xxx\\",\\"SupportRollback\\":true,\\"SupportUpgradeFromVersions\\":[],\\"UpgradeComponents\\":[\\"Configuration\\"]}',
],
],
[
'name' => 'TrialDuration',
'in' => 'query',
'schema' => [
'description' => '试用时长。单位:天。试用时长的最长天数不超过30天。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '7',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'TenantType',
'in' => 'query',
'schema' => [
'description' => '租户类型。可能的值:'."\n"
."\n"
.'- SingleTenant:单租户。'."\n"
."\n"
.'- MultiTenant:多租户。',
'type' => 'string',
'required' => false,
'example' => 'SingleTenant',
],
],
[
'name' => 'LicenseMetadata',
'in' => 'query',
'schema' => [
'description' => '许可证元数据。',
'type' => 'string',
'required' => false,
'example' => '{\\"PayType\\":\\"CustomFixTime\\",\\"DefaultLicenseDays\\":7,\\"CustomMetadata\\":[{\\"TemplateName\\":\\"模板1\\",\\"SpecificationName\\":\\"bandwith-0\\",\\"CustomData\\":\\"1\\"}]}',
],
],
[
'name' => 'OperationMetadata',
'in' => 'query',
'schema' => [
'description' => '代运维配置。',
'type' => 'string',
'required' => false,
'example' => '{\\"PrometheusConfigMap\\":{\\"Custom_Image_Ecs\\":{\\"EnablePrometheus\\":false}}}',
],
],
[
'name' => 'LogMetadata',
'in' => 'query',
'schema' => [
'description' => '应用日志配置。',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "Logstores": ['."\n"
.' {'."\n"
.' "LogstoreName": "access-log",'."\n"
.' "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置'."\n"
.' "FilePattern": "access.log*" # 对容器不需要,在YAML中配置'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
],
[
'name' => 'Resellable',
'in' => 'query',
'schema' => [
'description' => '是否支持分销。可能的值:'."\n"
."\n"
.'- false:不支持。'."\n"
."\n"
.'- true:支持。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'UpdateOption',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '更新选项。',
'type' => 'object',
'properties' => [
'UpdateFrom' => [
'description' => '更新选项。可选值:'."\n"
."\n"
.'- CODE:代码。'."\n"
."\n"
.'- PARAMETERS:参数。',
'type' => 'string',
'required' => false,
'example' => 'PARAMETERS',
],
'UpdateArtifact' => [
'description' => '是否需要更新部署物',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
],
[
'name' => 'Commodity',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '绑定商品信息',
'type' => 'object',
'properties' => [
'SpecificationMappings' => [
'description' => '商品规格与模板/套餐关系(云市场-包年包月场景使用)',
'type' => 'array',
'items' => [
'description' => '商品规格与模板/套餐关系(云市场-包年包月场景使用)',
'type' => 'object',
'properties' => [
'TemplateName' => [
'description' => '模板名称',
'type' => 'string',
'required' => false,
'example' => '模板1',
],
'SpecificationName' => [
'description' => '套餐名称',
'type' => 'string',
'required' => false,
'example' => '低配版',
],
'SpecificationCode' => [
'description' => '规格码',
'type' => 'string',
'required' => false,
'example' => 'yuncode5767800001',
],
],
'required' => false,
],
'required' => false,
],
'MeteringEntityMappings' => [
'description' => '模板/套餐与计量维度绑定关系(云市场-按量付费场景使用)',
'type' => 'array',
'items' => [
'description' => '模板/套餐与计量维度绑定关系(云市场-按量付费场景使用)',
'type' => 'object',
'properties' => [
'TemplateName' => [
'description' => '模板名称',
'type' => 'string',
'required' => false,
'example' => '模板1',
],
'SpecificationName' => [
'description' => '套餐名称',
'type' => 'string',
'required' => false,
'example' => '低配版',
],
'EntityIds' => [
'description' => '计量项ID',
'type' => 'array',
'items' => [
'description' => '计量项ID。',
'type' => 'string',
'required' => false,
'example' => 'cmgj0006xxxx-Memory-1',
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'MeteringEntityExtraInfos' => [
'description' => '计量项配置信息(云市场-按量付费场景使用)',
'type' => 'array',
'items' => [
'description' => '计量项配置信息。',
'type' => 'object',
'properties' => [
'EntityId' => [
'description' => '计量项ID。',
'type' => 'string',
'required' => false,
'example' => 'cmgj0006xxxx-Memory-1',
],
'Type' => [
'description' => '类型,参考值:'."\n"
.'* **Custom**'."\n"
.'* **ComputeNestBill**'."\n"
.'* **ComputeNestPrometheus**'."\n"
.'* **ComputeNestTime**',
'type' => 'string',
'required' => false,
'example' => 'Custom',
],
'MetricName' => [
'description' => '指标名称,当Type为ComputeNestBill或ComputeNestPrometheus填入',
'type' => 'string',
'required' => false,
'example' => 'VirtualCpu/ecs.InstanceType',
],
'Promql' => [
'description' => 'Prometheus语句',
'type' => 'string',
'required' => false,
'example' => 'avg_over_time(sum(rate(container_cpu_usage_seconds_total{namespace=~"ALIYUN::StackName"}[2m]))[1h:10s])',
],
],
'required' => false,
],
'required' => false,
],
'ComponentsMappings' => [
'description' => '此参数不对外开放',
'type' => 'array',
'items' => [
'description' => '此参数不对外开放',
'type' => 'object',
'properties' => [
'TemplateName' => [
'description' => '此参数不对外开放',
'type' => 'string',
'required' => false,
'example' => '此参数不对外开放',
],
'Mappings' => [
'description' => '此参数不对外开放',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'type' => 'string',
'example' => '此参数不对外开放'."\n"
."\n",
'description' => '此参数不对外开放',
],
'example' => '此参数不对外开放',
],
],
'required' => false,
],
'required' => false,
],
'SaasBoostConfig' => [
'description' => 'SaaS Boost配置信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
'required' => false,
],
],
[
'name' => 'ShareType',
'in' => 'query',
'schema' => [
'description' => '共享类型。可能的值:'."\n"
."\n"
.'- Public:公开的,正式部署和试用部署都不受限。'."\n"
."\n"
.'- Restricted:受限的,正式部署和试用部署都受限。'."\n"
."\n"
.'- OnlyFormalRestricted:仅正式部署受限。'."\n"
."\n"
.'- OnlyTrailRestricted:仅试用部署受限。'."\n"
."\n"
.'- Hidden:隐藏的,不可见且不可申请部署权限。',
'type' => 'string',
'required' => false,
'example' => 'Public',
],
],
[
'name' => 'ApprovalType',
'in' => 'query',
'schema' => [
'description' => '服务使用申请审批类型。可能的值:'."\n"
."\n"
.'- Manual:收到审批。'."\n"
."\n"
.'- AutoPass:自动通过。',
'type' => 'string',
'required' => false,
'example' => 'Manual',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否对此次请求执行预检,包括权限、实例状态校验等。可能的值:'."\n"
."\n"
.'- true:发送请求,不更新服务。'."\n"
."\n"
.'- false:发送请求,检查通过后更新服务。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ComplianceMetadata',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '合规检查元数据。',
'type' => 'object',
'properties' => [
'CompliancePacks' => [
'description' => '选择的合规包。',
'type' => 'array',
'items' => [
'description' => '选择的合规包。',
'type' => 'string',
'required' => false,
'example' => 'VpcDataRisk',
],
'required' => false,
'maxItems' => 10,
],
],
'required' => false,
],
],
[
'name' => 'BuildParameters',
'in' => 'query',
'schema' => [
'description' => '构建服务参数。',
'type' => 'string',
'required' => false,
'example' => '{ "ServiceTemplateId": "st-xxxxx"}',
],
],
[
'name' => 'ServiceLocaleConfigs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务多语言配置',
'type' => 'array',
'items' => [
'description' => '服务多语言配置',
'type' => 'object',
'properties' => [
'OriginalValue' => [
'description' => '业务信息原始数据值',
'type' => 'string',
'required' => false,
'example' => 'Service Name'."\n",
],
'ZhValue' => [
'description' => '业务信息对应的中文数据值',
'type' => 'string',
'required' => false,
'example' => '服务名称',
],
'EnValue' => [
'description' => '业务信息对应的英文数据值',
'type' => 'string',
'required' => false,
'example' => 'Service Name'."\n",
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DF0F666F-FBBC-55C3-A368-C955DE7B4839',
],
'DryRunResult' => [
'description' => '校验结果。仅在DryRun为true时返回。',
'type' => 'object',
'properties' => [
'RolePolicy' => [
'description' => '部署角色的权限策略。',
'type' => 'object',
'properties' => [
'Policy' => [
'description' => '部署角色需要的权限策略。',
'type' => 'string',
'example' => '{'."\n"
.' "Statement": [{'."\n"
.' "Action": ["oos:CancelExecutions", "oos:DeleteExecutions", "oos:GetTemplate", "oos:ListExecutions", "oos:ListTemplates", "oos:NotifyExecution", "oos:StartExecution"],'."\n"
.' "Effect": "Allow",'."\n"
.' "Resource": "*"'."\n"
.' }, {'."\n"
.' "Action": ["ram:PassRole"],'."\n"
.' "Effect": "Allow",'."\n"
.' "Resource": "*"'."\n"
.' }, {'."\n"
.' "Action": ["ros:CreateStack", "ros:GetStack", "ros:UpdateStack", "ros:ListStackEvents", "ros:ListStackResources", "ros:ListStackResources", "ros:DeleteStack", "ram:GetRole"],'."\n"
.' "Effect": "Allow",'."\n"
.' "Resource": "*"'."\n"
.' }],'."\n"
.' "Version": "1"'."\n"
.'}',
],
'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' => 'CreateStack',
],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF0F666F-FBBC-55C3-A368-C955DE7B4839\\",\\n \\"DryRunResult\\": {\\n \\"RolePolicy\\": {\\n \\"Policy\\": \\"{\\\\n\\\\t\\\\\\"Statement\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"oos:CancelExecutions\\\\\\", \\\\\\"oos:DeleteExecutions\\\\\\", \\\\\\"oos:GetTemplate\\\\\\", \\\\\\"oos:ListExecutions\\\\\\", \\\\\\"oos:ListTemplates\\\\\\", \\\\\\"oos:NotifyExecution\\\\\\", \\\\\\"oos:StartExecution\\\\\\"],\\\\n\\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n\\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"ram:PassRole\\\\\\"],\\\\n\\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n\\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"ros:CreateStack\\\\\\", \\\\\\"ros:GetStack\\\\\\", \\\\\\"ros:UpdateStack\\\\\\", \\\\\\"ros:ListStackEvents\\\\\\", \\\\\\"ros:ListStackResources\\\\\\", \\\\\\"ros:ListStackResources\\\\\\", \\\\\\"ros:DeleteStack\\\\\\", \\\\\\"ram:GetRole\\\\\\"],\\\\n\\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n\\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\",\\n \\"MissingPolicy\\": [\\n {\\n \\"ServiceName\\": \\"ecs\\",\\n \\"Resource\\": \\"*\\",\\n \\"Action\\": [\\n \\"CreateStack\\"\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '更新服务',
'description' => '需要上线的服务必须为已通过审核的服务。',
],
'GetService' => [
'summary' => '调用GetService查询指定服务的详细信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36954',
'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。'."\n"
."\n"
.'您可以通过调用[ListServices - 查询服务信息](~~2264368~~)获取服务ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'service-f8469d2d14eb40af****',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。'."\n"
."\n"
.'您可以通过调用[ListServices - 查询服务信息](~~2264368~~)获取服务版本。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '1',
],
],
[
'name' => 'ShowDetail',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '返回详细信息。',
'type' => 'array',
'items' => [
'description' => '返回详细信息。'."\n"
."\n"
.'取值:ServiceStatistic,服务统计信息。',
'type' => 'string',
'required' => false,
'example' => 'ServiceStatistic',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'FilterAliUid',
'in' => 'query',
'schema' => [
'description' => '是否要过滤AliUid。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- true:过滤AliUid。'."\n"
."\n"
.'- false:不过滤AliUid。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'SharedAccountType',
'in' => 'query',
'schema' => [
'description' => '服务共享类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- SharedAccount(默认值):普通共享类型。'."\n"
."\n"
.'- Resell:分销共享类型。',
'type' => 'string',
'required' => false,
'example' => 'SharedAccount',
],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例Id.',
'type' => 'string',
'required' => false,
'example' => 'si-56eb5823dxxxx',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => '服务名称。',
'type' => 'string',
'required' => false,
'example' => 'Wordpress社区版',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '服务状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Draft:草稿状态。'."\n"
."\n"
.'- Submitted:已提交审核。不允许修改。'."\n"
."\n"
.'- Approved:已通过审核。不允许修改,可以发布上线。'."\n"
."\n"
.'- Launching:服务上线中。'."\n"
."\n"
.'- Online:已上线。'."\n"
."\n"
.'- Offline:已下线。'."\n"
."\n"
.'- Beta:预发布状态。'."\n"
."\n"
.'- Creating:服务创建中。'."\n"
."\n"
.'- CreateFailed:服务创建失败。'."\n"
."\n"
.'- Updating:服务更新中。'."\n"
."\n"
.'- UpdateFailed:服务更新失败 。',
'type' => 'string',
'example' => 'Online',
],
'DeployMetadata' => [
'description' => '存储服务部署配置的信息。'."\n"
."\n"
.'存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用JSON String格式进行数据存储。',
'type' => 'string',
'example' => '{\\"TemplateConfigs\\":[{\\"Name\\":\\"模板1\\",\\"Url\\":\\"oss://computenest-test/template" '."\n"
.' + ".json?RegionId=cn-beijing\\",\\"PredefinedParameters\\":[{\\"Name\\":\\"低配版\\"," '."\n"
.' + "\\"Parameters\\":{\\"InstanceType\\":\\"ecs.g5.large\\",\\"DataDiskSize\\":40}},{\\"Name\\":\\"高配版\\"," '."\n"
.' + "\\"Parameters\\":{\\"InstanceType\\":\\"ecs.g5.large\\",\\"DataDiskSize\\":200}}]}]}',
],
'PublishTime' => [
'description' => '发布时间。',
'type' => 'string',
'example' => '2021-05-21T00:00:00Z',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9AC8E73E-88DE-52C2-A29B-531FC13A5604',
],
'Version' => [
'description' => '服务版本。',
'type' => 'string',
'example' => '1.0',
],
'DeployType' => [
'description' => '部署类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- ros:通过ROS部署。'."\n"
."\n"
.'- terraform:通过Terraform部署。'."\n"
."\n"
.'- spi:调用SPI部署。'."\n"
."\n"
.'- operation:代运维服务部署。'."\n"
."\n"
.'- container:通过容器部署。',
'type' => 'string',
'example' => 'ros',
],
'ServiceId' => [
'description' => '服务ID。',
'type' => 'string',
'example' => 'service-ca83ff3cb6b14dbc****',
],
'SupplierUrl' => [
'description' => '服务商地址。',
'type' => 'string',
'example' => 'http://example.com',
],
'ServiceProductUrl' => [
'description' => '产品页URL。',
'type' => 'string',
'example' => 'http://example2.com',
],
'ServiceType' => [
'description' => '服务类型。'."\n"
."\n"
.'取值:'."\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"
.'取值:'."\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-98f35660****.png',
],
'Name' => [
'description' => '服务名称。',
'type' => 'string',
'example' => 'B数据库',
],
'ShortDescription' => [
'description' => '服务概述。',
'type' => 'string',
'example' => 'B是A公司自主设计并研发的开源分布式的关系型数据库',
],
'LongDescriptionUrl' => [
'description' => '服务详细描述的地址。',
'type' => 'string',
'example' => 'https://example.com',
],
'Agreements' => [
'description' => '服务的协议文档信息。',
'type' => 'array',
'items' => [
'description' => '服务的协议文档信息。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '协议名称。',
'type' => 'string',
'example' => 'Name',
],
'Url' => [
'description' => '协议链接。',
'type' => 'string',
'example' => 'https://aliyun.com/xxxxxxxx.html',
],
],
],
],
'Softwares' => [
'description' => '服务中用到的软件信息。',
'type' => 'array',
'items' => [
'description' => '服务中用到的软件信息。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '软件名称。',
'type' => 'string',
'example' => 'MySQL',
],
'Version' => [
'description' => '软件版本。',
'type' => 'string',
'example' => '5.7',
],
],
],
],
],
],
],
'IsSupportOperated' => [
'description' => '是否代运维。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- true:开启。'."\n"
."\n"
.'- false:关闭。',
'type' => 'boolean',
'example' => 'false',
],
'PolicyNames' => [
'description' => '策略名称。'."\n"
."\n"
.'单个策略名称长度不超过128个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。',
'type' => 'string',
'example' => 'policyName1, policyName2',
],
'Duration' => [
'description' => '代运维时间。单位:秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '259200',
],
'Progress' => [
'description' => '服务实例的部署进度,单位:%。',
'type' => 'integer',
'format' => 'int64',
'example' => '90',
],
'StatusDetail' => [
'description' => '服务状态描述。',
'type' => 'string',
'example' => 'deploy successfully',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2021-05-22T00:00:00Z',
],
'ShareType' => [
'description' => '共享类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Public:公开的,正式部署和试用部署都不受限。'."\n"
."\n"
.'- Restricted:受限的,正式部署和试用部署都受限。'."\n"
."\n"
.'- OnlyFormalRestricted:仅正式部署受限。'."\n"
."\n"
.'- OnlyTrailRestricted:仅试用部署受限。'."\n"
."\n"
.'- Hidden:隐藏的,不可见且不可申请部署权限。',
'type' => 'string',
'example' => 'Public',
],
'AlarmMetadata' => [
'description' => '服务报警配置。',
'type' => 'string',
'example' => '{'."\n"
.' "TemplateUrl": "http://template.file.url",'."\n"
.' // 应用分组级别告警元数据'."\n"
.' "ApplicationGroups": ['."\n"
.' {'."\n"
.' "Name": "applicationGroup1",'."\n"
.' "TemplateUrl": "url1"'."\n"
.' },'."\n"
.' {'."\n"
.' "Name": "applicationGroup2",'."\n"
.' "TemplateUrl": "url2"'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
'UpgradeMetadata' => [
'description' => '升级元数据。',
'type' => 'string',
'example' => '{\\"SupportRollback\\":true,\\"SupportUpgradeFromVersions\\":[],\\"UpgradeComponents\\":[\\"Configuration\\"]}',
],
'VersionName' => [
'description' => '版本名称。',
'type' => 'string',
'example' => 'v1',
],
'PayFromType' => [
'description' => '付费来源。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- None:不付费。'."\n"
."\n"
.'- Marketplace:云市场付费。'."\n"
."\n"
.'- Custom:自定义付费。',
'type' => 'string',
'example' => 'None',
],
'Tags' => [
'description' => '服务标签。',
'type' => 'array',
'items' => [
'description' => '服务标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'key1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'value1',
],
],
],
],
'TrialDuration' => [
'description' => '试用时长。单位:天。',
'type' => 'integer',
'format' => 'int64',
'example' => '7',
],
'TrialType' => [
'description' => '试用类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Trial:支持试用。'."\n"
."\n"
.'- NotTrial:不支持试用。',
'type' => 'string',
'example' => 'Trial',
],
'TenantType' => [
'description' => '租户类型。'."\n"
."\n"
.'取值:'."\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\\":{}}}',
],
'TestStatus' => [
'description' => '测试状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- CONFIG_IS_NULL:测试配置不存在。'."\n"
."\n"
.'- SERVICE_TEST_SUCCEED:服务测试通过。'."\n"
."\n"
.'- SERVICE_TSET_DOING:服务测试尚未通过。',
'type' => 'string',
'example' => 'SERVICE_TEST_SUCCEED',
],
'ApprovalType' => [
'description' => '服务使用申请审批类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Manual:收到审批。'."\n"
."\n"
.'- AutoPass:自动通过。',
'type' => 'string',
'example' => 'Manual',
],
'RegistrationId' => [
'description' => '注册ID。',
'type' => 'string',
'example' => 'sr-1b4aabc1c9eb4109****',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-acfm2jfvb7b****',
],
'Permission' => [
'description' => '权限类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Deployable:可部署。'."\n"
."\n"
.'- Accessible:可访问。',
'type' => 'string',
'example' => 'Deployable',
],
'Statistic' => [
'description' => '统计信息。',
'type' => 'object',
'properties' => [
'AccumulativeInstanceCount' => [
'description' => '累计实例数。'."\n"
.'包含历史已删除的实例。',
'type' => 'integer',
'format' => 'int32',
'example' => '75',
],
'AccumulativeUserCount' => [
'description' => '累计用户数。'."\n"
.'包含历史用户。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'DeployedServiceInstanceCount' => [
'description' => '线上实例数。'."\n"
.'当前已成功部署的实例数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'DeployedUserCount' => [
'description' => '线上用户数。'."\n"
.'当前已成功部署的实例对应的用户数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'SubmittedUsageCount' => [
'description' => '待审核(Submitted状态)的服务申请个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'AccumulativePocAmount' => [
'description' => '试用累计消耗金额。单位:元。',
'type' => 'number',
'format' => 'double',
'example' => '80.35',
],
'AveragePocAmount' => [
'description' => '试用服务实例平均消耗金额。单位:元。',
'type' => 'number',
'format' => 'double',
'example' => '40.17',
],
'AveragePocUnitAmount' => [
'description' => '试用服务实例平均单位时间消耗金额。单位:元。',
'type' => 'number',
'format' => 'double',
'example' => '167.9',
],
'AveragePocDuration' => [
'description' => '试用服务实例平均时长。单位:时。',
'type' => 'number',
'format' => 'double',
'example' => '1',
],
],
],
'SourceServiceId' => [
'description' => '分销源服务ID。',
'type' => 'string',
'example' => 'service-70a3b15bb6264315****',
],
'SourceServiceVersion' => [
'description' => '分销源服务版本。',
'type' => 'string',
'example' => '1',
],
'SourceSupplierName' => [
'description' => '分销源服务商名称。',
'type' => 'string',
'example' => 'SourceSupplier',
],
'LogMetadata' => [
'description' => '应用日志配置。',
'type' => 'string',
'example' => '{'."\n"
.' "Logstores": ['."\n"
.' {'."\n"
.' "LogstoreName": "access-log",'."\n"
.' "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置'."\n"
.' "FilePattern": "access.log*" # 对容器不需要,在YAML中配置'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
'Resellable' => [
'description' => '是否支持分销。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- false:不支持。'."\n"
."\n"
.'- true:支持。',
'type' => 'boolean',
'example' => 'false',
],
'VirtualInternetService' => [
'description' => '是否是虚拟互联网服务。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- false:否。'."\n"
."\n"
.'- true:是。',
'type' => 'string',
'example' => 'false',
],
'ServiceDiscoverable' => [
'description' => '服务是否可发现。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- INVISIBLE:不可发现。'."\n"
."\n"
.'- DISCOVERABLE:可发现。',
'type' => 'string',
'example' => 'DISCOVERABLE',
],
'Categories' => [
'description' => '服务分类。',
'type' => 'string',
'example' => 'DevOps',
],
'ShareTypeStatus' => [
'description' => '服务共享状态。'."\n"
.'>该参数已弃用。>',
'type' => 'string',
'example' => '该参数已弃用。',
],
'ServiceAuditDocumentUrl' => [
'description' => '服务审核文件URL。',
'type' => 'string',
'example' => 'https://service-info-public.oss-cn-hangzhou.aliyuncs.com/169070753192****/service-document/be3382cd-e198-41a4-a697-f8707ec1****.docx',
],
'EntitySource' => [
'description' => '上报源。',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
'example' => 'ComputNest',
'description' => '上报源。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- ComputNest:计算巢上报。'."\n"
."\n"
.'- Custom:服务商上报。',
],
],
'CrossRegionConnectionStatus' => [
'description' => '商品模块绑定关系。',
'type' => 'string',
'example' => 'componesConfigs',
],
'VirtualInternetServiceId' => [
'description' => '虚拟互联网服务ID。',
'type' => 'string',
'example' => 'service-70a3b15bb6264345****',
],
'Commodity' => [
'description' => '商品规格。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Marketplace:云市场。'."\n"
."\n"
.'- Css:凌霄。',
'type' => 'string',
'example' => 'Marketplace',
],
'ChargeType' => [
'description' => '付费类型。'."\n"
."\n"
.'取值:'."\n"
.'- **PREPAY**(默认值):预付费,即包年包月。'."\n"
.'- **POSTPAY**:后付费,即按量付费。',
'type' => 'string',
'example' => 'PREPAY',
],
'Components' => [
'description' => '商品模块。',
'type' => 'array',
'items' => [
'description' => '商品模块。',
'type' => 'string',
'example' => 'YARN',
],
],
'Specifications' => [
'description' => '云市场规格详情。',
'type' => 'array',
'items' => [
'description' => '云市场规格详情。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '商品code。',
'type' => 'string',
'example' => 'cmjj00****',
],
'Name' => [
'description' => '规格名称。',
'type' => 'string',
'example' => 'specifications1',
],
'Times' => [
'description' => '允许购买的时长。单位:周或者年。',
'type' => 'array',
'items' => [
'description' => '允许购买的时长。单位:周或者年。',
'type' => 'string',
'example' => '3',
],
],
],
],
],
'MeteringEntities' => [
'description' => '计量项信息。',
'type' => 'array',
'items' => [
'description' => '计量项信息。',
'type' => 'object',
'properties' => [
'EntityId' => [
'description' => '计量项ID。',
'type' => 'string',
'example' => 'cmgj5682****-NetworkOut',
],
'Name' => [
'description' => '计量项属性名称。',
'type' => 'string',
'example' => 'spring-boot-demo',
],
],
],
],
'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' => '模板1',
],
'SpecificationName' => [
'description' => '套餐名称。',
'type' => 'string',
'example' => '按量付费',
],
'TrialType' => [
'description' => '试用类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Trial:支持试用。'."\n"
."\n"
.'- NotTrial:不支持试用。',
'type' => 'string',
'example' => 'NotTrial',
],
],
],
],
'MeteringEntityMappings' => [
'description' => '套餐与计量维度的绑定关系。',
'type' => 'array',
'items' => [
'description' => '套餐与计量维度的绑定关系。',
'type' => 'object',
'properties' => [
'EntityIds' => [
'description' => '计量项ID。',
'type' => 'string',
'example' => 'cmgj1596****-NetworkOut-2',
],
'TemplateName' => [
'description' => '模板名称。',
'type' => 'string',
'example' => '模板1',
],
'SpecificationName' => [
'description' => '套餐名称。',
'type' => 'string',
'example' => '按量付费套餐',
],
],
],
],
'MeteringEntityExtraInfos' => [
'description' => '计量项配置信息。',
'type' => 'array',
'items' => [
'description' => '计量项配置信息。',
'type' => 'object',
'properties' => [
'EntityId' => [
'description' => '计量项ID。',
'type' => 'string',
'example' => 'cmgj1596****-NetworkOut-2',
],
'Type' => [
'description' => '计量指标。',
'type' => 'string',
'example' => 'AvgPod',
],
'MetricName' => [
'description' => '计量指标名称。',
'type' => 'string',
'example' => 'NetworkLantency',
],
'Promql' => [
'description' => '自定义prometheus语句。',
'type' => 'string',
'example' => 'avg_over_time(count(kube_pod_info{namespace=\\"default\\"})[1h:1m])',
],
],
],
],
],
],
'CssMetadata' => [
'description' => '凌霄配置元数据。',
'type' => 'object',
'properties' => [
'ComponentsMappings' => [
'description' => '计费项映射。',
'type' => 'array',
'items' => [
'description' => '计费项映射。',
'type' => 'object',
'properties' => [
'Mappings' => [
'description' => '映射关系。',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
'example' => '{{DBInstanceStorage}}',
'description' => '映射关系。',
],
],
'TemplateName' => [
'description' => '模板名称。',
'type' => 'string',
'example' => '模板1',
],
],
],
],
'MeteringEntityMappings' => [
'description' => '套餐与计量维度的绑定关系。',
'type' => 'array',
'items' => [
'description' => '套餐与计量维度的绑定关系。',
'type' => 'object',
'properties' => [
'EntityIds' => [
'description' => '计量项ID。',
'type' => 'string',
'example' => 'cmgj0015****-Frequency-1',
],
'TemplateName' => [
'description' => '模板名称。',
'type' => 'string',
'example' => '模板1',
],
'SpecificationName' => [
'description' => '套餐名称。',
'type' => 'string',
'example' => '按量付费套餐',
],
],
],
],
'MeteringEntityExtraInfos' => [
'description' => '计量项配置信息。',
'type' => 'array',
'items' => [
'description' => '计量项配置信息。',
'type' => 'object',
'properties' => [
'EntityId' => [
'description' => '计量项ID。',
'type' => 'string',
'example' => 'cmgj0048****-Frequency-1',
],
'Type' => [
'description' => '计量指标。',
'type' => 'string',
'example' => 'ComputeNestPrometheus',
],
'MetricName' => [
'description' => '指标名称。',
'type' => 'string',
'example' => 'AvgMemory',
],
'Promql' => [
'description' => '自定义prometheus语句。',
'type' => 'string',
'example' => 'avg_over_time(count(kube_pod_info{namespace=\\"default\\"})[1h:1m])',
],
],
],
],
],
],
'CommodityCode' => [
'description' => '云市场商品code。',
'type' => 'string',
'example' => 'cmjj00xxxx',
],
'SaasBoostMetadata' => [
'description' => 'SaasBoost配置元数据。',
'type' => 'string',
'example' => '{'."\n"
.' "Enabled":false'."\n"
.' //公网交互地址'."\n"
.' "PublicAccessUrl":"https://example.com"'."\n"
.'}',
],
],
],
'BuildInfo' => [
'description' => '构建服务信息。',
'type' => 'string',
'example' => '{ "RepoUrl": "https://github.com/user/repo.git", "Brancn": "main"}',
],
'BuildParameters' => [
'description' => '构建服务参数。',
'type' => 'string',
'example' => '{ "ServiceTemplateId": "st-xxxxx"}',
],
'ComplianceMetadata' => [
'description' => '合规检查元数据。',
'type' => 'object',
'properties' => [
'CompliancePacks' => [
'description' => '选择的合规包。',
'type' => 'array',
'items' => [
'description' => '选择的合规包。',
'type' => 'string',
'example' => 'VpcDataRisk: VPC内数据安全风险合规包。',
],
],
],
],
'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' => '模板1',
],
'DocumentUrl' => [
'description' => '文档链接。',
'type' => 'string',
'example' => 'http://doc.com',
],
],
],
],
'SupportContacts' => [
'description' => '服务商联系方式',
'type' => 'array',
'items' => [
'description' => '服务商联系方式',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '联系方式的类型',
'type' => 'string',
'example' => 'Email',
],
'Value' => [
'description' => '联系方式',
'type' => 'string',
'example' => 'supplier@test.com',
],
],
],
],
'SecretKey' => [
'description' => '服务密钥。用于数字签名加密时使用。',
'type' => 'string',
'example' => '6cfc5d4649c54216****',
],
'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 \\"Status\\": \\"Online\\",\\n \\"DeployMetadata\\": \\"{\\\\\\\\\\\\\\"TemplateConfigs\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"模板1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://computenest-test/template\\\\\\" \\\\n + \\\\\\".json?RegionId=cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PredefinedParameters\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"低配版\\\\\\\\\\\\\\",\\\\\\" \\\\n + \\\\\\"\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"InstanceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ecs.g5.large\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DataDiskSize\\\\\\\\\\\\\\":40}},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"高配版\\\\\\\\\\\\\\",\\\\\\" \\\\n + \\\\\\"\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"InstanceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ecs.g5.large\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DataDiskSize\\\\\\\\\\\\\\":200}}]}]}\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"RequestId\\": \\"9AC8E73E-88DE-52C2-A29B-531FC13A5604\\",\\n \\"Version\\": \\"1.0\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-ca83ff3cb6b14dbc****\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceProductUrl\\": \\"http://example2.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-98f35660****.png\\",\\n \\"Name\\": \\"B数据库\\",\\n \\"ShortDescription\\": \\"B是A公司自主设计并研发的开源分布式的关系型数据库\\",\\n \\"LongDescriptionUrl\\": \\"https://example.com\\",\\n \\"Agreements\\": [\\n {\\n \\"Name\\": \\"Name\\",\\n \\"Url\\": \\"https://aliyun.com/xxxxxxxx.html\\"\\n }\\n ],\\n \\"Softwares\\": [\\n {\\n \\"Name\\": \\"MySQL\\",\\n \\"Version\\": \\"5.7\\"\\n }\\n ]\\n }\\n ],\\n \\"IsSupportOperated\\": false,\\n \\"PolicyNames\\": \\"policyName1, policyName2\\",\\n \\"Duration\\": 259200,\\n \\"Progress\\": 90,\\n \\"StatusDetail\\": \\"deploy successfully\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"UpdateTime\\": \\"2021-05-22T00:00:00Z\\",\\n \\"ShareType\\": \\"Public\\",\\n \\"AlarmMetadata\\": \\"{\\\\n \\\\\\"TemplateUrl\\\\\\": \\\\\\"http://template.file.url\\\\\\",\\\\n // 应用分组级别告警元数据\\\\n \\\\\\"ApplicationGroups\\\\\\": [\\\\n {\\\\n \\\\\\"Name\\\\\\": \\\\\\"applicationGroup1\\\\\\",\\\\n \\\\\\"TemplateUrl\\\\\\": \\\\\\"url1\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Name\\\\\\": \\\\\\"applicationGroup2\\\\\\",\\\\n \\\\\\"TemplateUrl\\\\\\": \\\\\\"url2\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"UpgradeMetadata\\": \\"{\\\\\\\\\\\\\\"SupportRollback\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"SupportUpgradeFromVersions\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"UpgradeComponents\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Configuration\\\\\\\\\\\\\\"]}\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"PayFromType\\": \\"None\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"TrialDuration\\": 7,\\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 \\"TestStatus\\": \\"SERVICE_TEST_SUCCEED\\",\\n \\"ApprovalType\\": \\"Manual\\",\\n \\"RegistrationId\\": \\"sr-1b4aabc1c9eb4109****\\",\\n \\"ResourceGroupId\\": \\"rg-acfm2jfvb7b****\\",\\n \\"Permission\\": \\"Deployable\\",\\n \\"Statistic\\": {\\n \\"AccumulativeInstanceCount\\": 75,\\n \\"AccumulativeUserCount\\": 60,\\n \\"DeployedServiceInstanceCount\\": 20,\\n \\"DeployedUserCount\\": 10,\\n \\"SubmittedUsageCount\\": 10,\\n \\"AccumulativePocAmount\\": 80.35,\\n \\"AveragePocAmount\\": 40.17,\\n \\"AveragePocUnitAmount\\": 167.9,\\n \\"AveragePocDuration\\": 1\\n },\\n \\"SourceServiceId\\": \\"service-70a3b15bb6264315****\\",\\n \\"SourceServiceVersion\\": \\"1\\",\\n \\"SourceSupplierName\\": \\"SourceSupplier\\",\\n \\"LogMetadata\\": \\"{\\\\n \\\\\\"Logstores\\\\\\": [\\\\n {\\\\n \\\\t\\\\\\"LogstoreName\\\\\\": \\\\\\"access-log\\\\\\",\\\\n \\\\t\\\\t\\\\\\"LogPath\\\\\\": \\\\\\"/home/admin/app/logs\\\\\\", # 对容器不需要,在YAML中配置\\\\n \\\\t\\\\t\\\\\\"FilePattern\\\\\\": \\\\\\"access.log*\\\\\\" # 对容器不需要,在YAML中配置\\\\n }\\\\n ]\\\\n}\\",\\n \\"Resellable\\": false,\\n \\"VirtualInternetService\\": \\"false\\",\\n \\"ServiceDiscoverable\\": \\"DISCOVERABLE\\",\\n \\"Categories\\": \\"DevOps\\",\\n \\"ShareTypeStatus\\": \\"该参数已弃用。\\",\\n \\"ServiceAuditDocumentUrl\\": \\"https://service-info-public.oss-cn-hangzhou.aliyuncs.com/169070753192****/service-document/be3382cd-e198-41a4-a697-f8707ec1****.docx\\",\\n \\"EntitySource\\": {\\n \\"key\\": \\"ComputNest\\"\\n },\\n \\"CrossRegionConnectionStatus\\": \\"componesConfigs\\",\\n \\"VirtualInternetServiceId\\": \\"service-70a3b15bb6264345****\\",\\n \\"Commodity\\": {\\n \\"Type\\": \\"Marketplace\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"Components\\": [\\n \\"YARN\\"\\n ],\\n \\"Specifications\\": [\\n {\\n \\"Code\\": \\"cmjj00****\\",\\n \\"Name\\": \\"specifications1\\",\\n \\"Times\\": [\\n \\"3\\"\\n ]\\n }\\n ],\\n \\"MeteringEntities\\": [\\n {\\n \\"EntityId\\": \\"cmgj5682****-NetworkOut\\",\\n \\"Name\\": \\"spring-boot-demo\\"\\n }\\n ],\\n \\"MarketplaceMetadata\\": {\\n \\"SpecificationMappings\\": [\\n {\\n \\"SpecificationCode\\": \\"cmjj00****\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"SpecificationName\\": \\"按量付费\\",\\n \\"TrialType\\": \\"NotTrial\\"\\n }\\n ],\\n \\"MeteringEntityMappings\\": [\\n {\\n \\"EntityIds\\": \\"cmgj1596****-NetworkOut-2\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"SpecificationName\\": \\"按量付费套餐\\"\\n }\\n ],\\n \\"MeteringEntityExtraInfos\\": [\\n {\\n \\"EntityId\\": \\"cmgj1596****-NetworkOut-2\\",\\n \\"Type\\": \\"AvgPod\\",\\n \\"MetricName\\": \\"NetworkLantency\\",\\n \\"Promql\\": \\"avg_over_time(count(kube_pod_info{namespace=\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\"})[1h:1m])\\"\\n }\\n ]\\n },\\n \\"CssMetadata\\": {\\n \\"ComponentsMappings\\": [\\n {\\n \\"Mappings\\": {\\n \\"key\\": \\"{{DBInstanceStorage}}\\"\\n },\\n \\"TemplateName\\": \\"模板1\\"\\n }\\n ],\\n \\"MeteringEntityMappings\\": [\\n {\\n \\"EntityIds\\": \\"cmgj0015****-Frequency-1\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"SpecificationName\\": \\"按量付费套餐\\"\\n }\\n ],\\n \\"MeteringEntityExtraInfos\\": [\\n {\\n \\"EntityId\\": \\"cmgj0048****-Frequency-1\\",\\n \\"Type\\": \\"ComputeNestPrometheus\\",\\n \\"MetricName\\": \\"AvgMemory\\",\\n \\"Promql\\": \\"avg_over_time(count(kube_pod_info{namespace=\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\"})[1h:1m])\\"\\n }\\n ]\\n },\\n \\"CommodityCode\\": \\"cmjj00xxxx\\",\\n \\"SaasBoostMetadata\\": \\"{\\\\n \\\\\\"Enabled\\\\\\":false\\\\n //公网交互地址\\\\n \\\\\\"PublicAccessUrl\\\\\\":\\\\\\"https://example.com\\\\\\"\\\\n}\\"\\n },\\n \\"BuildInfo\\": \\"{ \\\\\\"RepoUrl\\\\\\": \\\\\\"https://github.com/user/repo.git\\\\\\", \\\\\\"Brancn\\\\\\": \\\\\\"main\\\\\\"}\\",\\n \\"BuildParameters\\": \\"{ \\\\\\"ServiceTemplateId\\\\\\": \\\\\\"st-xxxxx\\\\\\"}\\",\\n \\"ComplianceMetadata\\": {\\n \\"CompliancePacks\\": [\\n \\"VpcDataRisk: VPC内数据安全风险合规包。\\"\\n ]\\n },\\n \\"ServiceDocumentInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"DocumentUrl\\": \\"http://doc.com\\"\\n }\\n ],\\n \\"SupportContacts\\": [\\n {\\n \\"Type\\": \\"Email\\",\\n \\"Value\\": \\"supplier@test.com\\"\\n }\\n ],\\n \\"SecretKey\\": \\"6cfc5d4649c54216****\\",\\n \\"ServiceLocaleConfigs\\": [\\n {\\n \\"OriginalValue\\": \\"Service Name\\\\n\\",\\n \\"ZhValue\\": \\"服务名称\\",\\n \\"EnValue\\": \\"Service Name\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务详细信息',
],
'ListServices' => [
'summary' => '通过指定地域ID、服务ID等参数,查询服务信息列表。例如,服务状态,服务版本,发布时间等信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36944',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'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' => '10',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
'type' => 'string',
'required' => false,
'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=',
],
],
[
'name' => 'AllVersions',
'in' => 'query',
'schema' => [
'description' => '返回服务的所有版本。默认值为false,对每个服务只返回默认版本。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-aekzkt5bu****',
],
],
[
'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' => 20,
],
'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' => 100,
],
],
[
'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,
],
],
],
'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',
],
'TotalCount' => [
'description' => '符合条件的记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'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',
],
'DefaultVersion' => [
'description' => '是否为默认版本。取值:'."\n"
."\n"
.'- false:不是默认版本。'."\n"
."\n"
.'- true:是默认版本。',
'type' => 'boolean',
'example' => 'true',
],
'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"
.'- spi:调用SPI部署。'."\n"
."\n"
.'- operation:代运维服务部署。'."\n"
."\n"
.'- container:通过容器部署。',
'type' => 'string',
'example' => 'ros',
],
'ServiceId' => [
'description' => '服务ID。',
'type' => 'string',
'example' => 'service-70a3b15bb62643****',
],
'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.example.oss.url',
],
'Name' => [
'description' => '服务名称。',
'type' => 'string',
'example' => 'B数据库',
],
'ShortDescription' => [
'description' => '服务概述。',
'type' => 'string',
'example' => 'B是A公司自主设计并研发的开源分布式的关系型数据库',
],
],
],
],
'CommodityCode' => [
'description' => '云市场商品code。',
'type' => 'string',
'example' => 'cmjj00****',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2021-05-21T00:00:00Z',
],
'ShareType' => [
'description' => '共享类型。可能的值:'."\n"
."\n"
.'- Public:公开的,正式部署和试用部署都不受限。'."\n"
."\n"
.'- Restricted:受限的,正式部署和试用部署都受限。'."\n"
."\n"
.'- OnlyFormalRestricted:仅正式部署受限。'."\n"
."\n"
.'- OnlyTrailRestricted:仅试用部署受限。'."\n"
."\n"
.'- Hidden:隐藏的,不可见且不可申请部署权限。',
'type' => 'string',
'example' => 'Public',
],
'ApprovalType' => [
'description' => '服务使用申请审批类型,可能的值:'."\n"
."\n"
.'- Manual:手动审批。'."\n"
."\n"
.'- AutoPass:自动通过。',
'type' => 'string',
'example' => 'AutoPass',
],
'VersionName' => [
'description' => '服务商自定义版本名称。',
'type' => 'string',
'example' => 'v2.0.0',
],
'Tags' => [
'description' => '服务标签。',
'type' => 'array',
'items' => [
'description' => '服务标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'key1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'value1',
],
],
],
],
'ArtifactId' => [
'description' => '部署物ID。',
'type' => 'string',
'example' => 'artifact-21ca53ac16a643****',
],
'ArtifactVersion' => [
'description' => '部署物版本。',
'type' => 'string',
'example' => 'draft',
],
'SourceImage' => [
'description' => '源镜像。',
'type' => 'string',
'example' => 'centos_7',
],
'RelationType' => [
'description' => '部署物关联类型。可能的值:'."\n"
."\n"
.'- ServiceDeployment:服务部署。'."\n"
."\n"
.'- ServiceUpgrade:服务升级。',
'type' => 'string',
'example' => 'ServiceDeployment',
],
'TrialType' => [
'description' => '试用类型。可选值:'."\n"
."\n"
.'- Trial:支持试用。'."\n"
."\n"
.'- NotTrial:不支持试用。',
'type' => 'string',
'example' => 'Trial',
],
'TenantType' => [
'description' => '托管版服务的租户类型。可能的值:'."\n"
."\n"
.'- SingleTenant:单租户。'."\n"
."\n"
.'- MultiTenant:多租户。',
'type' => 'string',
'example' => 'SingleTenant',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-aekz5b555****',
],
'SourceServiceId' => [
'description' => '分销源服务ID。',
'type' => 'string',
'example' => 'service-70a3b15bb62643****',
],
'SourceServiceVersion' => [
'description' => '分销源服务版本。',
'type' => 'string',
'example' => '1',
],
'SourceSupplierName' => [
'description' => '分销源服务商名称。',
'type' => 'string',
'example' => 'SourceSupplier',
],
'ResellServiceId' => [
'description' => '分销服务ID。',
'type' => 'string',
'example' => 'service-70a3b15bb62643****',
],
'LatestResellSourceServiceVersion' => [
'description' => '最新的分销源服务版本。',
'type' => 'string',
'example' => '1',
],
'ResellApplyStatus' => [
'description' => '服务的分销授权状态。可能的值:'."\n"
."\n"
.'- CanApply:可申请。'."\n"
."\n"
.'- Applied:已申请。'."\n"
."\n"
.'- Approved:已通过。',
'type' => 'string',
'example' => 'CanApply',
],
'VirtualInternetService' => [
'description' => '是否是虚拟互联网服务。可能的值:'."\n"
."\n"
.'- false:否。'."\n"
."\n"
.'- true:是。',
'type' => 'string',
'example' => 'false',
],
'Categories' => [
'description' => '服务分类。',
'type' => 'string',
'example' => 'OpenSource',
],
'ServiceDiscoverable' => [
'description' => '服务是否可发现。可能的值:'."\n"
."\n"
.'- INVISIBLE:不可发现。'."\n"
."\n"
.'- DISCOVERABLE:可发现。',
'type' => 'string',
'example' => 'INVISIBLE',
],
'HasDraft' => [
'description' => '当前服务是否有Draft版本。可能的值:'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false:否。',
'type' => 'boolean',
'example' => 'true',
],
'HasBeta' => [
'description' => '当前服务是否有Beta版本。可能的值:'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false:否。',
'type' => 'boolean',
'example' => 'true',
],
'BuildInfo' => [
'description' => '构建服务信息。',
'type' => 'string',
'example' => '{ "RepoUrl": "https://github.com/user/example.git", "Brancn": "main"}',
],
'Commodity' => [
'description' => '商品规格。',
'type' => 'object',
'properties' => [
'CommodityCode' => [
'description' => '商品code。',
'type' => 'string',
'example' => 'cmjj00****',
],
'Type' => [
'description' => '类型。可能的值:'."\n"
."\n"
.'- Marketplace:云市场。'."\n"
."\n"
.'- Css:凌霄。'."\n"
."\n"
.'- SaasBoost:Saas Boost。',
'type' => 'string',
'example' => 'Marketplace',
],
'SaasBoostMetadata' => [
'description' => 'SaasBoost配置元数据。',
'type' => 'string',
'example' => '{'."\n"
.' //开启/关闭SaaS Boost绑定'."\n"
.' "Enabled":true/false,默认为false'."\n"
.' //公网交互地址'."\n"
.' "PublicAccessUrl":"https://example.com"'."\n"
.'}',
],
],
],
'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",
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 1,\\n \\"Services\\": [\\n {\\n \\"Status\\": \\"Online\\",\\n \\"DefaultVersion\\": true,\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Version\\": \\"1.0\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-70a3b15bb62643****\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"SupplierName\\": \\"A有限公司\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"http://img.example.oss.url\\",\\n \\"Name\\": \\"B数据库\\",\\n \\"ShortDescription\\": \\"B是A公司自主设计并研发的开源分布式的关系型数据库\\"\\n }\\n ],\\n \\"CommodityCode\\": \\"cmjj00****\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"UpdateTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"ShareType\\": \\"Public\\",\\n \\"ApprovalType\\": \\"AutoPass\\",\\n \\"VersionName\\": \\"v2.0.0\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ArtifactId\\": \\"artifact-21ca53ac16a643****\\",\\n \\"ArtifactVersion\\": \\"draft\\",\\n \\"SourceImage\\": \\"centos_7\\",\\n \\"RelationType\\": \\"ServiceDeployment\\",\\n \\"TrialType\\": \\"Trial\\",\\n \\"TenantType\\": \\"SingleTenant\\",\\n \\"ResourceGroupId\\": \\"rg-aekz5b555****\\",\\n \\"SourceServiceId\\": \\"service-70a3b15bb62643****\\",\\n \\"SourceServiceVersion\\": \\"1\\",\\n \\"SourceSupplierName\\": \\"SourceSupplier\\",\\n \\"ResellServiceId\\": \\"service-70a3b15bb62643****\\",\\n \\"LatestResellSourceServiceVersion\\": \\"1\\",\\n \\"ResellApplyStatus\\": \\"CanApply\\",\\n \\"VirtualInternetService\\": \\"false\\",\\n \\"Categories\\": \\"OpenSource\\",\\n \\"ServiceDiscoverable\\": \\"INVISIBLE\\",\\n \\"HasDraft\\": true,\\n \\"HasBeta\\": true,\\n \\"BuildInfo\\": \\"{ \\\\\\"RepoUrl\\\\\\": \\\\\\"https://github.com/user/example.git\\\\\\", \\\\\\"Brancn\\\\\\": \\\\\\"main\\\\\\"}\\",\\n \\"Commodity\\": {\\n \\"CommodityCode\\": \\"cmjj00****\\",\\n \\"Type\\": \\"Marketplace\\",\\n \\"SaasBoostMetadata\\": \\"{\\\\n //开启/关闭SaaS Boost绑定\\\\n \\\\\\"Enabled\\\\\\":true/false,默认为false\\\\n //公网交互地址\\\\n \\\\\\"PublicAccessUrl\\\\\\":\\\\\\"https://example.com\\\\\\"\\\\n}\\"\\n },\\n \\"ServiceLocaleConfigs\\": [\\n {\\n \\"OriginalValue\\": \\"Service Name\\\\n\\",\\n \\"ZhValue\\": \\"服务名称\\",\\n \\"EnValue\\": \\"Service Name\\\\n\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务信息',
],
'PreLaunchService' => [
'summary' => '预发布服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '201480',
'abilityTreeNodes' => [
'FEATUREcomputenestB2MIVU',
],
'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,
'docRequired' => true,
'example' => 'service-f7024a22ea5149xxxxxx',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
],
'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' => '对服务进行预发布操作',
],
'RegisterService' => [
'summary' => '注册部署物',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36948',
'abilityTreeNodes' => [
'FEATUREcomputenestB2MIVU',
],
'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,
'docRequired' => true,
'example' => 'service-f7024a22ea5149xxxxxx',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RegistrationId' => [
'description' => '注册ID。',
'type' => 'string',
'example' => 'sr-72dd5071e90c40xxxxxx',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A361BA9E-2713-52C8-AFFC-C26E5180456E',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RegistrationId\\": \\"sr-72dd5071e90c40xxxxxx\\",\\n \\"RequestId\\": \\"A361BA9E-2713-52C8-AFFC-C26E5180456E\\"\\n}","type":"json"}]',
'title' => '注册服务',
],
'LaunchService' => [
'summary' => '调用LaunchService上线服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36951',
'abilityTreeNodes' => [
'FEATUREcomputenestB2MIVU',
],
'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,
'docRequired' => true,
'example' => 'service-0e6fca6a51a544xxxxxx',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1.0',
],
],
[
'name' => 'Categories',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务分类。',
'type' => 'array',
'items' => [
'description' => '服务分类名称',
'type' => 'string',
'required' => false,
'example' => 'DevOps',
],
'required' => false,
'docRequired' => false,
'maxItems' => 100,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'Recommend',
'in' => 'query',
'schema' => [
'description' => '是否设置为推荐服务发布到服务目录。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C',
],
'Version' => [
'description' => '服务版本。',
'type' => 'string',
'example' => '1.0',
],
'ServiceLaunchResultType' => [
'description' => '服务上线的类型。可选值:'."\n"
."\n"
.'- PublishNewVersion: 新版本上线'."\n"
.'- PublishOfflineVersion: 已下线版本重新上线'."\n"
.'- UpdateLatestVersion: 更新线上最新版本',
'type' => 'string',
'example' => 'PublishNewVersion',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"Version\\": \\"1.0\\",\\n \\"ServiceLaunchResultType\\": \\"PublishNewVersion\\"\\n}","type":"json"}]',
'title' => '上线服务',
'description' => '需要上线的服务必须为已通过审核的服务。',
],
'GetServiceProvisions' => [
'summary' => '查询服务开通状态和服务角色信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'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-20b8a396048346xxxxxx',
],
],
[
'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\\"}',
],
],
],
'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' => 'DB1FA13E-1087-5654-84D5-58A0ACAD1B18',
],
'ServiceProvisions' => [
'description' => '服务详情。',
'type' => 'array',
'items' => [
'description' => '服务详情。',
'type' => 'object',
'properties' => [
'ServiceName' => [
'description' => '服务名称。',
'type' => 'string',
'example' => 'db',
],
'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' => 'AliyunServiceRole',
],
'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' => 'GetServiceProvisions',
],
'ApiProductId' => [
'description' => 'API所属产品ID。',
'type' => 'string',
'example' => 'ComputeNest',
],
'ApiType' => [
'description' => 'API类型。'."\n"
.'可能的值:'."\n"
."\n"
.'- Open:开放API。'."\n"
."\n"
.'- Inner:内部API。',
'type' => 'string',
'example' => 'Open',
],
'Parameters' => [
'description' => 'API参数信息。${变量名}表示动态参数,目前支持:${RegionId} 地域。',
'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取值为Unknown时,返回该参数。',
'type' => 'string',
'example' => 'resource(Eip) import info missing',
],
'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"
.'- Enabled:已开通。'."\n"
.'- Disabled:未开通。',
'type' => 'string',
'example' => 'Disabled',
],
'EnableURL' => [
'description' => '商品开通链接。',
'type' => 'string',
'example' => 'https://common-buy.aliyun.com/?commodityCode=acs_postpaid_public_cn'."\n",
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB1FA13E-1087-5654-84D5-58A0ACAD1B18\\",\\n \\"ServiceProvisions\\": [\\n {\\n \\"ServiceName\\": \\"db\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"AutoEnableService\\": true,\\n \\"RoleProvision\\": {\\n \\"Roles\\": [\\n {\\n \\"RoleName\\": \\"AliyunServiceRole\\",\\n \\"Created\\": true,\\n \\"Function\\": \\"Default\\",\\n \\"ApiForCreation\\": {\\n \\"ApiName\\": \\"GetServiceProvisions\\",\\n \\"ApiProductId\\": \\"ComputeNest\\",\\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\\": \\"resource(Eip) import info missing\\",\\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 ]\\n}","type":"json"}]',
'title' => '查询服务开通状态和服务角色信息',
],
'GetServiceTemplateParameterConstraints' => [
'summary' => '查询ROS模板参数限定值。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136396',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'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-1c11f365190c44xxxxxx',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => false,
'example' => 'draft',
],
],
[
'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' => '参数名称。',
'type' => 'string',
'required' => false,
'example' => 'PayType',
],
'ParameterValue' => [
'description' => '参数值。',
'type' => 'string',
'required' => false,
'example' => 'PostPaid',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'DeployRegionId',
'in' => 'query',
'schema' => [
'description' => '部署地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-huhehaote',
],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例ID。',
'type' => 'string',
'required' => false,
'example' => 'si-d6ab3a63ccbb4b17****',
],
],
[
'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' => 'C81C0732-DEBC-559C-B563-7EB2BEB21088',
],
'ParameterConstraints' => [
'description' => '参数信息。',
'type' => 'array',
'items' => [
'description' => '参数信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '参数的类型。',
'type' => 'string',
'example' => 'String',
],
'AllowedValues' => [
'description' => '参数的取值。',
'type' => 'array',
'items' => [
'description' => '参数的取值。',
'type' => 'string',
'example' => '"ecs.hfr6.16xlarge"',
],
],
'AssociationParameterNames' => [
'description' => '关联参数列表。',
'type' => 'array',
'items' => [
'description' => '关联参数列表。',
'type' => 'string',
'example' => '"ZoneId1",'."\n"
.' "VSwitchId1"',
],
],
'ParameterKey' => [
'description' => '参数的名称。',
'type' => 'string',
'example' => 'PayType',
],
'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' => 'none',
],
'OriginalConstraints' => [
'description' => '原始约束信息。',
'type' => 'array',
'items' => [
'description' => '原始约束信息。',
'type' => 'object',
'properties' => [
'AllowedValues' => [
'description' => '参数的取值。',
'type' => 'array',
'items' => [
'description' => '参数的取值。',
'type' => 'string',
'example' => '"ecs.hfr6.16xlarge"',
],
],
'PropertyName' => [
'description' => '属性名称。',
'type' => 'string',
'example' => 'lnch_Source',
],
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'i-8vb0smn1lf6g77md****',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'serviceinstance',
],
],
],
],
],
],
],
'FamilyConstraints' => [
'description' => '套餐族约束。',
'type' => 'array',
'items' => [
'description' => '套餐族约束。',
'type' => 'string',
'example' => '[]',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C81C0732-DEBC-559C-B563-7EB2BEB21088\\",\\n \\"ParameterConstraints\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"AllowedValues\\": [\\n \\"\\\\\\"ecs.hfr6.16xlarge\\\\\\"\\"\\n ],\\n \\"AssociationParameterNames\\": [\\n \\"\\\\\\"ZoneId1\\\\\\",\\\\n \\\\\\"VSwitchId1\\\\\\"\\"\\n ],\\n \\"ParameterKey\\": \\"PayType\\",\\n \\"Behavior\\": \\"NoLimit\\",\\n \\"BehaviorReason\\": \\"none\\",\\n \\"OriginalConstraints\\": [\\n {\\n \\"AllowedValues\\": [\\n \\"\\\\\\"ecs.hfr6.16xlarge\\\\\\"\\"\\n ],\\n \\"PropertyName\\": \\"lnch_Source\\",\\n \\"ResourceName\\": \\"i-8vb0smn1lf6g77md****\\",\\n \\"ResourceType\\": \\"serviceinstance\\"\\n }\\n ]\\n }\\n ],\\n \\"FamilyConstraints\\": [\\n \\"[]\\"\\n ]\\n}","type":"json"}]',
'title' => '查询ROS模板参数限制信息',
],
'GetServiceEstimateCost' => [
'summary' => '查询创建服务实例的预估价格。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '137755',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-wulanchabu',
],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'example' => 'service-16fbd358d75e49xxxxxx',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => false,
'example' => 'draft',
],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称。',
'type' => 'string',
'required' => false,
'example' => 'Custom_Image_Ecs',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '部署服务实例输入的参数。',
'type' => 'object',
'required' => false,
'example' => '{\\"PayType\\":\\"PostPaid\\",\\"InstancePassword\\":\\"xxxxxxxxxx\\",\\"EcsInstanceType\\":\\"ecs.g6.large\\",\\"VSwitchId\\":\\"vsw-0jlueyydpuekoxxxxxxxx\\",\\"VpcId\\":\\"vpc-0jlps6mjbgvpqxxxxxxxx\\",\\"ZoneId\\":\\"cn-wulanchabu-a\\",\\"Enable\\":false,\\"RegionId\\":\\"cn-wulanchabu\\"}',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => 'mRdxWuW2ts',
],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例ID。',
'type' => 'string',
'required' => false,
'example' => 'si-d6ab3a63ccbb4b17****',
],
],
[
'name' => 'SpecificationName',
'in' => 'query',
'schema' => [
'description' => '套餐名称。',
'type' => 'string',
'required' => false,
'example' => '套餐一',
],
],
[
'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' => 'Month',
],
'PayPeriod' => [
'description' => '购买时长。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
'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' => 'E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C',
],
'Resources' => [
'description' => '资源列表。',
'type' => 'object',
'example' => '{'."\n"
.' "ECSInstances":{'."\n"
.' "Type":"ALIYUN::ECS::InstanceGroup",'."\n"
.' "Success":true,'."\n"
.' "Result":{'."\n"
.' "Order":{'."\n"
.' "Currency":"CNY",'."\n"
.' "RuleIds":['."\n"
.' 1752723'."\n"
.' ],'."\n"
.' "DetailInfos":{'."\n"
.' "ResourcePriceModel":['."\n"
.' {'."\n"
.' "Resource":"bandwidth",'."\n"
.' "TradeAmount":0.0,'."\n"
.' "SubRuleIds":[],'."\n"
.' "OriginalAmount":0.0,'."\n"
.' "DiscountAmount":0.0'."\n"
.' },'."\n"
.' {'."\n"
.' "Resource":"image",'."\n"
.' "TradeAmount":0.0,'."\n"
.' "SubRuleIds":[],'."\n"
.' "OriginalAmount":0.0,'."\n"
.' "DiscountAmount":0.0'."\n"
.' },'."\n"
.' {'."\n"
.' "Resource":"instanceType",'."\n"
.' "TradeAmount":0.006966,'."\n"
.' "SubRuleIds":[],'."\n"
.' "OriginalAmount":0.45,'."\n"
.' "DiscountAmount":0.443034'."\n"
.' },'."\n"
.' {'."\n"
.' "Resource":"systemDisk",'."\n"
.' "TradeAmount":0.000867,'."\n"
.' "SubRuleIds":[],'."\n"
.' "OriginalAmount":0.056,'."\n"
.' "DiscountAmount":0.055133'."\n"
.' },'."\n"
.' {'."\n"
.' "Resource":"dataDisk",'."\n"
.' "TradeAmount":0.002167,'."\n"
.' "SubRuleIds":[],'."\n"
.' "OriginalAmount":0.14,'."\n"
.' "DiscountAmount":0.137833'."\n"
.' }'."\n"
.' ]'."\n"
.' }',
],
'Commodity' => [
'description' => '云市场购买订单时间信息。',
'type' => 'object',
'example' => '{\\"PayPeriodUnit\\":Month,\\"PayPeriod\\":1}',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C\\",\\n \\"Resources\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Commodity\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
'title' => '查询创建服务实例的预估价格',
],
'WithdrawService' => [
'summary' => '下线服务版本',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '36953',
'abilityTreeNodes' => [
'FEATUREcomputenestB2MIVU',
],
'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,
'docRequired' => true,
'example' => 'service-0e6fca6a51a544xxxxxx',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1.0',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '788E7CP0EN9D51P',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'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' => '下线服务版本',
],
'GenerateServicePolicy' => [
'summary' => '调用GenerateServicePolicy创建服务实例前查询缺少的权限策略。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'service-6c20f0f8085645xxxxxx',
],
],
[
'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' => '1',
],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称。',
'type' => 'string',
'required' => false,
'example' => '模板1',
],
],
[
'name' => 'TrialType',
'in' => 'query',
'schema' => [
'description' => '试用类型。可选值:'."\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"
."\n"
.'- UpdateServiceInstance:升级服务实例。'."\n"
."\n"
.'- DeleteServiceInstance :删除服务实例。',
'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' => '创建服务实例前校验所需的权限',
],
'CancelServiceRegistration' => [
'summary' => '取消服务审核申请',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36945',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'RegistrationId',
'in' => 'query',
'schema' => [
'description' => '服务审核申请ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sr-540930183f93xxxxxx',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU=',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4A145D8-6F6C-532A-9001-9730CDA27578',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4A145D8-6F6C-532A-9001-9730CDA27578\\"\\n}","type":"json"}]',
'title' => '取消服务审核申请',
'description' => '只有已提交状态的服务审核申请支持取消。',
],
'ListServiceRegistrations' => [
'summary' => '查询服务审核申请',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36946',
'abilityTreeNodes' => [
'FEATUREcomputenestB2MIVU',
],
'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' => '10',
],
],
[
'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' => '过滤器值。',
'type' => 'string',
'required' => false,
'example' => 'Rejected',
],
'required' => false,
'maxItems' => 20,
],
'Name' => [
'description' => '过滤字段名称。可选值:'."\n"
."\n"
.'- ServiceId:服务ID。'."\n"
."\n"
.'- RegistrationId:审核申请ID。'."\n"
."\n"
.'- Status:服务状态。包含Submitted(已提交)、Approved(已通过)、Rejected(已拒绝)、Canceled(已取消)和Executed(已执行)。',
'type' => 'string',
'required' => false,
'example' => 'Canceled',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'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',
],
'TotalCount' => [
'description' => '符合条件的记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'ServiceRegistrations' => [
'description' => '服务审核申请信息。',
'type' => 'array',
'items' => [
'description' => '服务审核申请信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '审核申请状态。可能值:'."\n"
."\n"
.'- Submitted:已提交。'."\n"
."\n"
.'- Approved:已通过。'."\n"
."\n"
.'- Rejected:已拒绝。'."\n"
."\n"
.'- Canceled:已取消。'."\n"
."\n"
.'- Executed:已执行。',
'type' => 'string',
'example' => 'Rejected',
],
'RegistrationId' => [
'description' => '审核申请ID。',
'type' => 'string',
'example' => 'sr-001',
],
'FinishTime' => [
'description' => '结束时间。',
'type' => 'string',
'example' => '2021-05-23T00:00:00Z',
],
'Comment' => [
'description' => '审核意见。',
'type' => 'string',
'example' => 'some info is missing',
],
'ServiceId' => [
'description' => '服务ID。',
'type' => 'string',
'example' => 'service-f4c0026a254bxxxxxxxx',
],
'SubmitTime' => [
'description' => '申请提交时间。',
'type' => 'string',
'example' => '2021-05-22T00:00:00Z',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 20,\\n \\"ServiceRegistrations\\": [\\n {\\n \\"Status\\": \\"Rejected\\",\\n \\"RegistrationId\\": \\"sr-001\\",\\n \\"FinishTime\\": \\"2021-05-23T00:00:00Z\\",\\n \\"Comment\\": \\"some info is missing\\",\\n \\"ServiceId\\": \\"service-f4c0026a254bxxxxxxxx\\",\\n \\"SubmitTime\\": \\"2021-05-22T00:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务审核申请',
],
'ListServiceInstanceUpgradeHistory' => [
'summary' => '调用ListServiceInstanceUpgradeHistory查询服务实例的升级历史',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'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' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=',
],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例ID。',
'type' => 'string',
'required' => true,
'example' => 'si-0e6fca6a51a54420****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一个查询开始token。',
'type' => 'string',
'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '86CAC31E-3527-562C-869F-347E931C9B25',
],
'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'."\n",
],
'Type' => [
'description' => '升级类型。'."\n"
.'- Upgrade 升级'."\n"
.'- Rollback 回滚',
'type' => 'string',
'example' => 'Upgrade'."\n",
],
'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'."\n"
."\n",
],
'Results' => [
'description' => '升级结果。',
'type' => 'string',
'example' => '{\\"PreUpgradeExecutionId\\":\\"exec-123\\"}'."\n",
],
'StartTime' => [
'description' => '升级开始时间。',
'type' => 'string',
'example' => '2022-04-26T08:09:51Z'."\n",
],
'EndTime' => [
'description' => '升级结束时间。',
'type' => 'string',
'example' => '2022-04-26T09:09:51Z'."\n",
],
],
],
],
'TotalCount' => [
'description' => '结果总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2'."\n",
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=\\",\\n \\"RequestId\\": \\"86CAC31E-3527-562C-869F-347E931C9B25\\",\\n \\"MaxResults\\": 20,\\n \\"UpgradeHistory\\": [\\n {\\n \\"UpgradeHistoryId\\": \\"exec-123\\\\n\\",\\n \\"Type\\": \\"Upgrade\\\\n\\",\\n \\"FromVersion\\": \\"1\\",\\n \\"ToVersion\\": \\"3\\",\\n \\"Status\\": \\"UpgradeFailed\\\\n\\\\n\\",\\n \\"Results\\": \\"{\\\\\\\\\\\\\\"PreUpgradeExecutionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec-123\\\\\\\\\\\\\\"}\\\\n\\",\\n \\"StartTime\\": \\"2022-04-26T08:09:51Z\\\\n\\",\\n \\"EndTime\\": \\"2022-04-26T09:09:51Z\\\\n\\"\\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' => '162314',
'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。'."\n"
."\n"
.'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'si-3a8f9a75da074f52b969',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
],
'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"
.'- UpgradeRollbacking 回滚中'."\n"
."\n"
.'- Deleting:删除中'."\n"
."\n"
.'- Deleted:已删除'."\n"
."\n"
.'- DeletedFailed:删除失败',
'type' => 'string',
'example' => 'UpgradeRollbacking',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'EE9EF87D-46F8-5AF6-9A65-6B034E204136',
],
'ServiceInstanceId' => [
'description' => '服务实例ID。',
'type' => 'string',
'example' => 'si-5289e1d6d0c14397881d',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"UpgradeRollbacking\\",\\n \\"RequestId\\": \\"EE9EF87D-46F8-5AF6-9A65-6B034E204136\\",\\n \\"ServiceInstanceId\\": \\"si-5289e1d6d0c14397881d\\"\\n}","type":"json"}]',
'title' => '回滚服务实例',
],
'CreateServiceInstance' => [
'summary' => '通过指定地域ID、服务ID、服务版本等参数,创建并部署服务实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcomputenestVIKWP9',
'FEATUREcomputenestVUFVAC',
],
'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' => true,
'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' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称,服务支持多模板时需要指定模板名称。',
'type' => 'string',
'required' => false,
'example' => '模板1',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-aekzuqyxxxxxx',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'string',
'required' => false,
'example' => '1563457855xxxxxx',
],
],
[
'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' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '服务实例的释放时间。'."\n"
."\n"
.'> 仅支持托管版场景中,服务商对自己的服务实例设置该参数。',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2023-12-12T03:13:05Z',
],
],
],
'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****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Created\\",\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D****\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\"\\n}","type":"json"}]',
'title' => '创建并部署服务实例',
],
'DeleteServiceInstances' => [
'summary' => '通过指定地域ID、服务ID,删除服务实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '136232',
'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' => 'DB140E67-D75F-5585-946E-41D8DC8F4E00',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'asynchronous',
'callback' => 'ComputeNestSupplier::2021-05-21::GetServiceInstance',
'callbackInterval' => 2000,
'maxCallbackTimes' => 500,
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB140E67-D75F-5585-946E-41D8DC8F4E00\\"\\n}","type":"json"}]',
'title' => '删除服务实例',
],
'UpdateServiceInstanceSpec' => [
'summary' => '变配服务实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '163731',
'abilityTreeNodes' => [
'FEATUREcomputenest7EAOIM',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例ID。',
'type' => 'string',
'required' => false,
'example' => 'si-0e6fca6a51a54420****',
],
],
[
'name' => 'PredefinedParametersName',
'in' => 'query',
'schema' => [
'description' => '套餐名称。',
'type' => 'string',
'required' => false,
'example' => '套餐一',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '服务实例配置参数。',
'type' => 'object',
'required' => false,
'example' => '{\\"EcsInstanceParameter\\":\\"4vCPU 8GiB\\",\\"ZoneId\\":\\"cn-heyuan-a\\",\\"SystemDiskSize\\":50,\\"DataDiskSize\\":150,\\"InternetMaxBandwidthOut\\":2,\\"RegionId\\":\\"cn-heyuan\\"}',
],
],
[
'name' => 'OperationName',
'in' => 'query',
'schema' => [
'description' => '变配操作名称。',
'type' => 'string',
'required' => false,
'example' => '套餐变配',
],
],
[
'name' => 'EnableUserPrometheus',
'in' => 'query',
'schema' => [
'description' => '用户侧是否启用Prometheus。可选值:'."\n"
."\n"
.'- true:启用。'."\n"
."\n"
.'- false:不启用。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DF0F666F-FBBC-55C3-A368-C955DE7B4839',
],
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '2306175xxxxxxxx',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF0F666F-FBBC-55C3-A368-C955DE7B4839\\",\\n \\"OrderId\\": \\"2306175xxxxxxxx\\"\\n}","type":"json"}]',
'title' => '变配服务实例',
],
'UpdateServiceInstanceAttribute' => [
'summary' => '更新服务实例的属性',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '142602',
'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。',
'type' => 'string',
'required' => true,
'example' => 'si-3df88e962cdexxxxxxxx',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '服务实例到期时间。',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2023-12-25T02:28:40Z',
],
],
[
'name' => 'LicenseData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '许可证数据',
'type' => 'object',
'properties' => [
'CustomData' => [
'description' => '自定义元数据',
'type' => 'string',
'required' => false,
'example' => '{"Test"}',
],
'ResponseInfo' => [
'description' => '模拟返回值信息。',
'type' => 'object',
'properties' => [
'UpdateResponse' => [
'description' => '是否修改返回值。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'ErrorCode' => [
'description' => '如果希望模拟返回错误信息,需要填写错误码。',
'type' => 'string',
'required' => false,
'example' => 'EntityNotExist.Service',
],
'ErrorMessage' => [
'description' => '如果希望模拟返回错误信息,需要填写错误信息。',
'type' => 'string',
'required' => false,
'example' => 'The provided parameter "ServiceId" is invalid.',
],
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'Reason',
'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' => '0CB2E0A9-B4DF-5C16-86AD-C511C483144B',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NeedManualApproval',
'errorMessage' => 'Manual approval is required for the extension request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0CB2E0A9-B4DF-5C16-86AD-C511C483144B\\"\\n}","type":"json"}]',
'title' => '更新服务实例属性',
],
'ModifyServiceInstanceResources' => [
'summary' => '修改服务实例的资源信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例ID。',
'type' => 'string',
'required' => true,
'example' => 'si-d8a0cc2a1ee04dce****',
],
],
[
'name' => 'ServiceInstanceResourcesAction',
'in' => 'query',
'schema' => [
'description' => '服务实例资源的操作类型。可能的值:'."\n"
."\n"
.'- Import:导入。'."\n"
."\n"
.'- UnImport:取消导入。',
'type' => 'string',
'required' => false,
'example' => 'Import',
],
],
[
'name' => 'Resources',
'in' => 'query',
'schema' => [
'description' => '导入的资源。',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "RegionId": "cn-hangzhou",'."\n"
.' "Type": "ResourceIds",'."\n"
.' "ResourceIds": {'."\n"
.' "ALIYUN::ECS::INSTANCE": ["i-xxx", "i-yyy"],'."\n"
.' "ALIYUN::RDS::INSTANCE": ["rm-xxx", "rm-yyy"],'."\n"
.' "ALIYUN::VPC::VPC": ["vpc-xxx", "vpc-yyy"],'."\n"
.' "ALIYUN::SLB::INSTANCE": ["lb-xxx", "lb-yyy"]'."\n"
.' }'."\n"
.'}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '46577928-3162-15A6-9084-69820EB9xxxx',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46577928-3162-15A6-9084-69820EB9xxxx\\"\\n}","type":"json"}]',
'title' => '修改服务实例包含的资源',
],
'UpgradeServiceInstance' => [
'summary' => '使用地域ID、服务版本等参数调用UpgradeServiceInstance升级服务实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '162313',
'abilityTreeNodes' => [
'FEATUREcomputenestQE1OA6',
],
'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,
'docRequired' => true,
'example' => 'si-5cbae874da0e47xxxxxx',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否对此次创建请求执行预检,包括权限、实例状态校验等。可能的值:'."\n"
."\n"
.'- true:发送请求,不创建服务实例。'."\n"
."\n"
.'- false:发送请求,检查通过后创建服务实例。',
'type' => 'string',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '服务实例配置参数。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "param": "value"'."\n"
.'}',
],
],
],
'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' => 'F224E002-AB0E-5FD9-A87E-54AEE56F6CAE',
],
'ServiceInstanceId' => [
'description' => '服务实例ID。',
'type' => 'string',
'example' => 'si-5cbae874da0e47xxxxxx',
],
'UpgradeRequiredParameters' => [
'description' => '升级需要的参数。',
'type' => 'array',
'items' => [
'description' => '升级需要的参数。',
'type' => 'string',
'example' => '[\'EcsInstanceType\', \'InstancePassword\']',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Created\\",\\n \\"RequestId\\": \\"F224E002-AB0E-5FD9-A87E-54AEE56F6CAE\\",\\n \\"ServiceInstanceId\\": \\"si-5cbae874da0e47xxxxxx\\",\\n \\"UpgradeRequiredParameters\\": [\\n \\"[\'EcsInstanceType\', \'InstancePassword\']\\"\\n ]\\n}","type":"json"}]',
'title' => '升级服务实例',
],
'GetServiceInstance' => [
'summary' => '通过服务实例 ID、地域 ID查询指定服务实例的详细信息。例如,服务实例的部署状态、模板名称、服务详情等信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36942',
'abilityTreeNodes' => [
'FEATUREcomputenestVIKWP9',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'si-d6ab3a63ccbb4b17****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'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' => 'Deployed',
],
'TemplateName' => [
'description' => '模板名称。',
'type' => 'string',
'example' => '模板1',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => ' '."\n"
.'4DB0F536-B3BE-4F0D-BD29-E83FB56D550C',
],
'ServiceInstanceId' => [
'description' => '服务实例ID。',
'type' => 'string',
'example' => 'si-d6ab3a63ccbb4b17****',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'UserId' => [
'description' => '用户AliUid。',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'SupplierUid' => [
'description' => '服务商AliUid。',
'type' => 'integer',
'format' => 'int64',
'example' => '1964460391538545',
],
'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' => '{'."\n"
.' "EstimateTime": null,'."\n"
.' "SupplierDeployMetadata": {'."\n"
.' "DeployTimeout": null'."\n"
.' },'."\n"
.' "TemplateConfigs": ['."\n"
.' {'."\n"
.' "Name": "模板1",'."\n"
.' "Url": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json",'."\n"
.' "PredefinedParameters": [],'."\n"
.' "AllowedRegions": ['."\n"
.' "cn-hangzhou"'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
'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',
],
'ServiceProductUrl' => [
'description' => '产品页URL。',
'type' => 'string',
'required' => false,
'example' => 'https://service-info-private.oss-cn-hangzhou.aliyuncs.com',
],
'ServiceDocUrl' => [
'description' => '产品文档的URL。',
'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',
],
'UpgradableServiceVersions' => [
'description' => '可升级的服务版本号。',
'type' => 'array',
'items' => [
'description' => '可升级的服务版本号。',
'type' => 'string',
'example' => '1',
],
],
'UpgradableServiceInfos' => [
'description' => '可升级的服务版本信息。',
'type' => 'array',
'items' => [
'description' => '可升级的服务版本信息。',
'type' => 'object',
'properties' => [
'Version' => [
'description' => '可升级的服务版本。',
'type' => 'string',
'example' => '4',
],
'VersionName' => [
'description' => '可升级的服务版本名称。',
'type' => 'string',
'example' => '新增参数管理功能',
],
],
],
],
],
],
'Parameters' => [
'description' => '部署服务实例输入的参数。',
'type' => 'string',
'example' => '{'."\n"
.' "param": "value"'."\n"
.'}',
],
'Progress' => [
'description' => '服务实例的部署进度,单位:%。',
'type' => 'integer',
'format' => 'int64',
'example' => '90',
],
'StatusDetail' => [
'description' => '部署实例的状态描述。',
'type' => 'string',
'example' => 'deploy successfully',
],
'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****',
],
'IsOperated' => [
'description' => '服务实例的代运维功能是否开启。可能值:'."\n"
."\n"
.'- true:服务实例的代运维功能已开启'."\n"
."\n"
.'- false:服务实例的代运维功能未开启',
'type' => 'boolean',
'example' => 'true',
],
'EnableInstanceOps' => [
'description' => '服务实例是否有代运维功能。可能的值:'."\n"
."\n"
.'- true:服务实例有代运维功能'."\n"
."\n"
.'- false:服务实例没有代运维功能',
'type' => 'boolean',
'example' => 'true',
],
'Resources' => [
'description' => '资源列表。',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "StackId": "stack-xxx"'."\n"
.' }'."\n"
.']',
],
'NetworkConfig' => [
'description' => '网络配置信息。'."\n"
."\n"
.'> 该参数已废弃。'."\n",
'type' => 'object',
'properties' => [
'EndpointServiceId' => [
'description' => '私网连接的终端节点服务ID。'."\n"
.'> 该参数已废弃。',
'type' => 'string',
'example' => 'epsrv-5ei07324541816bxxxx',
],
'EndpointId' => [
'description' => '私网连接的终端节点id。'."\n"
."\n"
.'> 该参数已废弃。',
'type' => 'string',
'example' => 'ep-m5ei37240541816b****',
],
'PrivateVpcConnections' => [
'description' => '私网连接信息。',
'type' => 'array',
'items' => [
'description' => '私网连接信息。',
'type' => 'object',
'properties' => [
'EndpointId' => [
'description' => '私网连接的终端节点ID。',
'type' => 'string',
'example' => 'ep-m5ei37240541816b****',
],
'EndpointServiceId' => [
'description' => '私网连接的终端节点服务ID。',
'type' => 'string',
'example' => 'epsrv-5ei07324541816bxxxx',
],
'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' => 'example.com',
],
'ConnectBandwidth' => [
'description' => '使用计算巢内网互联建立连接的限速带宽。',
'type' => 'integer',
'format' => 'int32',
'example' => '1536Mbps',
],
],
],
],
],
],
],
'ReversePrivateVpcConnections' => [
'description' => '反向私网连接信息。',
'type' => 'array',
'items' => [
'description' => '反向私网连接信息。',
'type' => 'object',
'properties' => [
'EndpointId' => [
'description' => '反向私网连接的终端节点ID。',
'type' => 'string',
'example' => 'ep-m5ei42370541816b****',
],
'EndpointServiceId' => [
'description' => '私网连接的终端节点服务ID。',
'type' => 'string',
'example' => 'epsrv-5ei07324541816bxxxx',
],
],
],
],
],
],
'Tags' => [
'description' => '用户自定义标签。',
'type' => 'array',
'items' => [
'description' => '用户自定义标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'key1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'value1',
],
],
],
],
'Outputs' => [
'description' => '创建服务实例返回的输出字段。'."\n"
."\n"
.'- ROS模式下,返回模板所有输出字段。'."\n"
."\n"
.'- SPI模式下,返回ISV输出字段和计算巢附加功能输出字段。',
'type' => 'string',
'example' => '{'."\n"
.' "InstanceIds": ['."\n"
.' "i-hp38ofxl0dsyfi7z****"'."\n"
.' ]'."\n"
.'}',
],
'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:商家自定义固定时长。',
'type' => 'string',
'example' => 'Subscription',
],
'LicenseMetadata' => [
'description' => '许可证元数据。',
'type' => 'string',
'example' => '{"renewType":"MONTHLY"}',
],
'Name' => [
'description' => '服务实例名称。',
'type' => 'string',
'example' => 'TestName',
],
'EnableUserPrometheus' => [
'description' => '用户侧是否启用prometheus',
'type' => 'boolean',
'example' => 'true',
],
'RdAccountLoginUrl' => [
'description' => '服务实例对应的资源目录成员用户登录url',
'type' => 'string',
'example' => 'https://signin.aliyun.com/switchRole.htm?parentAlias=1307782318217247.onaliyun.com&roleName=ResourceDirectoryAccountAccessRole',
],
'PredefinedParameterName' => [
'description' => '套餐名称。',
'type' => 'string',
'example' => '套餐一',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-aekzkt5buxxxxxx',
],
'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.xxxxxx.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxxxx-quickstart-and-dashboard?orgId=355401&refresh=10s',
],
'OperationExtraInfo' => [
'description' => '代运维附加信息。',
'type' => 'string',
'example' => '6cc5ce3590ed7f5529e85fec',
],
'PolicyNames' => [
'type' => 'string',
],
'GrantedPermission' => [
'type' => 'object',
'properties' => [
'OperationEndTime' => [
'type' => 'string',
],
'PolicyNames' => [
'type' => 'string',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Deployed\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"RequestId\\": \\"\\\\t\\\\n4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"UserId\\": 1234567,\\n \\"SupplierUid\\": 1964460391538545,\\n \\"Service\\": {\\n \\"Status\\": \\"Online\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Version\\": \\"1\\",\\n \\"DeployMetadata\\": \\"{\\\\n \\\\\\"EstimateTime\\\\\\": null,\\\\n \\\\\\"SupplierDeployMetadata\\\\\\": {\\\\n \\\\\\"DeployTimeout\\\\\\": null\\\\n },\\\\n \\\\\\"TemplateConfigs\\\\\\": [\\\\n {\\\\n \\\\\\"Name\\\\\\": \\\\\\"模板1\\\\\\",\\\\n \\\\\\"Url\\\\\\": \\\\\\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\\\\\\",\\\\n \\\\\\"PredefinedParameters\\\\\\": [],\\\\n \\\\\\"AllowedRegions\\\\\\": [\\\\n \\\\\\"cn-hangzhou\\\\\\"\\\\n ]\\\\n }\\\\n ]\\\\n}\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-9c8a3522528b4fe8****\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceProductUrl\\": \\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"ServiceDocUrl\\": \\"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 \\"UpgradableServiceVersions\\": [\\n \\"1\\"\\n ],\\n \\"UpgradableServiceInfos\\": [\\n {\\n \\"Version\\": \\"4\\",\\n \\"VersionName\\": \\"新增参数管理功能\\"\\n }\\n ]\\n },\\n \\"Parameters\\": \\"{\\\\n \\\\\\"param\\\\\\": \\\\\\"value\\\\\\"\\\\n}\\",\\n \\"Progress\\": 90,\\n \\"StatusDetail\\": \\"deploy successfully\\",\\n \\"OperationStartTime\\": \\"2021-12-29T06:48:56Z\\",\\n \\"OperationEndTime\\": \\"2022-01-28T06:48:56Z\\",\\n \\"OperatedServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"IsOperated\\": true,\\n \\"EnableInstanceOps\\": true,\\n \\"Resources\\": \\"[\\\\n {\\\\n \\\\\\"StackId\\\\\\": \\\\\\"stack-xxx\\\\\\"\\\\n }\\\\n]\\",\\n \\"NetworkConfig\\": {\\n \\"EndpointServiceId\\": \\"epsrv-5ei07324541816bxxxx\\",\\n \\"EndpointId\\": \\"ep-m5ei37240541816b****\\",\\n \\"PrivateVpcConnections\\": [\\n {\\n \\"EndpointId\\": \\"ep-m5ei37240541816b****\\",\\n \\"EndpointServiceId\\": \\"epsrv-5ei07324541816bxxxx\\",\\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\\": \\"example.com\\",\\n \\"ConnectBandwidth\\": 0\\n }\\n ]\\n }\\n ],\\n \\"ReversePrivateVpcConnections\\": [\\n {\\n \\"EndpointId\\": \\"ep-m5ei42370541816b****\\",\\n \\"EndpointServiceId\\": \\"epsrv-5ei07324541816bxxxx\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Outputs\\": \\"{\\\\n \\\\\\"InstanceIds\\\\\\": [\\\\n \\\\\\"i-hp38ofxl0dsyfi7z****\\\\\\"\\\\n ]\\\\n}\\",\\n \\"EndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"Source\\": \\"User\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"LicenseMetadata\\": \\"{\\\\\\"renewType\\\\\\":\\\\\\"MONTHLY\\\\\\"}\\",\\n \\"Name\\": \\"TestName\\",\\n \\"EnableUserPrometheus\\": true,\\n \\"RdAccountLoginUrl\\": \\"https://signin.aliyun.com/switchRole.htm?parentAlias=1307782318217247.onaliyun.com&roleName=ResourceDirectoryAccountAccessRole\\",\\n \\"PredefinedParameterName\\": \\"套餐一\\",\\n \\"ResourceGroupId\\": \\"rg-aekzkt5buxxxxxx\\",\\n \\"BizStatus\\": \\"Normal\\",\\n \\"GrafanaDashBoardUrl\\": \\"https://g.xxxxxx.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxxxx-quickstart-and-dashboard?orgId=355401&refresh=10s\\",\\n \\"OperationExtraInfo\\": \\"6cc5ce3590ed7f5529e85fec\\",\\n \\"PolicyNames\\": \\"\\",\\n \\"GrantedPermission\\": {\\n \\"OperationEndTime\\": \\"\\",\\n \\"PolicyNames\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => '查询服务实例的详细信息',
],
'ListServiceInstances' => [
'summary' => '查询服务实例列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36947',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'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"
.'- ServiceInstanceId:服务实例ID'."\n"
."\n"
.'- ServiceId:服务ID'."\n"
."\n"
.'- UserId:用户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' => 'ShowDeleted',
'in' => 'query',
'schema' => [
'description' => '是否显示已删除。可能的值:'."\n"
."\n"
.'- true:显示'."\n"
."\n"
.'- false:不显示',
'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' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-aekzkt5buxxxxxx',
],
],
],
'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' => 'int32',
'example' => '100',
],
'MaxResults' => [
'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'ServiceInstances' => [
'description' => '服务实例信息。',
'type' => 'array',
'items' => [
'description' => '服务实例信息。',
'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",
'type' => 'string',
'example' => 'Deployed',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'Name' => [
'description' => '服务实例名称。',
'type' => 'string',
'example' => 'TestName',
],
'ServiceInstanceId' => [
'description' => '服务实例ID。',
'type' => 'string',
'example' => 'si-d6ab3a63ccbb4b17****',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'UserId' => [
'description' => '用户AliUid。',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'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:代运维服务'."\n"
."\n"
.'- poc:试用服务实例。',
'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',
],
'DeployMetadata' => [
'description' => '存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用JSON String格式进行数据存储。',
'type' => 'string',
'example' => '{'."\n"
.' "EstimateTime": null,'."\n"
.' "SupplierDeployMetadata": {'."\n"
.' "DeployTimeout": null'."\n"
.' },'."\n"
.' "TemplateConfigs": ['."\n"
.' {'."\n"
.' "Name": "模板1",'."\n"
.' "Url": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json",'."\n"
.' "PredefinedParameters": [],'."\n"
.' "AllowedRegions": ['."\n"
.' "cn-hangzhou"'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
'EnablePrivateVpcConnection' => [
'description' => '是否已开启私网连接。可能的值:'."\n"
."\n"
.'- true:已开启'."\n"
."\n"
.'- false:未开启',
'type' => 'boolean',
'example' => 'false',
],
'SourceSupplierName' => [
'description' => '分销源服务商名称。',
'type' => 'string',
'example' => 'A有限公司',
],
],
],
'Parameters' => [
'description' => '服务实例参数信息。',
'type' => 'string',
'example' => '{"param":"value"}',
],
'Progress' => [
'description' => '服务实例的部署进度,单位:%。',
'type' => 'integer',
'format' => 'int64',
'example' => '90',
],
'StatusDetail' => [
'description' => '服务实例的部署信息描述。',
'type' => 'string',
'example' => 'deploy successfully',
],
'TemplateName' => [
'description' => '模板名称。',
'type' => 'string',
'example' => '模板1',
],
'OperatedServiceInstanceId' => [
'description' => '被代运维的服务实例ID。',
'type' => 'string',
'example' => 'si-d6ab3a63ccbb4b17****',
],
'OperationStartTime' => [
'description' => '代运维开始时间。',
'type' => 'string',
'example' => '2021-12-29T06:48:56Z',
],
'OperationEndTime' => [
'description' => '代运维结束时间。',
'type' => 'string',
'example' => '2021-12-29T06:48:56Z',
],
'EnableInstanceOps' => [
'description' => '服务实例是否有代运维功能。可能的值:'."\n"
."\n"
.'- true:服务实例有代运维功能'."\n"
."\n"
.'- false:服务实例没有代运维功能'."\n",
'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',
],
'IsOperated' => [
'description' => '服务实例的代运维功能是否开启。可能值:'."\n"
."\n"
.'- true:服务实例的代运维功能已开启'."\n"
."\n"
.'- false:服务实例的代运维功能未开启',
'type' => 'boolean',
'example' => 'true',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'si-d6ab3a63ccxxxxxx',
],
'BizStatus' => [
'description' => '服务实例的业务状态。可能的值:'."\n"
."\n"
.'- Normal:正常。'."\n"
."\n"
.'- Renewing:续费中。'."\n"
."\n"
.'- RenewFoiled:续费失败。'."\n"
."\n"
.'- Expired:已过期。',
'type' => 'string',
'example' => 'Normal',
],
'GrantedPermission' => [
'type' => 'object',
'properties' => [
'OperationEndTime' => [
'type' => 'string',
],
'PolicyNames' => [
'type' => 'string',
],
],
],
'PolicyNames' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"E50287CB-AABF-4877-92C0-289B339A1546\\",\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 20,\\n \\"ServiceInstances\\": [\\n {\\n \\"Status\\": \\"Deployed\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"Name\\": \\"TestName\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"UserId\\": 1234567,\\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 \\"DeployMetadata\\": \\"{\\\\n \\\\\\"EstimateTime\\\\\\": null,\\\\n \\\\\\"SupplierDeployMetadata\\\\\\": {\\\\n \\\\\\"DeployTimeout\\\\\\": null\\\\n },\\\\n \\\\\\"TemplateConfigs\\\\\\": [\\\\n {\\\\n \\\\\\"Name\\\\\\": \\\\\\"模板1\\\\\\",\\\\n \\\\\\"Url\\\\\\": \\\\\\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\\\\\\",\\\\n \\\\\\"PredefinedParameters\\\\\\": [],\\\\n \\\\\\"AllowedRegions\\\\\\": [\\\\n \\\\\\"cn-hangzhou\\\\\\"\\\\n ]\\\\n }\\\\n ]\\\\n}\\",\\n \\"EnablePrivateVpcConnection\\": false,\\n \\"SourceSupplierName\\": \\"A有限公司\\"\\n },\\n \\"Parameters\\": \\"{\\\\\\"param\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Progress\\": 90,\\n \\"StatusDetail\\": \\"deploy successfully\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"OperatedServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"OperationStartTime\\": \\"2021-12-29T06:48:56Z\\",\\n \\"OperationEndTime\\": \\"2021-12-29T06: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 \\"IsOperated\\": true,\\n \\"ResourceGroupId\\": \\"si-d6ab3a63ccxxxxxx\\",\\n \\"BizStatus\\": \\"Normal\\",\\n \\"GrantedPermission\\": {\\n \\"OperationEndTime\\": \\"\\",\\n \\"PolicyNames\\": \\"\\"\\n },\\n \\"PolicyNames\\": \\"\\"\\n }\\n ]\\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' => '175901',
'abilityTreeNodes' => [
'FEATUREcomputenestVUFVAC',
],
'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',
],
],
],
'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' => 'B8A6AEA6-0D8F-589A-A7FF-B44FD842456E',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8A6AEA6-0D8F-589A-A7FF-B44FD842456E\\"\\n}","type":"json"}]',
'title' => '部署服务实例',
],
'ContinueDeployServiceInstance' => [
'summary' => '服务实例部署失败后,通过指定地域ID、服务ID、服务实例配置参数,继续部署服务实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136363',
'abilityTreeNodes' => [
'FEATUREcomputenestVUFVAC',
],
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '82DF27ED-E538-5AC0-A11C-39334A873189',
],
'DryRunResult' => [
'description' => '校验结果。',
'type' => 'object',
'properties' => [
'ParametersNotAllowedToBeModified' => [
'description' => '不允许修改的参数。修改参数一定会引发校验错误。'."\n"
."\n"
.'> 仅在DryRun为true时返回结果。',
'type' => 'array',
'items' => [
'description' => '不允许修改的参数。修改参数一定会引发校验错误。'."\n"
."\n"
.'> 仅在DryRun为true时返回结果。',
'type' => 'string',
'example' => 'cidr',
],
],
'ParametersConditionallyAllowedToBeModified' => [
'description' => '可能允许修改的参数。 修改参数是否引起校验错误,取决于参数的取值。'."\n"
.'> 仅在DryRun为true时返回结果。',
'type' => 'array',
'items' => [
'description' => '可能允许修改的参数。 修改参数是否引起校验错误,取决于参数的取值。'."\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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82DF27ED-E538-5AC0-A11C-39334A873189\\",\\n \\"DryRunResult\\": {\\n \\"ParametersNotAllowedToBeModified\\": [\\n \\"cidr\\"\\n ],\\n \\"ParametersConditionallyAllowedToBeModified\\": [\\n \\"name\\"\\n ],\\n \\"ParametersAllowedToBeModified\\": [\\n \\"description\\"\\n ]\\n },\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\"\\n}","type":"json"}]',
'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' => '220935',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9****',
],
],
[
'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' => '2E91D771-0183-52CE-86CB-882D99B2CB77',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E91D771-0183-52CE-86CB-882D99B2CB77\\"\\n}","type":"json"}]',
'title' => '启动服务实例',
'description' => '### 前提条件'."\n"
.'请您确保在创建服务时添加了开机、关机的运维操作。具体操作,请参见[创建服务](~~440268~~)。',
],
'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' => '220569',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9****',
],
],
[
'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-c39ed4779cec449f****',
],
],
],
'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' => '49A369EF-A302-5006-B0CE-94CED47C38CF',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"49A369EF-A302-5006-B0CE-94CED47C38CF\\"\\n}","type":"json"}]',
'title' => '关闭服务实例',
'description' => '### 前提条件'."\n"
.'请您确保在创建服务时添加了开机、关机的运维操作。具体操作,请参见[创建服务](~~440268~~)。',
],
'RestartServiceInstance' => [
'summary' => '当服务实例状态为Deployed(已部署)时,调用RestartServiceInstance接口重启服务实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '220936',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9****',
],
],
[
'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' => 'B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX\\"\\n}","type":"json"}]',
'title' => '重启服务实例',
'description' => '### 前提条件'."\n"
.'请您确保在创建服务时添加了重启的运维操作。具体操作,请参见[创建服务](~~440268~~)。',
],
'ListServiceInstanceDeployDetails' => [
'summary' => '查询服务实例部署详情列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189761',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例的地域ID。',
'type' => 'string',
'required' => 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。',
'type' => 'string',
'required' => false,
'example' => 'AAAAAZbOYA+x9UgM6xrgcMqFUjk=',
],
],
[
'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' => 'service-c751ed91f2074af39779',
],
'required' => false,
'maxItems' => 20,
],
'Name' => [
'description' => '过滤值名称。对应SQL中的Where。'."\n"
."\n"
.'可选值:'."\n"
.'- UserId'."\n"
.'- ServiceId'."\n"
.'- ServiceVersion'."\n"
.'- ServiceInstanceId'."\n"
.'- DeploySucceeded(True or False,大小写不敏感)'."\n"
.'- ErrorType'."\n"
.'- ErrorCode',
'type' => 'string',
'required' => false,
'example' => 'ServiceId',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '查询开始时间。'."\n"
."\n"
.'使用UTC+0时间,格式为yyyy-MM-ddTHH:mmZ。',
'type' => 'string',
'required' => false,
'example' => '2024-08-25T02:23:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '查询结束时间。'."\n"
."\n"
.'使用UTC+0时间,格式为yyyy-MM-ddTHH:mmZ。',
'type' => 'string',
'required' => false,
'example' => '2024-12-31T16:00:00Z',
],
],
[
'name' => 'CycleTimeZone',
'in' => 'query',
'schema' => [
'description' => '时区。'."\n"
."\n"
.'参考格式:"+08:00"'."\n"
."\n"
.'合法范围:"-12:59"到"+13:00"',
'type' => 'string',
'required' => false,
'example' => '+08:00',
],
],
[
'name' => 'Dimension',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '维度名称。对应SQL中的Group By。'."\n"
."\n"
.'可选值:'."\n"
.'- UserId'."\n"
.'- ServiceId'."\n"
.'- ServiceVersion'."\n"
.'- ServiceInstanceId'."\n"
.'- DeploySucceeded'."\n"
.'- ErrorType'."\n"
.'- ErrorCode',
'type' => 'array',
'items' => [
'description' => '聚合维度。',
'type' => 'string',
'required' => false,
'example' => 'ErrorType',
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'CycleType',
'in' => 'query',
'schema' => [
'description' => '决定聚合周期。无参时视为查询详情。'."\n"
."\n"
.'可选值:'."\n"
.'- Year '."\n"
.'- Month '."\n"
.'- Day '."\n"
.'- All',
'type' => 'string',
'required' => false,
'example' => 'Month',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一个查询开始token',
'type' => 'string',
'example' => 'AAAAAW8kZY+u1sYOaYf5JmgmDQQ=',
],
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '0036D82E-0624-5B37-B797-C460F4B02026',
],
'TotalCount' => [
'description' => '结果总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
],
'MaxResults' => [
'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'DeployDetails' => [
'description' => '服务实例部署详情。',
'type' => 'array',
'items' => [
'description' => '服务实例部署详情。',
'type' => 'object',
'properties' => [
'Cycle' => [
'description' => '聚合周期。',
'type' => 'string',
'example' => 'Month',
],
'Timestamp' => [
'description' => '时间戳,',
'type' => 'string',
'example' => '1723946641994',
],
'Count' => [
'description' => '聚合数据行数。',
'type' => 'string',
'example' => '4',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2024-04-10T01:58:20Z',
],
'UserId' => [
'description' => '用户ID。',
'type' => 'string',
'example' => '1591457835436382',
],
'ServiceId' => [
'description' => '服务ID。',
'type' => 'string',
'example' => 'service-c751ed91f2074af39779',
],
'ServiceVersion' => [
'description' => '服务版本。',
'type' => 'string',
'example' => '42',
],
'ServiceNameChn' => [
'description' => '服务中文名称。',
'type' => 'string',
'example' => '测试服务',
],
'ServiceNameEng' => [
'description' => '服务英文名称。',
'type' => 'string',
'example' => 'Test Service',
],
'ServiceInstanceId' => [
'description' => '服务实例ID。',
'type' => 'string',
'example' => 'si-273e8cee11d349e1803c',
],
'DeploySucceeded' => [
'description' => '部署是否成功。',
'type' => 'string',
'example' => 'False',
],
'ErrorType' => [
'description' => '部署失败的错误类型。',
'type' => 'string',
'example' => 'ValidationError',
],
'ErrorCode' => [
'description' => '部署失败的错误码。',
'type' => 'string',
'example' => 'StackValidationFailed',
],
'ErrorDetail' => [
'description' => '错误详情。',
'type' => 'string',
'example' => '{code: StackValidationFailed, message: \\"Failed to continue create ROS stack 89e724e2-84e6-4517-a372-30a545ab4145: Resource [LinuxInstanceRunCommand]: i-wz91nfbh1fxtmfb0try4 are not running. Command invocation only support running instances. ErrorCode: StackValidationFailed\\", requestId: null}',
],
'ServiceType' => [
'description' => '服务类型。'."\n"
."\n"
.'可能值:'."\n"
."\n"
.'- private:部署在用户账户下。'."\n"
."\n"
.'- managed:托管在服务商账户下。'."\n"
."\n"
.'- operation:代运维服务。',
'type' => 'string',
'example' => 'private',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAW8kZY+u1sYOaYf5JmgmDQQ=\\",\\n \\"RequestId\\": \\"0036D82E-0624-5B37-B797-C460F4B02026\\",\\n \\"TotalCount\\": 7,\\n \\"MaxResults\\": 20,\\n \\"DeployDetails\\": [\\n {\\n \\"Cycle\\": \\"Month\\",\\n \\"Timestamp\\": \\"1723946641994\\",\\n \\"Count\\": \\"4\\",\\n \\"CreateTime\\": \\"2024-04-10T01:58:20Z\\",\\n \\"UserId\\": \\"1591457835436382\\",\\n \\"ServiceId\\": \\"service-c751ed91f2074af39779\\",\\n \\"ServiceVersion\\": \\"42\\",\\n \\"ServiceNameChn\\": \\"测试服务\\",\\n \\"ServiceNameEng\\": \\"Test Service\\",\\n \\"ServiceInstanceId\\": \\"si-273e8cee11d349e1803c\\",\\n \\"DeploySucceeded\\": \\"False\\",\\n \\"ErrorType\\": \\"ValidationError\\",\\n \\"ErrorCode\\": \\"StackValidationFailed\\",\\n \\"ErrorDetail\\": \\"{code: StackValidationFailed, message: \\\\\\\\\\\\\\"Failed to continue create ROS stack 89e724e2-84e6-4517-a372-30a545ab4145: Resource [LinuxInstanceRunCommand]: i-wz91nfbh1fxtmfb0try4 are not running. Command invocation only support running instances. ErrorCode: StackValidationFailed\\\\\\\\\\\\\\", requestId: null}\\",\\n \\"ServiceType\\": \\"private\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务实例部署详情列表',
],
'ListServiceInstanceResources' => [
'summary' => '调用ListServiceInstanceResources查询服务实例包含的资源',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '103268',
'abilityTreeNodes' => [
'FEATUREcomputenestL64NT4',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'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',
'style' => 'repeatList',
'schema' => [
'description' => '过滤器。',
'type' => 'array',
'items' => [
'description' => '过滤器。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n"
."\n"
.'- ExpireTimeStart'."\n"
.'- ExpireTimeEnd'."\n"
.'- PayType '."\n"
.'- ResourceARN',
'type' => 'string',
'required' => false,
'example' => 'ResourceARN'."\n",
],
'Values' => [
'description' => '过滤条件值。',
'type' => 'array',
'items' => [
'description' => '过滤条件值。',
'type' => 'string',
'required' => false,
'example' => 'arn:acs:ecs:*:*:instance/*',
],
'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"
."\n"
.'- PayAsYouGo:后付费。',
'type' => 'string',
'example' => 'Subscription',
],
'RenewStatus' => [
'description' => '续费状态,取值:'."\n"
."\n"
.'- AutoRenewal:自动续费。'."\n"
."\n"
.'- ManualRenewal:手动续费。'."\n"
."\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"
."\n"
.'- Year:年。',
'type' => 'string',
'example' => 'Month',
],
'ProductType' => [
'description' => '产品类型。',
'type' => 'string',
'example' => 'RDS',
],
'ProductCode' => [
'description' => '产品代码。',
'type' => 'string',
'example' => 'rds',
],
'Status' => [
'description' => '资源状态。取值:'."\n"
.'- INIT_COMPLETE:资源待创建。'."\n"
."\n"
.'- CREATE_COMPLETE:资源创建完成。'."\n"
.'- CREATE_FAILED:资源创建失败。'."\n"
.'- CREATE_IN_PROGRESS:资源创建中。'."\n"
.'- UPDATE_IN_PROGRESS:资源更新中。'."\n"
.'- UPDATE_FAILED:资源更新失败。'."\n"
.'- UPDATE_COMPLETE:资源更新完成。'."\n"
.'- DELETE_IN_PROGRESS:资源删除中。'."\n"
.'- DELETE_FAILED:资源删除失败。'."\n"
.'- DELETE_COMPLETE:资源删除完成。'."\n"
.'- CHECK_IN_PROGRESS:资源校验中。'."\n"
.'- CHECK_FAILED:资源校验失败。'."\n"
.'- CHECK_COMPLETE:资源校验完成。'."\n"
.'- IMPORT_IN_PROGRESS:资源导入中。'."\n"
.'- IMPORT_FAILED:资源导入失败。'."\n"
.'- IMPORT_COMPLETE:资源导入完成。'."\n"
."\n",
'type' => 'string',
'example' => 'CREATE_COMPLETE',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","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\\": \\"CREATE_COMPLETE\\"\\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' => '177378',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'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)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'required' => false,
'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=',
],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => [
'description' => '服务实例ID。'."\n"
."\n"
.'您可以通过调用[ListServiceInstances - 查询服务实例列表](~~396200~~)获取服务实例ID。',
'type' => 'string',
'required' => false,
'example' => 'si-0d0d7bc9accc4e2e8a8f',
],
],
[
'name' => 'BillingCycle',
'in' => 'query',
'schema' => [
'description' => '账期,YYYY-MM。',
'type' => 'string',
'required' => true,
'example' => '2025-03',
],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => [
'description' => '查询账单的颗粒度。取值如下:'."\n"
."\n"
.'- MONTHLY:月。与费用中心-费用账单-账单明细-账期账单一致。'."\n"
.'- DAILY:日。与费用中心-费用账单-账单明细-按天账单一致。'."\n"
."\n"
.'> 选择DAILY需指定BillingDate。',
'type' => 'string',
'required' => false,
'example' => 'MONTHLY',
],
],
[
'name' => 'BillingDate',
'in' => 'query',
'schema' => [
'description' => '账单日期,仅当**Granularity**为DAILY时必填,格式为YYYY-MM-DD。',
'type' => 'string',
'required' => false,
'example' => '2024-12-05',
],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID',
'type' => 'string',
'required' => false,
'example' => 'service-6121296da4f44e469519',
],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => [
'description' => '服务版本。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一个查询开始token。',
'type' => 'string',
'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B68C6D1-0C22-53F7-997C-F95D109C31AA',
],
'TotalCount' => [
'description' => '结果总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '65',
],
'MaxResults' => [
'description' => '分页查询时,每页显示的行数。每页最大100行,默认为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'Item' => [
'description' => '检查项名称。',
'type' => 'array',
'items' => [
'description' => '子任务ITEM详情',
'type' => 'object',
'properties' => [
'SplitBillingCycle' => [
'description' => '分账月。',
'type' => 'string',
'example' => '2021-06'."\n",
],
'BillingDate' => [
'description' => '账单日期,格式YYYY-MM-DD。',
'type' => 'string',
'example' => '2024-12-05',
],
'SubscriptionType' => [
'description' => '订阅类型:'."\n"
.'- Subscription:预付费。'."\n"
.'- PayAsYouGo:后付费。',
'type' => 'string',
'example' => 'Subscription',
],
'ProductName' => [
'description' => '产品名称。',
'type' => 'string',
'example' => 'oss',
],
'BillingItemCode' => [
'description' => '计费项代码。',
'type' => 'string',
'example' => 'disk',
],
'ProductCode' => [
'description' => '产品代码。',
'type' => 'string',
'example' => 'oss',
],
'ProductDetail' => [
'description' => '产品明细。',
'type' => 'string',
'example' => 'sls',
],
'InstanceID' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'rm-wz9k051l23j3o3xa9',
],
'DeductedByResourcePackage' => [
'description' => '资源包抵扣。',
'type' => 'string',
'example' => '0',
],
'ListPriceUnit' => [
'description' => '单价单位。',
'type' => 'string',
'example' => '元/GB'."\n",
],
'Usage' => [
'description' => '资源用量',
'type' => 'string',
'example' => '1',
],
'ListPrice' => [
'description' => '单价。',
'type' => 'string',
'example' => '0.12',
],
'UsageUnit' => [
'description' => '用量单位',
'type' => 'string',
'example' => 'GB',
],
'PretaxGrossAmount' => [
'description' => '原始金额。',
'type' => 'string',
'example' => '0',
],
'InvoiceDiscount' => [
'description' => '优惠金额。',
'type' => 'string',
'example' => '0',
],
'PretaxAmount' => [
'description' => '应付金额。',
'type' => 'string',
'example' => '0',
],
'ServiceInstanceId' => [
'description' => '服务实例ID。',
'type' => 'string',
'example' => 'si-bc5d6ac7022647d3a3bd',
],
'BillingCycle' => [
'description' => '账期,格式:YYYY-MM。',
'type' => 'string',
'example' => '2024-12',
],
'BillingItem' => [
'description' => '计费项。',
'type' => 'string',
'example' => '带宽'."\n",
],
'Currency' => [
'description' => '货币单位。',
'type' => 'string',
'example' => 'CNY',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"7B68C6D1-0C22-53F7-997C-F95D109C31AA\\",\\n \\"TotalCount\\": 65,\\n \\"MaxResults\\": 20,\\n \\"Item\\": [\\n {\\n \\"SplitBillingCycle\\": \\"2021-06\\\\n\\",\\n \\"BillingDate\\": \\"2024-12-05\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"ProductName\\": \\"oss\\",\\n \\"BillingItemCode\\": \\"disk\\",\\n \\"ProductCode\\": \\"oss\\",\\n \\"ProductDetail\\": \\"sls\\",\\n \\"InstanceID\\": \\"rm-wz9k051l23j3o3xa9\\",\\n \\"DeductedByResourcePackage\\": \\"0\\",\\n \\"ListPriceUnit\\": \\"元/GB\\\\n\\",\\n \\"Usage\\": \\"1\\",\\n \\"ListPrice\\": \\"0.12\\",\\n \\"UsageUnit\\": \\"GB\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"InvoiceDiscount\\": \\"0\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"ServiceInstanceId\\": \\"si-bc5d6ac7022647d3a3bd\\",\\n \\"BillingCycle\\": \\"2024-12\\",\\n \\"BillingItem\\": \\"带宽\\\\n\\",\\n \\"Currency\\": \\"CNY\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务实例账单',
],
'ListServiceInstanceLogs' => [
'summary' => '调用ListServiceInstanceLogs查询服务实例的部署,升级和应用等日志',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136360',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'autoTest' => true,
'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"
.'- application:应用自身的日志。'."\n"
."\n"
.'- computeNest:计算巢打印的日志。'."\n"
."\n"
.'- ros:来自资源编排的日志。',
'type' => 'string',
'required' => false,
'example' => 'computeNest',
],
],
[
'name' => 'Logstore',
'in' => 'query',
'schema' => [
'description' => '日志服务logstore名称。',
'type' => 'string',
'required' => false,
'example' => 'livelog',
],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '过滤器。',
'type' => 'array',
'items' => [
'description' => '过滤器。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '过滤值名称。'."\n"
."\n"
.'可选值:'."\n"
.'- StartTime'."\n"
.'- EndTime'."\n"
.'- ApplicationGroupName'."\n"
.'- ResouceName'."\n"
.'- EventName',
'type' => 'string',
'required' => false,
'example' => 'StartTime',
],
'Value' => [
'description' => '指定过滤条件Value。',
'type' => 'array',
'items' => [
'description' => '过滤器值列表。N的取值范围:1~10。',
'type' => 'string',
'required' => false,
'example' => '2022-01-01T22:22:22Z',
],
'required' => false,
'maxItems' => 20,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => [
'description' => '排序方向。取值范围:'."\n"
."\n"
.'- **Ascending**:升序'."\n"
.'- **Descending**(默认值):降序'."\n",
'type' => 'string',
'required' => false,
'example' => 'Ascending',
'default' => 'Descending',
'enum' => [
'Descending',
'Ascending',
],
],
],
],
'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' => '2022-05-21T00:00:00Z',
],
'Source' => [
'description' => '服务实例日志的来源。可能的值:'."\n"
."\n"
.'- ros:来源于资源编排ROS的日志。'."\n"
."\n"
.'- computeNest:来源于计算巢的日志。'."\n"
.'- application: 来源于实例内应用日志'."\n"
.'- compliancePack: 来源于实例合规检测包的日志'."\n"
.'- actionTrail: 来源于操作审计',
'type' => 'string',
'example' => 'computeNest',
],
'Content' => [
'description' => '日志内容。',
'type' => 'string',
'example' => 'Start creating service instance',
],
'LogType' => [
'description' => '日志类型。可能的值:'."\n"
."\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' => 'Deployed',
],
'CompliancePackType' => [
'description' => '合规包风险类型,当source为compliancePack时出现。如VPC内数据安全检查,VpcDataRisk',
'type' => 'string',
'example' => 'VpcDataRisk',
],
'ComplianceRuleName' => [
'description' => '合规包具体风险规则名,当source为compliancePack时出现。如ECS实例迁移出vpc-ecs-move-out-vpc',
'type' => 'string',
'example' => 'vpc-ecs-move-out-vpc',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"MaxResults\\": 20,\\n \\"ServiceInstancesLogs\\": [\\n {\\n \\"Timestamp\\": \\"2022-05-21T00:00:00Z\\",\\n \\"Source\\": \\"computeNest\\",\\n \\"Content\\": \\"Start creating service instance\\",\\n \\"LogType\\": \\"serviceInstance\\",\\n \\"ResourceType\\": \\"ROS.Stack\\",\\n \\"ResourceId\\": \\"si-5c6525c0589545c3****\\",\\n \\"Status\\": \\"Deployed\\",\\n \\"CompliancePackType\\": \\"VpcDataRisk\\",\\n \\"ComplianceRuleName\\": \\"vpc-ecs-move-out-vpc\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务实例的日志',
],
'DeleteAcrImageRepositories' => [
'summary' => '删除Acr镜像仓库',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '160456',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'RepoId',
'in' => 'query',
'schema' => [
'description' => '镜像仓库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'crr-7x9rf32mkqoqulrn',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'ArtifactType',
'in' => 'query',
'schema' => [
'description' => '部署物类型。默认值为:AcrImage。可能的值:'."\n"
."\n"
.'- HelmChart:Helm Chart镜像。'."\n"
."\n"
.'- AcrImage:容器镜像。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'AcrImage',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '9B55A3FD-B562-5BFE-A91A-DB1790717236',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B55A3FD-B562-5BFE-A91A-DB1790717236\\"\\n}","type":"json"}]',
'title' => '删除Acr镜像仓库',
'description' => '### 前提条件'."\n"
.'请确保没有部署物在引用对应的容器镜像再进行删除,否则会导致部署物不可用。',
],
'ListArtifactRisks' => [
'summary' => '获取部署物安全风险列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '201838',
'abilityTreeNodes' => [
'FEATUREcomputenestB2MIVU',
],
],
'parameters' => [
[
'name' => 'ArtifactId',
'in' => 'query',
'schema' => [
'description' => '部署物ID。',
'type' => 'string',
'required' => false,
'example' => 'artifact-3fd95cdfdf0d4b1fa00c',
],
],
[
'name' => 'ArtifactVersion',
'in' => 'query',
'schema' => [
'description' => '部署物版本。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '52919DB1-03A0-55F5-BDD4-DB6DEBB8267A',
],
'ArtifactRiskList' => [
'description' => '部署物风险列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Level' => [
'description' => '风险级别:'."\n"
."\n"
.'- high代表高',
'type' => 'string',
'example' => 'high',
],
'RiskType' => [
'description' => '风险类型。取值:'."\n"
.'- AcrCve 容器镜像系统漏洞'."\n"
.'- AcrSca 容器镜像应用漏洞'."\n"
.'- EcsVulnerability ECS镜像漏洞信息'."\n"
.'- EcsAlarm ECS镜像安全告警'."\n"
.'- EcsBaseline ECS镜像基线检查',
'type' => 'string',
'example' => 'AcrCve',
],
'RiskTypeName' => [
'description' => '风险类别名称',
'type' => 'string',
'example' => '容器镜像系统漏洞',
],
'RiskName' => [
'description' => '风险名称。',
'type' => 'string',
'example' => 'USN-3686-1: file vulnerabilities',
],
'Solution' => [
'description' => '检查项风险的解决方案。',
'type' => 'string',
'example' => 'apt-get update && apt-get install ntpdate --only-upgrade',
],
'CveNos' => [
'description' => '漏洞编号',
'type' => 'string',
'example' => 'CVE-2023-4911',
],
'ExtendInfo' => [
'description' => '扩展信息,json格式,根据风险类别进行解析',
'type' => 'string',
'example' => '{'."\n"
.' "feature": "ntpdate", '."\n"
.' "version": "4.2.6", '."\n"
.' "cveLocation": "/usr/lib" '."\n"
.'}',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52919DB1-03A0-55F5-BDD4-DB6DEBB8267A\\",\\n \\"ArtifactRiskList\\": [\\n {\\n \\"Level\\": \\"high\\",\\n \\"RiskType\\": \\"AcrCve\\",\\n \\"RiskTypeName\\": \\"容器镜像系统漏洞\\",\\n \\"RiskName\\": \\"USN-3686-1: file vulnerabilities\\",\\n \\"Solution\\": \\"apt-get update && apt-get install ntpdate --only-upgrade\\",\\n \\"CveNos\\": \\"CVE-2023-4911\\",\\n \\"ExtendInfo\\": \\"{\\\\n \\\\\\"feature\\\\\\": \\\\\\"ntpdate\\\\\\", \\\\n \\\\\\"version\\\\\\": \\\\\\"4.2.6\\\\\\", \\\\n \\\\\\"cveLocation\\\\\\": \\\\\\"/usr/lib\\\\\\" \\\\n}\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询部署物风险列表',
],
'CreateArtifact' => [
'summary' => '调用CreateArtifact创建部署物',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '131218',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
],
'parameters' => [
[
'name' => 'ArtifactId',
'in' => 'query',
'schema' => [
'description' => '部署物ID。'."\n"
."\n"
.'当您要为已有部署物创建新版本时,该参数必填。'."\n"
."\n"
.'您可以通过调用[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物ID。',
'type' => 'string',
'required' => false,
'example' => 'artifact-eea08d1e2d3a43ae****',
],
],
[
'name' => 'ArtifactType',
'in' => 'query',
'schema' => [
'description' => '部署物类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- EcsImage:ECS镜像部署物。'."\n"
."\n"
.'- AcrImage:容器镜像部署物。'."\n"
."\n"
.'- File:Oss文件部署物。'."\n"
."\n"
.'- Script:脚本部署物。'."\n"
."\n"
.'- HelmChart:HelmChart部署物。',
'type' => 'string',
'required' => true,
'example' => 'EcsImage',
],
],
[
'name' => 'ArtifactBuildType',
'in' => 'query',
'schema' => [
'description' => '构建部署物类型,取值范围:'."\n"
."\n"
.'- EcsImage:构建Ecs镜像'."\n"
."\n"
.'- Dockerflie:基于Dockerfile构建容器镜像'."\n"
."\n"
.'- Buildpacks:基于Buildpacks构建容器镜像'."\n"
."\n"
.'- ContainerImage:基于已有容器镜像重命名构建容器镜像',
'type' => 'string',
'required' => false,
'example' => 'Dockerflie',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '部署物名称。',
'type' => 'string',
'required' => true,
'example' => 'Redhat8_5镜像',
],
],
[
'name' => 'VersionName',
'in' => 'query',
'schema' => [
'description' => '部署物版本名称。',
'type' => 'string',
'required' => true,
'example' => 'v1',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '部署物描述。',
'type' => 'string',
'required' => false,
'example' => 'Redhat8_0镜像',
],
],
[
'name' => 'ArtifactProperty',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '部署物内容。',
'type' => 'object',
'properties' => [
'Url' => [
'description' => '文件部署物的URL。'."\n"
."\n"
.'您可以通过[对象存储控制台](https://oss.console.aliyun.com/bucket)上传并获取文件URL.',
'type' => 'string',
'required' => false,
'example' => 'https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852876****/template/2e1ce8fc-****-481c-9e8e-789ba9db487d.json',
],
'RegionId' => [
'description' => '镜像地域。'."\n"
."\n\n"
.'>该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
'ImageId' => [
'description' => '镜像ID。'."\n"
."\n"
.'当您选定RegionId时,您可以调用[DescribeImages - 查询可以使用的镜像资源](~~2679797~~)查看指定地域下可用的镜像ID。'."\n"
."\n\n"
.'> 该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'm-uf645fnsef9dsxmw****',
],
'CommodityCode' => [
'description' => '云市场商品code。'."\n"
."\n"
.'您可以通过[云市场控制台](https://market.console.aliyun.com/?spm=a2c4g.11186623.0.0.599d6787eMBBxu#/apiTools?_k=d7j8gk)获取商品Code。'."\n"
."\n"
.'> 该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'cmjj00****',
],
'CommodityVersion' => [
'description' => '云市场商品版本。'."\n"
."\n"
.'您可以通过[云市场页面](https://market.aliyun.com/?spm=5176.24779694.0.0.b2144d22sksKM5)查看云市场商品版本。'."\n"
."\n"
.'> 该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'V1.0',
],
'RepoName' => [
'description' => '指定镜像仓库名称。'."\n"
.'> 该参数仅部署物为容器镜像部署物和HelmChart部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'wordpress',
],
'RepoId' => [
'description' => '镜像仓库ID。'."\n"
."\n"
.'您可以通过调用[ListAcrImageRepositories - 查看已上传至ACR的镜像列表](~~2539919~~)获取镜像仓库ID。'."\n"
.'> 该参数仅部署物为容器镜像部署物和HelmChart部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'crr-d8o1nponyc2t****',
],
'Tag' => [
'description' => '镜像仓库对应的版本。'."\n"
."\n"
.'您可以通过调用[ListAcrImageTags - 查看镜像仓库中已上传的镜像版本](~~2539920~~)获取镜像仓库对应的版本。'."\n"
."\n"
.'> 该参数仅部署物为容器镜像部署物和HelmChart部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'v1',
],
'RepoType' => [
'description' => '仓库类型:Public/Private',
'type' => 'string',
'required' => false,
'example' => 'Public',
],
],
'required' => false,
],
],
[
'name' => 'SupportRegionIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '支持镜像分发的地域。',
'type' => 'array',
'items' => [
'description' => '支持镜像分发的地域。'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
'required' => false,
'maxItems' => 30,
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-acfm2jfvb7b****',
],
],
[
'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' => 100,
],
],
[
'name' => 'ArtifactBuildProperty',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '部署物构建内容,用于托管构建部署物',
'type' => 'object',
'properties' => [
'CommandType' => [
'description' => '命令类型。取值范围:'."\n"
."\n"
.'- RunBatScript:命令为在Windows实例中运行的Bat脚本。'."\n"
.'- RunPowerShellScript:命令为在Windows实例中运行的PowerShell脚本。'."\n"
.'- RunShellScript:命令为在Linux实例中运行的Shell脚本。'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'RunShellScript',
],
'CommandContent' => [
'description' => '命令内容。'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'echo "start run command"',
],
'SourceImageId' => [
'description' => '源镜像ID。支持两种类型:'."\n"
.'- 镜像ID:直接传入Ecs镜像的镜像ID。'."\n"
.'- oos公共参数名称:支持通过oos公共参数名称自动获取该参数对应的镜像ID。'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => '镜像ID:m-t4nhenrdc38pe4*****'."\n"
.'ubuntu_22_04_x64_20G_alibase_20240926.vhd'."\n"
.'oos公共参数名称:aliyun/services/computenest/images/aliyun_3_2104_python_3_11',
],
'RegionId' => [
'description' => '源镜像所在的地域ID'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
'CodeRepo' => [
'description' => '代码仓库地址。'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为Dockerfile或Buildpacks时可设置。',
'type' => 'object',
'properties' => [
'Platform' => [
'description' => '代码仓库所在平台。取值范围:'."\n"
.'- github'."\n"
.'- gitee'."\n"
.'- gitlab'."\n"
.'- codeup',
'type' => 'string',
'required' => false,
'example' => 'github',
],
'RepoName' => [
'description' => '仓库名称。',
'type' => 'string',
'required' => false,
'example' => 'aliyun-computenest/quickstart-Lobexxx',
],
'Owner' => [
'description' => '代码仓库的拥有者。'."\n"
."\n"
.'> 该参数仅代码仓库为私有仓库时需填写。',
'type' => 'string',
'required' => false,
'example' => 'aliyun-computenest',
],
'Branch' => [
'description' => '代码仓库分支名称。',
'type' => 'string',
'required' => false,
'example' => 'main',
],
'Endpoint' => [
'description' => '终端节点。gitlab私有部署时需要传入。',
'type' => 'string',
'required' => false,
'example' => 'http://121.40.25.0',
],
'OrgId' => [
'description' => '组织ID。',
'type' => 'string',
'required' => false,
'example' => '455231'."\n",
],
'RepoId' => [
'description' => '仓库ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '103'."\n",
],
],
'required' => false,
],
'DockerfilePath' => [
'description' => 'Dockerfile文件在代码仓库中的相对地址。'."\n"
."\n"
.'默认值:Dockerfile'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为Dockerfile时可设置。',
'type' => 'string',
'required' => false,
'example' => './file/Dockerfile',
],
'BuildArgs' => [
'description' => '构建参数。'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为Dockerfile时可设置。',
'type' => 'array',
'items' => [
'description' => '用于docker build --build-arg',
'type' => 'object',
'properties' => [
'ArgumentName' => [
'description' => '构建参数的name。',
'type' => 'string',
'required' => false,
'example' => 'ENV',
],
'ArgumentValue' => [
'description' => '构建参数的value。',
'type' => 'string',
'required' => false,
'example' => 'nginx:latest',
],
],
'required' => false,
],
'required' => false,
],
'SourceContainerImage' => [
'description' => '源容器镜像的拉取地址。'."\n"
."\n"
.'用于docker pull ${SourceContainerImage}'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为ContainerImage时可设置。',
'type' => 'string',
'required' => false,
'example' => 'pytorch/pytorch:2.5.1-cuda12.4-cudnn9-devel'."\n",
],
'SystemDiskSize' => [
'description' => '系统盘大小,单位:GiB。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '40',
],
'EnableGpu' => [
'description' => '是否需求Gpu。默认使用Cpu实例',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
'required' => false,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '幂等性校验。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C',
],
'ArtifactId' => [
'description' => '部署物ID。',
'type' => 'string',
'example' => 'artifact-eea08d1e2d3a43ae****',
],
'ArtifactType' => [
'description' => '部署物类型。',
'type' => 'string',
'example' => 'EcsImage',
],
'Name' => [
'description' => '部署物名称。',
'type' => 'string',
'example' => 'Redhat8_5镜像',
],
'VersionName' => [
'description' => '部署物名称。',
'type' => 'string',
'example' => 'v1',
],
'ArtifactVersion' => [
'description' => '部署物版本。',
'type' => 'string',
'example' => '2',
],
'Description' => [
'description' => '部署物描述。',
'type' => 'string',
'example' => 'Redhat8_0镜像',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2022-11-11T12:00:00Z',
],
'Status' => [
'description' => '部署物状态。',
'type' => 'string',
'example' => 'Created',
],
'MaxVersion' => [
'description' => '部署物的最新版本。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'ArtifactProperty' => [
'description' => '部署物内容。',
'type' => 'string',
'example' => '{\\"CommodityCode\\":\\"cmjj0005****\\",\\"CommodityVersion\\":\\"V2022****\\"}',
],
'SupportRegionIds' => [
'description' => '部署物分发的地域ID。',
'type' => 'string',
'example' => '['."\n"
.' "cn-beijing",'."\n"
.' "cn-hangzhou",'."\n"
.' "cn-shanghai"'."\n"
.' ]',
],
'StatusDetail' => [
'description' => '部署物的状态描述。',
'type' => 'string',
'example' => '"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found"',
],
'ArtifactBuildProperty' => [
'description' => '部署物构建内容,用于托管构建部署物。',
'type' => 'string',
'example' => '"{\\"RegionId\\":\\"xxx\\", \\"SourceImageId\\":\\"xxx\\", \\"\\":\\"xxx\\", \\"CommandType\\":\\"xxx\\", \\"CommandContent\\":\\"xxx\\"}"',
],
'ArtifactBuildType' => [
'description' => '构建部署物类型。',
'type' => 'string',
'example' => 'Dockerfile',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C\\",\\n \\"ArtifactId\\": \\"artifact-eea08d1e2d3a43ae****\\",\\n \\"ArtifactType\\": \\"EcsImage\\",\\n \\"Name\\": \\"Redhat8_5镜像\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"ArtifactVersion\\": \\"2\\",\\n \\"Description\\": \\"Redhat8_0镜像\\",\\n \\"GmtModified\\": \\"2022-11-11T12:00:00Z\\",\\n \\"Status\\": \\"Created\\",\\n \\"MaxVersion\\": 1,\\n \\"ArtifactProperty\\": \\"{\\\\\\\\\\\\\\"CommodityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cmjj0005****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CommodityVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"V2022****\\\\\\\\\\\\\\"}\\",\\n \\"SupportRegionIds\\": \\"[\\\\n\\\\t\\\\t\\\\t\\\\\\"cn-beijing\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"cn-shanghai\\\\\\"\\\\n\\\\t\\\\t]\\",\\n \\"StatusDetail\\": \\"\\\\\\"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found\\\\\\"\\",\\n \\"ArtifactBuildProperty\\": \\"\\\\\\"{\\\\\\\\\\\\\\"RegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"SourceImageId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"ArtifactBuildType\\": \\"Dockerfile\\"\\n}","type":"json"}]',
'title' => '创建部署物',
],
'DeleteArtifact' => [
'summary' => '当您不再需要部署物或部署物对应版本,调用DeleteArtifact删除部署物',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132198',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
],
'parameters' => [
[
'name' => 'ArtifactId',
'in' => 'query',
'schema' => [
'description' => '部署物ID。'."\n"
."\n"
.'您可以通过[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物ID。',
'type' => 'string',
'required' => true,
'example' => 'artifact-eea08d1e2d3a43aexxxx',
],
],
[
'name' => 'ArtifactVersion',
'in' => 'query',
'schema' => [
'description' => '部署物版本。'."\n"
."\n"
.'您可以通过[ListArtifactVersions - 查询部署物版本信息](~~469995~~)获取部署物版本。',
'type' => 'string',
'required' => false,
'example' => '2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1B3AD3CC-E938-5042-A771-7FD9A2FE03F3',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3AD3CC-E938-5042-A771-7FD9A2FE03F3\\"\\n}","type":"json"}]',
'title' => '删除部署物',
],
'UpdateArtifact' => [
'summary' => '调用UpdateArtifact更新部署物',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132193',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
],
'parameters' => [
[
'name' => 'ArtifactId',
'in' => 'query',
'schema' => [
'description' => '部署物ID。'."\n"
."\n"
.'您可以通过调用[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物ID。',
'type' => 'string',
'required' => true,
'example' => 'artifact-eea08d1e2d3a43ae****',
],
],
[
'name' => 'VersionName',
'in' => 'query',
'schema' => [
'description' => '部署物版本名称。',
'type' => 'string',
'required' => false,
'example' => 'v1',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '部署物描述。',
'type' => 'string',
'required' => false,
'example' => 'Redhat8_0镜像',
],
],
[
'name' => 'ArtifactProperty',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '部署物内容。',
'type' => 'object',
'properties' => [
'Url' => [
'description' => '文件部署物URL。'."\n"
."\n"
.'您可以通过[对象存储控制台](https://oss.console.aliyun.com/bucket)上传并获取文件URL.',
'type' => 'string',
'required' => false,
'example' => 'https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852865****/template/2e1ce8fc-****-481c-9e8e-789ba9db487d.json',
],
'RegionId' => [
'description' => '镜像地域。'."\n"
."\n"
.'> 该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
'ImageId' => [
'description' => '镜像ID。'."\n"
."\n"
.'当您选定RegionId时,您可以调用[DescribeImages - 查询可以使用的镜像资源](~~2679797~~)查看指定地域下可用的镜像ID。'."\n"
."\n"
.'> 该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'm-0xij191j9cuev6uc****',
],
'CommodityCode' => [
'description' => '云市场商品code。'."\n"
."\n"
.'您可以通过[云市场控制台](https://market.console.aliyun.com/?spm=a2c4g.11186623.0.0.599d6787eMBBxu#/apiTools?_k=d7j8gk)获取商品Code。'."\n"
."\n"
.'> 该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'cmjj00****',
],
'CommodityVersion' => [
'description' => '云市场商品版本。'."\n"
."\n"
.'您可以通过[云市场页面](https://market.aliyun.com/?spm=5176.24779694.0.0.b2144d22sksKM5)查看云市场商品版本。'."\n"
."\n\n"
.'> 该参数仅部署物为镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'V1.0',
],
'RepoName' => [
'description' => '指定镜像仓库名称。'."\n"
.'> 该参数仅部署物为容器镜像部署物和HelmChart部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'wordpress',
],
'RepoId' => [
'description' => '镜像仓库ID。'."\n"
."\n"
.'您可以通过调用[ListAcrImageRepositories - 查看已上传至ACR的镜像列表](~~2539919~~)获取镜像仓库ID。'."\n"
.'> 该参数仅部署物为容器镜像部署物和HelmChart部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'crr-d8o1nponyc2t****',
],
'Tag' => [
'description' => '镜像仓库对应的版本。'."\n"
."\n"
.'您可以通过调用[ListAcrImageTags - 查看镜像仓库中已上传的镜像版本](~~2539920~~)获取镜像仓库对应的版本。'."\n"
."\n"
.'> 该参数仅部署物为容器镜像部署物和HelmChart部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'v1',
],
'RepoType' => [
'description' => '仓库权限类型,取值:'."\n"
."\n"
.'- `Public`:公开仓库'."\n"
."\n"
.'- `Private`:私有仓库'."\n"
.'> 该参数仅部署物为容器镜像部署物和HelmChart部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'Public',
],
],
'required' => false,
],
],
[
'name' => 'SupportRegionIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '支持镜像分发的地域ID。',
'type' => 'array',
'items' => [
'description' => '支持镜像分发的地域ID。'."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => '["cn-hangzhou","cn-beijing"]',
],
'required' => false,
'maxItems' => 30,
],
],
[
'name' => 'ArtifactBuildProperty',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '部署物构建内容,用于托管构建部署物',
'type' => 'object',
'properties' => [
'CommandType' => [
'description' => '命令类型。取值范围:'."\n"
."\n"
.'- RunBatScript:命令为在Windows实例中运行的Bat脚本。'."\n"
.'- RunPowerShellScript:命令为在Windows实例中运行的PowerShell脚本。'."\n"
.'- RunShellScript:命令为在Linux实例中运行的Shell脚本。'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'RunShellScript',
],
'CommandContent' => [
'description' => '命令内容。'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'echo "start run command"',
],
'SourceImageId' => [
'description' => '源镜像ID。支持两种类型:'."\n"
.'- 镜像ID:直接传入Ecs镜像的镜像ID。'."\n"
.'- oos公共参数名称:支持通过oos公共参数名称自动获取该参数对应的镜像ID。'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => '镜像ID:m-t4nhenrdc38pe4*****'."\n"
.'ubuntu_22_04_x64_20G_alibase_20240926.vhd'."\n"
.'oos公共参数名称:aliyun/services/computenest/images/aliyun_3_2104_python_3_11',
],
'RegionId' => [
'description' => '源镜像所在的地域ID'."\n"
."\n"
.'> 该参数仅部署物为ECS镜像部署物时可设置。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
'CodeRepo' => [
'description' => '代码仓库地址。'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为Dockerfile或Buildpacks时可设置。',
'type' => 'object',
'properties' => [
'Platform' => [
'description' => '代码仓库所在平台。取值范围:'."\n"
.'- github'."\n"
.'- gitee'."\n"
.'- gitlab'."\n"
.'- codeup',
'type' => 'string',
'required' => false,
'example' => 'github',
],
'RepoName' => [
'description' => '仓库名称。',
'type' => 'string',
'required' => false,
'example' => 'aliyun-computenest/quickstart-Lobexxx',
],
'Owner' => [
'description' => '代码仓库的拥有者。'."\n"
."\n"
.'> 该参数仅代码仓库为私有仓库时需填写。',
'type' => 'string',
'required' => false,
'example' => 'aliyun-computenest',
],
'Branch' => [
'description' => '代码仓库分支名称。',
'type' => 'string',
'required' => false,
'example' => 'main'."\n",
],
'Endpoint' => [
'description' => '终端节点。gitlab私有部署时需要传入。',
'type' => 'string',
'required' => false,
'example' => 'http://121.40.25.0',
],
'OrgId' => [
'description' => '组织ID。',
'type' => 'string',
'required' => false,
'example' => '455231',
],
'RepoId' => [
'description' => '仓库ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '103',
],
],
'required' => false,
],
'DockerfilePath' => [
'description' => 'Dockerfile文件在代码仓库中的相对地址。'."\n"
."\n"
.'默认值:Dockerfile'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为Dockerfile时可设置。',
'type' => 'string',
'required' => false,
'example' => './file/Dockerfile',
],
'BuildArgs' => [
'description' => '构建参数。'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为Dockerfile时可设置。',
'type' => 'array',
'items' => [
'description' => '用于docker build --build-arg',
'type' => 'object',
'properties' => [
'ArgumentName' => [
'description' => '构建参数的name。',
'type' => 'string',
'required' => false,
'example' => 'ENV'."\n",
],
'ArgumentValue' => [
'description' => '构建参数的value。',
'type' => 'string',
'required' => false,
'example' => 'nginx:latest',
],
],
'required' => false,
],
'required' => false,
],
'SourceContainerImage' => [
'description' => '源容器镜像的拉取地址。'."\n"
."\n"
.'用于docker pull ${SourceContainerImage}'."\n"
."\n"
.'> 该参数仅ArtifactBuildType为ContainerImage时可设置。',
'type' => 'string',
'required' => false,
'example' => 'pytorch/pytorch:2.5.1-cuda12.4-cudnn9-devel',
],
'SystemDiskSize' => [
'description' => '系统盘大小。单位:GiB。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '40',
],
'EnableGpu' => [
'description' => '是否需求Gpu。默认使用Cpu实例',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
'required' => false,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'PermissionType',
'in' => 'query',
'schema' => [
'description' => '权限字段,针对容器镜像部署物、HelmChart部署物有效。仅能从Automatic变为Public。'."\n"
.'可选值:'."\n"
.'- Public'."\n"
.'- Automatic',
'type' => 'string',
'required' => false,
'example' => 'Public',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9F350409-2ACC-5B61-ACD9-3C8995792F8F',
],
'ArtifactId' => [
'description' => '部署物ID。',
'type' => 'string',
'example' => 'artifact-eea08d1e2d3a43ae****',
],
'ArtifactType' => [
'description' => '部署物类型。',
'type' => 'string',
'example' => 'EcsImage',
],
'VersionName' => [
'description' => '部署物名称。',
'type' => 'string',
'example' => 'v1',
],
'ArtifactVersion' => [
'description' => '部署物版本。',
'type' => 'string',
'example' => '2',
],
'Description' => [
'description' => '部署物描述。',
'type' => 'string',
'example' => 'Redhat8_0镜像',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2022-10-20T02:19:55Z',
],
'Status' => [
'description' => '部署物的状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Created:已创建。'."\n"
."\n"
.'- Scanning:扫描中。'."\n"
."\n"
.'- ScanFailed:扫描失败。'."\n"
."\n"
.'- Delivering:分发中。'."\n"
."\n"
.'- Available:可使用。'."\n"
."\n"
.'- Deleted:已删除。',
'type' => 'string',
'example' => 'Available',
],
'ArtifactProperty' => [
'description' => '部署物内容。',
'type' => 'string',
'example' => '{\\"CommodityCode\\":\\"cmjj0005****\\",\\"CommodityVersion\\":\\"V2022****\\"}',
],
'SupportRegionIds' => [
'description' => '部署物支持分发的地域ID。',
'type' => 'string',
'example' => '['."\n"
.' "cn-beijing",'."\n"
.' "cn-hangzhou",'."\n"
.' "cn-shanghai"'."\n"
.' ]',
],
'ArtifactBuildProperty' => [
'description' => '部署物构建内容,用于托管构建部署物。',
'type' => 'string',
'example' => '"{\\"RegionId\\":\\"xxx\\", \\"SourceImageId\\":\\"xxx\\", \\"\\":\\"xxx\\", \\"CommandType\\":\\"xxx\\", \\"CommandContent\\":\\"xxx\\"}"',
],
'StatusDetail' => [
'description' => '部署物的状态描述。',
'type' => 'string',
'example' => '"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found"'."\n",
],
'ArtifactBuildType' => [
'description' => '部署物构建内容,用于托管构建部署物。',
'type' => 'string',
'example' => '"{\\"RegionId\\":\\"xxx\\", \\"SourceImageId\\":\\"xxx\\", \\"\\":\\"xxx\\", \\"CommandType\\":\\"xxx\\", \\"CommandContent\\":\\"xxx\\"}"'."\n",
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F350409-2ACC-5B61-ACD9-3C8995792F8F\\",\\n \\"ArtifactId\\": \\"artifact-eea08d1e2d3a43ae****\\",\\n \\"ArtifactType\\": \\"EcsImage\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"ArtifactVersion\\": \\"2\\",\\n \\"Description\\": \\"Redhat8_0镜像\\",\\n \\"GmtModified\\": \\"2022-10-20T02:19:55Z\\",\\n \\"Status\\": \\"Available\\",\\n \\"ArtifactProperty\\": \\"{\\\\\\\\\\\\\\"CommodityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cmjj0005****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CommodityVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"V2022****\\\\\\\\\\\\\\"}\\",\\n \\"SupportRegionIds\\": \\"[\\\\n\\\\t\\\\t\\\\t\\\\\\"cn-beijing\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"cn-shanghai\\\\\\"\\\\n\\\\t\\\\t]\\",\\n \\"ArtifactBuildProperty\\": \\"\\\\\\"{\\\\\\\\\\\\\\"RegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"SourceImageId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"StatusDetail\\": \\"\\\\\\"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found\\\\\\"\\\\n\\",\\n \\"ArtifactBuildType\\": \\"\\\\\\"{\\\\\\\\\\\\\\"RegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"SourceImageId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\\\\\"\\\\n\\"\\n}","type":"json"}]',
'title' => '更新部署物',
],
'DeleteAcrImageTags' => [
'summary' => '删除Acr容器镜像版本',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '160457',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'RepoId',
'in' => 'query',
'schema' => [
'description' => '镜像仓库id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'crr-3gqhkza0wbxxxxxx',
],
],
[
'name' => 'Tag',
'in' => 'query',
'schema' => [
'description' => '容器镜像标签',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1.0',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '788E7CP0EN9D51P',
],
],
[
'name' => 'ArtifactType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '部署物类型。默认值为:AcrImage。可能的值:'."\n"
."\n"
.'- HelmChart:Helm Chart镜像。'."\n"
."\n"
.'- AcrImage:容器镜像。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'AcrImage',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C\\"\\n}","type":"json"}]',
'title' => '删除容器镜像版本',
'description' => '### 前提条件'."\n"
.'删除前请确保已删除容器镜像对应的部署物,删除后对应的部署物会无法使用',
],
'GetArtifact' => [
'summary' => '调用GetArtifact查询部署物详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132197',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
],
'parameters' => [
[
'name' => 'ArtifactId',
'in' => 'query',
'schema' => [
'description' => '部署物ID。'."\n"
."\n"
.'您可以通过调用[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物ID。',
'type' => 'string',
'required' => false,
'example' => 'artifact-eea08d1e2d3a43ae****',
],
],
[
'name' => 'ArtifactVersion',
'in' => 'query',
'schema' => [
'description' => '部署物版本。'."\n"
."\n"
.'您可以通过调用[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物版本。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'ArtifactName',
'in' => 'query',
'schema' => [
'description' => '部署物名称。'."\n"
."\n"
.'您可以通过调用[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物名称。',
'type' => 'string',
'required' => false,
'example' => 'gpu-test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C',
],
'ArtifactId' => [
'description' => '部署物ID。',
'type' => 'string',
'example' => 'artifact-eea08d1e2d3a43ae****',
],
'ArtifactType' => [
'description' => '部署物类型。',
'type' => 'string',
'example' => 'EcsImage',
],
'Name' => [
'description' => '部署物名称。',
'type' => 'string',
'example' => 'Redhat8_5镜像',
],
'VersionName' => [
'description' => '部署物版本名称。',
'type' => 'string',
'example' => 'v1',
],
'ArtifactVersion' => [
'description' => '部署物版本。',
'type' => 'string',
'example' => '2',
],
'Description' => [
'description' => '部署物描述。',
'type' => 'string',
'example' => 'Redhat8_0镜像',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2022-10-20T02:19:55Z',
],
'Status' => [
'description' => '部署物状态。',
'type' => 'string',
'example' => 'Available',
],
'MaxVersion' => [
'description' => '最新版本。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'ArtifactProperty' => [
'description' => '部署物属性。',
'type' => 'string',
'example' => '{\\"CommodityCode\\":\\"cmjj0005****\\",\\"CommodityVersion\\":\\"V2022****\\"}',
],
'SupportRegionIds' => [
'description' => '部署物支持的地域ID。',
'type' => 'string',
'example' => '["cn-hangzhou","cn-beijing"]',
],
'Progress' => [
'description' => '部署物分发进度。',
'type' => 'string',
'example' => '100',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-acfmzmhzoaa****',
],
'Tags' => [
'description' => '部署物标签。',
'type' => 'array',
'items' => [
'description' => '部署物标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '部署物标签键。',
'type' => 'string',
'example' => 'key1',
],
'Value' => [
'description' => '部署物标签值。',
'type' => 'string',
'example' => 'value1',
],
],
],
],
'ArtifactBuildProperty' => [
'description' => '部署物构建内容,用于托管构建部署物。',
'type' => 'string',
'example' => '"{\\"RegionId\\":\\"xxx\\", \\"SourceImageId\\":\\"xxx\\", \\"\\":\\"xxx\\", \\"CommandType\\":\\"xxx\\", \\"CommandContent\\":\\"xxx\\"}"',
],
'StatusDetail' => [
'description' => '部署物的状态描述。',
'type' => 'string',
'example' => '"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found"',
],
'ArtifactBuildType' => [
'description' => '构建部署物类型。',
'type' => 'string',
'example' => 'Dockerfile'."\n",
],
'PermissionType' => [
'description' => '权限字段,针对容器镜像部署物、HelmChart部署物有效。 可选值:'."\n"
.'- Public'."\n"
.'- Automatic',
'type' => 'string',
'example' => 'Public',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C\\",\\n \\"ArtifactId\\": \\"artifact-eea08d1e2d3a43ae****\\",\\n \\"ArtifactType\\": \\"EcsImage\\",\\n \\"Name\\": \\"Redhat8_5镜像\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"ArtifactVersion\\": \\"2\\",\\n \\"Description\\": \\"Redhat8_0镜像\\",\\n \\"GmtModified\\": \\"2022-10-20T02:19:55Z\\",\\n \\"Status\\": \\"Available\\",\\n \\"MaxVersion\\": 2,\\n \\"ArtifactProperty\\": \\"{\\\\\\\\\\\\\\"CommodityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cmjj0005****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CommodityVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"V2022****\\\\\\\\\\\\\\"}\\",\\n \\"SupportRegionIds\\": \\"[\\\\\\"cn-hangzhou\\\\\\",\\\\\\"cn-beijing\\\\\\"]\\",\\n \\"Progress\\": \\"100\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzmhzoaa****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ArtifactBuildProperty\\": \\"\\\\\\"{\\\\\\\\\\\\\\"RegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"SourceImageId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"StatusDetail\\": \\"\\\\\\"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found\\\\\\"\\",\\n \\"ArtifactBuildType\\": \\"Dockerfile\\\\n\\",\\n \\"PermissionType\\": \\"Public\\"\\n}","type":"json"}]',
'title' => '查询部署物详情',
],
'ListArtifacts' => [
'summary' => '调用ListArtifacts查询部署物列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132194',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
],
'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/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hRQzE=',
],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '过滤器。',
'type' => 'array',
'items' => [
'description' => '过滤器。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '过滤器名称。可选择一个或多个名称进行查询。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Name:按部署物名称进行模糊查询。'."\n"
."\n"
.'- ArtifactId:部署物ID。'."\n"
."\n"
.'- ArtifactType:部署物类型。',
'type' => 'string',
'required' => false,
'example' => 'ArtifactType',
],
'Values' => [
'description' => '过滤器值列表。',
'type' => 'array',
'items' => [
'description' => '过滤器值列表。N取值范围为:1~10。',
'type' => 'string',
'required' => false,
'example' => 'File',
],
'required' => false,
'maxItems' => 20,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-acfmzmhzoaa****',
],
],
[
'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' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B7AE429-B53E-5E73-A5EC-DC91F614F2D9',
],
'NextToken' => [
'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
'type' => 'string',
'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hR****',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '符合条件的记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Artifacts' => [
'description' => '部署物列表信息。',
'type' => 'array',
'items' => [
'description' => '部署物列表信息。',
'type' => 'object',
'properties' => [
'ArtifactId' => [
'description' => '部署物ID。',
'type' => 'string',
'example' => 'artifact-eea08d1e2d3a43aexxxx',
],
'ArtifactType' => [
'description' => '部署物类型。',
'type' => 'string',
'example' => 'EcsImage',
],
'Name' => [
'description' => '部署物名称。',
'type' => 'string',
'example' => 'Redhat8_5镜像',
],
'MaxVersion' => [
'description' => '最新版本。',
'type' => 'string',
'example' => '2',
],
'Description' => [
'description' => '部署物描述。',
'type' => 'string',
'example' => 'Redhat8_0镜像',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2022-10-20T02:19:55Z',
],
'Status' => [
'description' => '部署物的状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Created:已创建。'."\n"
."\n"
.'- Scanning:扫描中。'."\n"
."\n"
.'- ScanFailed:扫描失败。'."\n"
."\n"
.'- Delivering:分发中。'."\n"
."\n"
.'- Available:可使用。'."\n"
."\n"
.'- Deleted:已删除。',
'type' => 'string',
'example' => 'Created',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-acfmzmhzoaa****',
],
'Tags' => [
'description' => '标签值。',
'type' => 'array',
'items' => [
'description' => '标签值。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'key1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'value1',
],
],
],
],
'ArtifactBuildProperty' => [
'description' => '部署物构建内容,用于托管构建部署物。',
'type' => 'string',
'example' => '{\\"CodeRepo\\":{\\"Owner\\":\\"wenle\\",\\"Platform\\":\\"github\\",\\"Branch\\":\\"main\\",\\"RepoName\\":\\"heroku/node-js-getting-started\\"}}',
],
'PermissionType' => [
'description' => '权限字段,针对容器镜像部署物、HelmChart部署物、文件部署物有效。非文件部署物仅能从Automatic变为Public。'."\n"
.'可选值:'."\n"
.'- Public'."\n"
.'- Automatic',
'type' => 'string',
'example' => 'Public',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B7AE429-B53E-5E73-A5EC-DC91F614F2D9\\",\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hR****\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Artifacts\\": [\\n {\\n \\"ArtifactId\\": \\"artifact-eea08d1e2d3a43aexxxx\\",\\n \\"ArtifactType\\": \\"EcsImage\\",\\n \\"Name\\": \\"Redhat8_5镜像\\",\\n \\"MaxVersion\\": \\"2\\",\\n \\"Description\\": \\"Redhat8_0镜像\\",\\n \\"GmtModified\\": \\"2022-10-20T02:19:55Z\\",\\n \\"Status\\": \\"Created\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzmhzoaa****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ArtifactBuildProperty\\": \\"{\\\\\\\\\\\\\\"CodeRepo\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Owner\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"wenle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Platform\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"github\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Branch\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"main\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"RepoName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"heroku/node-js-getting-started\\\\\\\\\\\\\\"}}\\",\\n \\"PermissionType\\": \\"Public\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询部署物列表',
],
'ListArtifactVersions' => [
'summary' => '调用ListArtifactVersions查询部署物版本信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132195',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
],
'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/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hR****',
],
],
[
'name' => 'ArtifactId',
'in' => 'query',
'schema' => [
'description' => '部署物ID。'."\n"
."\n"
.'您可以通过调用[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物ID。',
'type' => 'string',
'required' => true,
'example' => 'artifact-eea08d1e2d3a43ae****',
],
],
[
'name' => 'Filters',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '过滤器。',
'type' => 'array',
'items' => [
'description' => '过滤器。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n"
."\n"
.'**Status**:按部署物状态过滤。',
'type' => 'string',
'required' => false,
'example' => 'Status'."\n",
],
'Values' => [
'description' => '过滤器值列表。',
'type' => 'array',
'items' => [
'description' => '过滤器值列表。N的取值范围:1~10。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C',
],
'NextToken' => [
'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
'type' => 'string',
'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hR****',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '符合条件的记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Artifacts' => [
'description' => '部署物版本信息。',
'type' => 'array',
'items' => [
'description' => '部署物版本信息。',
'type' => 'object',
'properties' => [
'ArtifactId' => [
'description' => '部署物ID。',
'type' => 'string',
'example' => 'artifact-eea08d1e2d3a43ae****',
],
'ArtifactType' => [
'description' => '部署物类型。',
'type' => 'string',
'example' => 'EcsImage',
],
'VersionName' => [
'description' => '部署物版本名称。',
'type' => 'string',
'example' => 'v1',
],
'ArtifactVersion' => [
'description' => '部署物版本。',
'type' => 'string',
'example' => '2',
],
'Status' => [
'description' => '部署物的状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Created:已创建。'."\n"
."\n"
.'- Scanning:扫描中。'."\n"
."\n"
.'- ScanFailed:扫描失败。'."\n"
."\n"
.'- Delivering:分发中。'."\n"
."\n"
.'- Available:可使用。'."\n"
."\n"
.'- Deleted:已删除。',
'type' => 'string',
'example' => 'Available',
],
'ArtifactProperty' => [
'description' => '部署物属性。',
'type' => 'string',
'example' => '{\\"CommodityCode\\":\\"cmjj0005****\\",\\"CommodityVersion\\":\\"V2022****\\"}',
],
'SupportRegionIds' => [
'description' => '部署物分发的地域ID。',
'type' => 'string',
'example' => '['."\n"
.' "cn-beijing",'."\n"
.' "cn-hangzhou",'."\n"
.' "cn-shanghai"'."\n"
.' ]',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2022-10-20T02:19:55Z',
],
'Progress' => [
'description' => '部署物分发进度。',
'type' => 'string',
'example' => '100',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2022-10-20T02:19:53Z',
],
'ImageDelivery' => [
'description' => '镜像分发结果。',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
'example' => '{'."\n"
.' "cn-beijing":"m-2ze9swf380tsad9w****",'."\n"
.' "cn-shanghai":"m-uf6d2kp5yb3fuq6i****",'."\n"
.' "cn-hangzhou":"m-bp1co0b2dkon58mo****"'."\n"
.' }',
'description' => '镜像分发结果。',
],
],
'SecurityAuditResult' => [
'description' => '安全扫描结果。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Normal:正常状态(无风险)。'."\n"
."\n"
.'- AtRisk:存在安全风险。'."\n"
."\n"
.'- Processing:进行中。',
'type' => 'string',
'example' => 'Normal',
],
'ResultFile' => [
'description' => '安全扫描结果文件。',
'type' => 'string',
'example' => '仅当安全扫描结果的返回值为AtRisk时才会展示。',
],
'StatusDetail' => [
'description' => '部署物的状态描述。',
'type' => 'string',
'example' => '"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found"',
],
'ArtifactBuildProperty' => [
'description' => '部署物构建内容,用于托管构建部署物。',
'type' => 'string',
'example' => '"{\\"RegionId\\":\\"xxx\\", \\"SourceImageId\\":\\"xxx\\", \\"\\":\\"xxx\\", \\"CommandType\\":\\"xxx\\", \\"CommandContent\\":\\"xxx\\"}"',
],
'ArtifactBuildType' => [
'description' => '构建部署物类型。',
'type' => 'string',
'example' => 'Dockerfile',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hR****\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Artifacts\\": [\\n {\\n \\"ArtifactId\\": \\"artifact-eea08d1e2d3a43ae****\\",\\n \\"ArtifactType\\": \\"EcsImage\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"ArtifactVersion\\": \\"2\\",\\n \\"Status\\": \\"Available\\",\\n \\"ArtifactProperty\\": \\"{\\\\\\\\\\\\\\"CommodityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cmjj0005****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CommodityVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"V2022****\\\\\\\\\\\\\\"}\\",\\n \\"SupportRegionIds\\": \\"[\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"cn-beijing\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"cn-shanghai\\\\\\"\\\\n\\\\t\\\\t\\\\t\\\\t]\\",\\n \\"GmtModified\\": \\"2022-10-20T02:19:55Z\\",\\n \\"Progress\\": \\"100\\",\\n \\"GmtCreate\\": \\"2022-10-20T02:19:53Z\\",\\n \\"ImageDelivery\\": {\\n \\"key\\": \\"{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"cn-beijing\\\\\\":\\\\\\"m-2ze9swf380tsad9w****\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"cn-shanghai\\\\\\":\\\\\\"m-uf6d2kp5yb3fuq6i****\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"cn-hangzhou\\\\\\":\\\\\\"m-bp1co0b2dkon58mo****\\\\\\"\\\\n\\\\t\\\\t\\\\t\\\\t}\\"\\n },\\n \\"SecurityAuditResult\\": \\"Normal\\",\\n \\"ResultFile\\": \\"仅当安全扫描结果的返回值为AtRisk时才会展示。\\",\\n \\"StatusDetail\\": \\"\\\\\\"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found\\\\\\"\\",\\n \\"ArtifactBuildProperty\\": \\"\\\\\\"{\\\\\\\\\\\\\\"RegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"SourceImageId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CommandContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"ArtifactBuildType\\": \\"Dockerfile\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询部署物版本信息',
],
'ReleaseArtifact' => [
'summary' => '调用ReleaseArtifact发布部署物',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132191',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
],
'parameters' => [
[
'name' => 'ArtifactId',
'in' => 'query',
'schema' => [
'description' => '部署物ID。'."\n"
."\n"
.'您可以通过调用[ListArtifacts - 查询部署物列表](~~469993~~)获取部署物ID。',
'type' => 'string',
'required' => true,
'example' => 'artifact-9feded91880e4c78xxxx',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '788E7CP0EN9D51P',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '86CAC31E-3527-562C-869F-347E931C9B25',
],
'ArtifactId' => [
'description' => '部署物ID。',
'type' => 'string',
'example' => 'artifact-9feded91880e4c78****',
],
'ArtifactType' => [
'description' => '部署物类型。',
'type' => 'string',
'example' => 'File',
],
'VersionName' => [
'description' => '部署物版本名称。',
'type' => 'string',
'example' => 'Oss关联升级测试',
],
'ArtifactVersion' => [
'description' => '部署物版本。',
'type' => 'string',
'example' => 'draft',
],
'Description' => [
'description' => '部署物描述。',
'type' => 'string',
'example' => 'Redhat8_0镜像',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '1650954178000',
],
'Status' => [
'description' => '部署物的状态。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'- Created:已创建。'."\n"
."\n"
.'- Scanning:扫描中。'."\n"
."\n"
.'- ScanFailed:扫描失败。'."\n"
."\n"
.'- Delivering:分发中。'."\n"
."\n"
.'- Available:可使用。'."\n"
."\n"
.'- Deleted:已删除。',
'type' => 'string',
'example' => 'Created',
],
'ArtifactProperty' => [
'description' => '部署物内容。',
'type' => 'string',
'example' => '"{\\"Url\\":\\"https://computenest-artifacts-draft-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/130920852836xxxx/cn-hangzhou/service-8072a04e5a134382xxxx/165095355xxxx/changes.txt\\",\\"ConfigurationMetadata\\":\\"{\\\\\\"WorkDir\\\\\\":\\\\\\"/root\\\\\\",\\\\\\"Platform\\\\\\":\\\\\\"Linux\\\\\\",\\\\\\"CommandType\\\\\\":\\\\\\"RunShellScript\\\\\\",\\\\\\"UpgradeScript\\\\\\":\\\\\\"cd /root\\\\\\\\ncp changes.txt cpchanges.txt\\\\\\\\nmv changes.txt mvchangge.txt\\\\\\"}\\"}"',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86CAC31E-3527-562C-869F-347E931C9B25\\",\\n \\"ArtifactId\\": \\"artifact-9feded91880e4c78****\\",\\n \\"ArtifactType\\": \\"File\\",\\n \\"VersionName\\": \\"Oss关联升级测试\\",\\n \\"ArtifactVersion\\": \\"draft\\",\\n \\"Description\\": \\"Redhat8_0镜像\\",\\n \\"GmtModified\\": \\"1650954178000\\",\\n \\"Status\\": \\"Created\\",\\n \\"ArtifactProperty\\": \\"\\\\\\"{\\\\\\\\\\\\\\"Url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://computenest-artifacts-draft-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/130920852836xxxx/cn-hangzhou/service-8072a04e5a134382xxxx/165095355xxxx/changes.txt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ConfigurationMetadata\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"WorkDir\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"/root\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Platform\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Linux\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"CommandType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"RunShellScript\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"UpgradeScript\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cd /root\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ncp changes.txt cpchanges.txt\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\nmv changes.txt mvchangge.txt\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"}\\\\\\"\\"\\n}","type":"json"}]',
'title' => '发布部署物',
'description' => '### 前提条件'."\n"
.'请确保您已创建并保存部署物。',
],
'GetUploadCredentials' => [
'summary' => '获取上传文件的访问密钥。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '178074',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '文件名称。',
'type' => 'string',
'required' => true,
'example' => 'template.yaml',
],
],
[
'name' => 'Visibility',
'in' => 'query',
'schema' => [
'description' => '上传文件所属bucket是否可公开访问。可选值:**public** 或 **private**。public:文件将上传至公开bucket;private:文件将上传至私有bucket,访问需授权。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'private' => 'private',
'public' => 'public',
],
'example' => 'public',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult',
'description' => 'PlainResult',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'AccessKeyId' => [
'title' => 'ak',
'description' => '访问密钥ID。',
'type' => 'string',
'example' => 'STS.NUCe19W1FKaHAYAhe********',
],
'AccessKeySecret' => [
'title' => 'sk',
'description' => '访问密钥secret值。',
'type' => 'string',
'example' => '8LQGp59mY23pcXeTdcvSA1cUQZBeD92sFrXi********',
],
'SecurityToken' => [
'title' => '安全token',
'description' => '安全token。',
'type' => 'string',
'example' => 'CAISzQN1q6Ft5B2yfSjIr5b2LouNuu5n/KOjQ3/wjGUHYdlagYGdmzz2IH1Le3NrBO8esfgymGFU6v8dlo1dYLQeHhadQI5cs80HtFqLSNaE65LswPlZ2M2ISETPJzfV9pCK',
],
'ExpireDate' => [
'title' => '过期时间',
'description' => '权限过期时间。',
'type' => 'string',
'example' => '2023-05-18T12:27:59Z',
],
'RegionId' => [
'title' => '地域',
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'BucketName' => [
'title' => '仓库名称',
'description' => '存储空间名称。',
'type' => 'string',
'example' => 'service-info-private',
],
'Key' => [
'title' => '文件key',
'description' => '具体的Key。',
'type' => 'string',
'example' => '221514575922756034/cn-hangzhou/d57c62fbd508xxxxxxxx.json',
],
],
],
'Success' => [
'description' => '接口调用结果标识,true表示成功,false表示失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '调用返回码。',
'type' => 'string',
'example' => '200',
],
'Message' => [
'description' => '请求返回的信息。',
'type' => 'string',
'example' => 'Success.',
],
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FCC3321E-D518-1BC4-861E-588E9D4DAFB7',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"STS.NUCe19W1FKaHAYAhe********\\",\\n \\"AccessKeySecret\\": \\"8LQGp59mY23pcXeTdcvSA1cUQZBeD92sFrXi********\\",\\n \\"SecurityToken\\": \\"CAISzQN1q6Ft5B2yfSjIr5b2LouNuu5n/KOjQ3/wjGUHYdlagYGdmzz2IH1Le3NrBO8esfgymGFU6v8dlo1dYLQeHhadQI5cs80HtFqLSNaE65LswPlZ2M2ISETPJzfV9pCK\\",\\n \\"ExpireDate\\": \\"2023-05-18T12:27:59Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BucketName\\": \\"service-info-private\\",\\n \\"Key\\": \\"221514575922756034/cn-hangzhou/d57c62fbd508xxxxxxxx.json\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"FCC3321E-D518-1BC4-861E-588E9D4DAFB7\\"\\n}","type":"json"}]',
'title' => '获取文件上传的访问密钥',
],
'GetArtifactRepositoryCredentials' => [
'summary' => '获取部署物上传所需的凭证',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ArtifactType',
'in' => 'query',
'schema' => [
'description' => '部署物类型。可能的值:'."\n"
."\n"
.'- File:Oss文件。'."\n"
."\n"
.'- AcrImage:容器镜像。',
'type' => 'string',
'required' => true,
'example' => 'File',
],
],
[
'name' => 'DeployRegionId',
'in' => 'query',
'schema' => [
'description' => '上传地域。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应数据结构。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '94E89857-B994-44B6-9C4F-DBD200E9XXXX',
],
'ExpireDate' => [
'description' => '过期时间。',
'type' => 'string',
'example' => '1526549792000',
],
'Credentials' => [
'description' => '访问凭证。',
'type' => 'object',
'properties' => [
'Username' => [
'description' => '用户名称。',
'type' => 'string',
'example' => 'xxx',
],
'Password' => [
'description' => '密码。',
'type' => 'string',
'example' => 'eyJ0aW1lIjoiMTUyNjU0OTc5:0705733****',
],
'AccessKeyId' => [
'description' => '访问密钥ID。',
'type' => 'string',
'example' => 'STS.xxx',
],
'AccessKeySecret' => [
'description' => '访问密钥secret值。',
'type' => 'string',
'example' => 'xxx',
],
'SecurityToken' => [
'description' => '安全令牌。',
'type' => 'string',
'example' => 'xxx',
],
],
],
'AvailableResources' => [
'description' => '可上传的资源信息。',
'type' => 'array',
'items' => [
'description' => '可上传的资源信息。',
'type' => 'object',
'properties' => [
'RegionId' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'RepositoryName' => [
'description' => '仓库名称。',
'type' => 'string',
'example' => 'computenest-artifacts-draft-cn-hangzhou',
],
'Path' => [
'description' => '路径。',
'type' => 'string',
'example' => '"/xxx/"',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94E89857-B994-44B6-9C4F-DBD200E9XXXX\\",\\n \\"ExpireDate\\": \\"1526549792000\\",\\n \\"Credentials\\": {\\n \\"Username\\": \\"xxx\\",\\n \\"Password\\": \\"eyJ0aW1lIjoiMTUyNjU0OTc5:0705733****\\",\\n \\"AccessKeyId\\": \\"STS.xxx\\",\\n \\"AccessKeySecret\\": \\"xxx\\",\\n \\"SecurityToken\\": \\"xxx\\"\\n },\\n \\"AvailableResources\\": [\\n {\\n \\"RegionId\\": \\"oss-cn-hangzhou\\",\\n \\"RepositoryName\\": \\"computenest-artifacts-draft-cn-hangzhou\\",\\n \\"Path\\": \\"\\\\\\"/xxx/\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '服务商获取上传部署物所需的访问凭证',
],
'ListAcrImageTags' => [
'summary' => '调用ListAcrImageTags查看镜像仓库中已上传的镜像版本',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
'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。',
'type' => 'string',
'required' => false,
'example' => 'AAAAAW8kZY+u1sYOaYf5JmgmDQQ=',
],
],
[
'name' => 'RepoId',
'in' => 'query',
'schema' => [
'description' => '镜像ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'crr-3gqhkza0wbxxxxxx',
],
],
[
'name' => 'ArtifactType',
'in' => 'query',
'schema' => [
'description' => '部署物类型。默认值为:AcrImage。可能的值:'."\n"
."\n"
.'- HelmChart:Helm Chart镜像。'."\n"
."\n"
.'- AcrImage:容器镜像。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'AcrImage',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FEF343B9-1A15-5789-BE88-7B36190F5BF6',
],
'NextToken' => [
'description' => '下一个查询开始token。',
'type' => 'string',
'example' => 'ey14..',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '总数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Images' => [
'description' => '镜像列表。',
'type' => 'array',
'items' => [
'description' => '镜像列表。',
'type' => 'object',
'properties' => [
'Tag' => [
'description' => '镜像版本。',
'type' => 'string',
'example' => '5.7.2',
],
'ImageSize' => [
'description' => '镜像大小,单位:字节(B)。',
'type' => 'string',
'example' => '188394616',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'ModifiedTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEF343B9-1A15-5789-BE88-7B36190F5BF6\\",\\n \\"NextToken\\": \\"ey14..\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 1,\\n \\"Images\\": [\\n {\\n \\"Tag\\": \\"5.7.2\\",\\n \\"ImageSize\\": \\"188394616\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-05-20T00:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查看镜像仓库中已上传的镜像版本',
],
'ListAcrImageRepositories' => [
'summary' => '调用ListAcrImageRepositories查看已上传至ACR的镜像列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '159574',
'abilityTreeNodes' => [
'FEATUREcomputenest4Y9BYP',
],
'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。',
'type' => 'string',
'required' => false,
'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU=',
],
],
[
'name' => 'RepoName',
'in' => 'query',
'schema' => [
'description' => '镜像仓库的名称。',
'type' => 'string',
'required' => false,
'example' => 'wordpress',
],
],
[
'name' => 'ArtifactType',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '部署物类型,用于区分docker和chart',
'description' => '部署物类型。默认值为:AcrImage。可能的值:'."\n"
."\n"
.'- HelmChart:Helm Chart镜像。'."\n"
."\n"
.'- AcrImage:容器镜像。',
'type' => 'string',
'required' => false,
'example' => 'AcrImage',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4A145D8-6F6C-532A-9001-9730CDA27578',
],
'NextToken' => [
'description' => '下一个查询开始token。',
'type' => 'string',
'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '总数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'Repositories' => [
'description' => '镜像列表。',
'type' => 'array',
'items' => [
'description' => '镜像列表。',
'type' => 'object',
'properties' => [
'RepoId' => [
'description' => '镜像ID。',
'type' => 'string',
'example' => 'crr-3gqhkza0wbxxxxxx',
],
'RepoName' => [
'description' => '镜像名称。',
'type' => 'string',
'example' => 'wordpress',
],
'RepoType' => [
'description' => '仓库类型:'."\n"
.'Public 公开类型'."\n"
.'Private 私有类型',
'type' => 'string',
'example' => 'Public',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'ModifiedTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2021-05-20T00:00:00Z',
],
'Namespace' => [
'description' => '命名空间',
'type' => 'string',
'example' => 'computenest',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4A145D8-6F6C-532A-9001-9730CDA27578\\",\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 4,\\n \\"Repositories\\": [\\n {\\n \\"RepoId\\": \\"crr-3gqhkza0wbxxxxxx\\",\\n \\"RepoName\\": \\"wordpress\\",\\n \\"RepoType\\": \\"Public\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"Namespace\\": \\"computenest\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查看已上传至ACR的镜像列表',
],
'CreateServiceUsage' => [
'summary' => '创建服务分销申请。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '194790',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'example' => 'service-c2d118c9193e49xxxxxx',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端token',
'type' => 'string',
'required' => false,
'example' => 'mRdxWuW2ts',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The region 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 of the request',
'type' => 'string',
'example' => 'E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E73F09DC-6C13-5CB1-A10F-7A4E125ABD2C\\"\\n}","type":"json"}]',
'title' => '创建分销申请',
],
'RejectServiceUsage' => [
'summary' => '调用RejectServiceUsage拒绝服务申请',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '138376',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'service-2117508c874c41xxxxxx',
],
],
[
'name' => 'UserAliUid',
'in' => 'query',
'schema' => [
'description' => '用户阿里云UiD。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1563457855xxxxxx',
],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => [
'description' => '审批意见。',
'type' => 'string',
'required' => false,
'example' => '感谢您的申请,请正确的填写申请信息',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '服务共享类型,默认值为SharedAccount。可选值:'."\n"
."\n"
.'- SharedAccount:普通共享类型。'."\n"
."\n"
.'- Reseller:分销共享类型。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'Reseller' => 'Reseller',
'SharedAccount' => 'SharedAccount',
],
'example' => 'SharedAccount',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'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' => '拒绝服务申请',
],
'ApproveServiceUsage' => [
'summary' => '商家调用ApproveServiceUsage通过服务使用请求',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '137563',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'service-39f4f251e94843xxxxxx',
],
],
[
'name' => 'UserAliUid',
'in' => 'query',
'schema' => [
'description' => '用户阿里云UID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '127383705958xxxx',
],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => [
'description' => '审批的备注信息。',
'type' => 'string',
'required' => false,
'example' => '欢迎使用计算巢服务',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '服务共享类型,默认值为SharedAccount。可选值:'."\n"
."\n"
.'- SharedAccount:普通共享类型。'."\n"
."\n"
.'- Reseller:分销共享类型。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'Reseller' => 'Reseller',
'SharedAccount' => 'SharedAccount',
],
'example' => 'SharedAccount',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The region 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' => '商家通过服务使用请求',
],
'ListServiceUsages' => [
'summary' => '查看用户自己当前的服务使用申请。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'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' => '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' => '过滤器值列表。N的取值范围:1~10。',
'type' => 'array',
'items' => [
'description' => '过滤器值列表。N的取值范围:1~10。',
'type' => 'string',
'required' => false,
'example' => '5',
],
'required' => false,
'maxItems' => 10,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'SupplierRole',
'in' => 'query',
'schema' => [
'description' => '服务商角色。',
'type' => 'string',
'required' => false,
'example' => 'Supplier',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'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' => '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' => '"Name": "123123",'."\n"
.' "Telephone": "18xxxxxxxx3",'."\n"
.' "EmailAddress": "texxxxxx@alia.com",'."\n"
.' "Company": "dsf",'."\n"
.' "Title": "",'."\n"
.' "Industry": "",'."\n"
.' "CustomConfig1": "xxx",'."\n"
.' "CustomConfig2": "ooo"',
'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\\": \\"\\\\\\"Name\\\\\\": \\\\\\"123123\\\\\\",\\\\n \\\\t\\\\\\"Telephone\\\\\\": \\\\\\"18xxxxxxxx3\\\\\\",\\\\n \\\\t\\\\\\"EmailAddress\\\\\\": \\\\\\"texxxxxx@alia.com\\\\\\",\\\\n \\\\t\\\\\\"Company\\\\\\": \\\\\\"dsf\\\\\\",\\\\n \\\\t\\\\\\"Title\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\t\\\\\\"Industry\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\t\\\\\\"CustomConfig1\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\t\\\\\\"CustomConfig2\\\\\\": \\\\\\"ooo\\\\\\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => '查看当前服务使用申请',
],
'AddServiceSharedAccounts' => [
'summary' => '调用AddServiceSharedAccounts新增服务的共享账号。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '116171',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=',
],
],
[
'name' => 'SharedAccounts',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务分享账户与权限。',
'type' => 'array',
'items' => [
'description' => '服务分享账户与权限。',
'type' => 'object',
'properties' => [
'UserAliUid' => [
'description' => '用户主账号的UID。',
'type' => 'string',
'required' => true,
'example' => '123456',
],
'Permission' => [
'description' => '权限类型。可能的值:'."\n"
."\n"
.'- Deployable:可部署。'."\n"
."\n"
.'- Accessible:可访问。',
'type' => 'string',
'required' => true,
'example' => ' Accessible',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'example' => 'service-63b8a060e9d54cxxxxxx',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '服务共享类型,默认值为SharedAccount。可选值:'."\n"
."\n"
.'- SharedAccount:普通共享类型。'."\n"
."\n"
.'- Reseller:分销共享类型。',
'type' => 'string',
'required' => false,
'example' => 'SharedAccount',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E2815213-EA4F-5759-8EA1-56DD051BB3FD',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2815213-EA4F-5759-8EA1-56DD051BB3FD\\"\\n}","type":"json"}]',
'title' => '新增服务共享账号',
],
'RemoveServiceSharedAccounts' => [
'summary' => '删除共享账号',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '116172',
'abilityTreeNodes' => [
'FEATUREcomputenestJ4D829',
],
'autoTest' => true,
'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,
'docRequired' => true,
'example' => 'service-0e6fca6a51a54420****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'UserAliUids',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务共享的白名单账号。',
'type' => 'array',
'items' => [
'description' => '服务共享的白名单账号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '111234445',
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '服务共享类型,默认值为SharedAccount。可选值:'."\n"
."\n"
.'- SharedAccount:普通共享类型。'."\n"
."\n"
.'- Reseller:分销共享类型。',
'type' => 'string',
'required' => false,
'example' => 'SharedAccount',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'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' => '删除共享账号',
],
'ListServiceSharedAccounts' => [
'summary' => '调用ListServiceSharedAccounts查看服务共享账号列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '116170',
'abilityTreeNodes' => [
'FEATUREcomputenestP881UH',
],
'autoTest' => true,
'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' => 'AAAAAR130adlM4fHHVSWpTca/t4=',
],
],
[
'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' => '过滤器名称。',
'type' => 'string',
'required' => false,
'example' => 'UserAliUid',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => false,
'example' => 'service-e10349089de34exxxxxx',
],
],
[
'name' => 'Permission',
'in' => 'query',
'schema' => [
'description' => '权限类型。可能的值:'."\n"
."\n"
.'- Deployable:可部署。'."\n"
."\n"
.'- Accessible:可访问。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'Deployable' => 'Deployable',
'Accessible' => 'Accessible',
],
'example' => 'Accessible',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一个查询开始token。',
'type' => 'string',
'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU=',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CA3AE512-6D30-549A-B52D-B9042CA8D515',
],
'TotalCount' => [
'description' => '符合条件的记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'ShareAccount' => [
'description' => '服务共享账号信息。',
'type' => 'array',
'items' => [
'description' => '服务共享账号信息。',
'type' => 'object',
'properties' => [
'ServiceId' => [
'description' => '服务ID。',
'type' => 'string',
'example' => 'service-e10349089de34exxxxxx',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-12-28T02:47:46.000',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2023-02-13T02:16:03.756Z',
],
'UserAliUid' => [
'description' => '用户阿里云Uid。',
'type' => 'string',
'example' => '127383705xxxxxx',
],
'Permission' => [
'description' => '权限类型。可能的值:'."\n"
."\n"
.'- Deployable:可部署。'."\n"
."\n"
.'- Accessible:可访问。',
'type' => 'string',
'example' => 'Deployable',
],
'Name' => [
'description' => '分销商名称。',
'type' => 'string',
'example' => 'name',
],
'Logo' => [
'description' => '分销商Logo.',
'type' => 'string',
'example' => 'logo',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAWns8w4MmhzeptXVRG0PUEU=\\",\\n \\"RequestId\\": \\"CA3AE512-6D30-549A-B52D-B9042CA8D515\\",\\n \\"TotalCount\\": 1,\\n \\"MaxResults\\": 20,\\n \\"ShareAccount\\": [\\n {\\n \\"ServiceId\\": \\"service-e10349089de34exxxxxx\\",\\n \\"CreateTime\\": \\"2021-12-28T02:47:46.000\\",\\n \\"UpdateTime\\": \\"2023-02-13T02:16:03.756Z\\",\\n \\"UserAliUid\\": \\"127383705xxxxxx\\",\\n \\"Permission\\": \\"Deployable\\",\\n \\"Name\\": \\"name\\",\\n \\"Logo\\": \\"logo\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取服务共享账号列表',
],
'UpdateSharedAccountPermission' => [
'summary' => '调用UpdateSharedAccountPermission更新共享账号的权限',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '116173',
'abilityTreeNodes' => [
'FEATUREcomputenestQKB5Y7',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '10CM943JP0EN9D51H',
],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '服务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'service-0d6e1d846e4c4axxxxxx',
],
],
[
'name' => 'UserAliUid',
'in' => 'query',
'schema' => [
'description' => '服务共享的白名单账号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '0',
'example' => '1563457855xxxxxx',
],
],
[
'name' => 'Permission',
'in' => 'query',
'schema' => [
'description' => '权限类型。可能的值:'."\n"
.'- Deployable:可部署。'."\n"
.'- Accessible:可访问。'."\n"
.'- AccessibleIncludeBeta:可访问所有版本,包括Beta版本。'."\n"
.'- DeployableIncludeBeta:可部署所有版本,包括Beta版本。'."\n"
.'- Authorized:已授权(用于分销场景)'."\n"
.'- Unauthorized:未授权(用于分销场景)',
'type' => 'string',
'required' => true,
'example' => 'Deployable',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '服务共享类型,默认值为SharedAccount。可选值:'."\n"
."\n"
.'- SharedAccount:普通共享类型。'."\n"
."\n"
.'- Reseller:分销共享类型。',
'type' => 'string',
'required' => false,
'example' => 'SharedAccount',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C68B41B4-A646-5680-8A33-67884E3823A8',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C68B41B4-A646-5680-8A33-67884E3823A8\\"\\n}","type":"json"}]',
'title' => '更新共享账号的权限',
],
'ListTagResources' => [
'summary' => '查询资源标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '145736',
'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。',
'type' => 'string',
'required' => false,
'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。可选值:'."\n"
.'- service:服务。'."\n"
."\n"
.'- serviceinstance:服务实例。'."\n"
."\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' => 'Usage',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源id。',
'type' => 'array',
'items' => [
'description' => '资源id,n的取值范围为1~50',
'type' => 'string',
'required' => false,
'example' => 'service-xxx',
],
'required' => false,
'maxItems' => 50,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一个查询开始token',
'type' => 'string',
'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=',
],
'RequestId' => [
'description' => '请求id。',
'type' => 'string',
'example' => 'A361BA9E-xxxx-xxxx-xxxx-C26E5180456E',
],
'TagResources' => [
'description' => '由资源及其标签组成的集合,包含了资源ID、资源类型和标签键值等信息。',
'type' => 'array',
'items' => [
'description' => '绑定标签的资源信息。',
'type' => 'object',
'properties' => [
'ResourceType' => [
'description' => '资源类型。可选值:'."\n"
.'- service:服务。'."\n"
."\n"
.'- serviceinstance:服务实例。'."\n"
."\n"
.'- artifact:部署物。',
'type' => 'string',
'example' => 'service',
],
'ResourceId' => [
'description' => '资源ID',
'type' => 'string',
'example' => 'service-xxx',
],
'TagKey' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'usage',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"RequestId\\": \\"A361BA9E-xxxx-xxxx-xxxx-C26E5180456E\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"service\\",\\n \\"ResourceId\\": \\"service-xxx\\",\\n \\"TagKey\\": \\"usage\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询计算巢资源和标签的绑定关系',
],
'TagResources' => [
'summary' => '调用TagResources为服务实例的资源列表统一创建并绑定标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '145740',
'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'."\n",
],
'Value' => [
'description' => '资源的标签值。',
'type' => 'string',
'required' => false,
'example' => 'Value1'."\n",
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。可能的值:'."\n"
."\n"
.'- service:服务。'."\n"
."\n"
.'- serviceinstance:服务实例。'."\n"
.'- artifact: 部署物',
'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'."\n",
],
'required' => true,
'maxItems' => 50,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'."\n",
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\\\n\\"\\n}","type":"json"}]',
'title' => '创建并绑定标签',
],
'UnTagResources' => [
'summary' => '调用UntagResources删除服务实例资源的标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '145741',
'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: 部署物',
'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'."\n",
],
'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'."\n",
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源的标签键。',
'type' => 'array',
'items' => [
'description' => '资源的标签键。',
'type' => 'string',
'required' => true,
'example' => 'Key1'."\n",
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'."\n",
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\\\n\\"\\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' => '145739',
'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='."\n",
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。可能的值:'."\n"
."\n"
.'- service:服务。'."\n"
."\n"
.'- serviceinstance:服务实例。'."\n"
.'- artifact: 部署物',
'type' => 'string',
'required' => true,
'example' => 'service'."\n",
],
],
[
'name' => 'Key',
'in' => 'query',
'schema' => [
'description' => '标签键。',
'type' => 'string',
'required' => true,
'example' => 'ECS',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
'type' => 'string',
'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38='."\n",
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '0631D623-D917-1C2D-ACD6-5B3B19XXXXXX'."\n",
],
'Values' => [
'description' => '标签值信息。',
'type' => 'array',
'items' => [
'description' => '标签值。',
'type' => 'string',
'example' => ' ['."\n"
.' 0 : "20211220"'."\n"
.']',
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAVz7BQqj2xtiNSC3d3RAD38=\\\\n\\",\\n \\"RequestId\\": \\"0631D623-D917-1C2D-ACD6-5B3B19XXXXXX\\\\n\\",\\n \\"Values\\": [\\n \\" [\\\\n 0 : \\\\\\"20211220\\\\\\"\\\\n]\\"\\n ]\\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' => '145733',
'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='."\n",
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。可能的值:'."\n"
."\n"
.'- service:服务。'."\n"
."\n"
.'- serviceinstance:服务实例。'."\n"
.'- artifact: 部署物',
'type' => 'string',
'required' => true,
'example' => 'service'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
'type' => 'string',
'example' => 'AAAAAZ9FmxgN6wKfeK/GOKRnnjU='."\n",
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8872ACE6-0297-54A4-8AAD-3A8623EC6C5D'."\n",
],
'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\\",\\n \\"RequestId\\": \\"8872ACE6-0297-54A4-8AAD-3A8623EC6C5D\\\\n\\",\\n \\"Keys\\": [\\n \\" [\\\\n 0 : \\\\\\"lzqtest-huhehaote\\\\\\"\\\\n 1 : \\\\\\"lzqros\\\\\\"\\\\n 2 : \\\\\\"aaa\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]',
'title' => '查询已有标签键信息',
],
'GetSupplierInformation' => [
'summary' => '获取服务商信息',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '42426',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
'FEATUREcomputenest1Z49ZW',
'FEATUREcomputenest21Y74A',
],
'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' => '51945B04-6AA6-410D-93BA-236E0248B104',
],
'SupplierName' => [
'description' => '服务商名称。',
'type' => 'string',
'example' => 'A公司',
],
'SupplierUrl' => [
'description' => '服务商地址。',
'type' => 'string',
'example' => 'http://www.xxx.xxx.cn',
],
'SupplierDesc' => [
'description' => '服务商描述。',
'type' => 'string',
'example' => '阿里云计算巢',
],
'OperationIp' => [
'description' => '操作IP。',
'type' => 'string',
'example' => '10.xxx.xxx.xxx/101',
],
'OperationMfaPresent' => [
'description' => '是否多因素认证设备。可能的值:'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false:否。',
'type' => 'boolean',
'example' => 'true',
],
'DeliverySettings' => [
'description' => '计算资源配置信息。',
'type' => 'object',
'properties' => [
'OssEnabled' => [
'description' => '是否开启云助手运维任务执行结果投递到OSS功能。可能的值:'."\n"
."\n"
.'- true:开启。'."\n"
."\n"
.'- false(默认值):不开启。',
'type' => 'boolean',
'example' => 'true',
],
'OssBucketName' => [
'description' => '对象存储Bucket名称。',
'type' => 'string',
'example' => 'mybucket',
],
'OssPath' => [
'description' => 'OSS路径。',
'type' => 'string',
'example' => 'path1/path2/',
],
'OssExpirationDays' => [
'description' => 'OSS续费周期,单位为:天。',
'type' => 'integer',
'format' => 'int64',
'example' => '7',
],
],
],
'SupplierLogo' => [
'description' => '服务商图标。',
'type' => 'string',
'example' => 'http://example.aliyundoc.com/cover/34DB-4F4C-9373-003AA060****.png',
],
'EnableReseller' => [
'description' => '是否启用分销商。可能的值:'."\n"
."\n"
.'- true:启用。'."\n"
."\n"
.'- false:不启用。',
'type' => 'boolean',
'example' => 'true',
],
'AcrNamespace' => [
'description' => '容器镜像部署物命名空间',
'type' => 'string',
'example' => 'computenest',
],
'SupportContacts' => [
'description' => '服务商的联系方式',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '联系方式的类型',
'type' => 'string',
'example' => 'Email'."\n",
],
'Value' => [
'description' => '联系方式',
'type' => 'string',
'example' => 'supplier@example.com',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"SupplierName\\": \\"A公司\\",\\n \\"SupplierUrl\\": \\"http://www.xxx.xxx.cn\\",\\n \\"SupplierDesc\\": \\"阿里云计算巢\\",\\n \\"OperationIp\\": \\"10.xxx.xxx.xxx/101\\",\\n \\"OperationMfaPresent\\": true,\\n \\"DeliverySettings\\": {\\n \\"OssEnabled\\": true,\\n \\"OssBucketName\\": \\"mybucket\\",\\n \\"OssPath\\": \\"path1/path2/\\",\\n \\"OssExpirationDays\\": 7\\n },\\n \\"SupplierLogo\\": \\"http://example.aliyundoc.com/cover/34DB-4F4C-9373-003AA060****.png\\",\\n \\"EnableReseller\\": true,\\n \\"AcrNamespace\\": \\"computenest\\",\\n \\"SupportContacts\\": [\\n {\\n \\"Type\\": \\"Email\\\\n\\",\\n \\"Value\\": \\"supplier@example.com\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务商信息',
],
'CreateSupplierRegistration' => [
'summary' => '注册成为服务商。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '190207',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SupplierName',
'in' => 'query',
'schema' => [
'description' => '服务商名称。',
'type' => 'string',
'required' => true,
'example' => 'A公司',
],
],
[
'name' => 'SupplierNameEn',
'in' => 'query',
'schema' => [
'description' => '服务商英文名称',
'type' => 'string',
'required' => true,
'example' => 'Alibaba Cloud',
],
],
[
'name' => 'SupplierUrl',
'in' => 'query',
'schema' => [
'description' => '服务商地址。',
'type' => 'string',
'required' => true,
'example' => 'http://www.xxx.xxx.cn',
],
],
[
'name' => 'SupplierDesc',
'in' => 'query',
'schema' => [
'description' => '服务商描述。',
'type' => 'string',
'required' => true,
'example' => '阿里云计算巢',
],
],
[
'name' => 'SupplierLogo',
'in' => 'query',
'schema' => [
'description' => '服务商图标。',
'type' => 'string',
'required' => false,
'example' => 'http://example.aliyundoc.com/cover/34DB-4F4C-9373-003AA060****.png',
],
],
[
'name' => 'ProductBusiness',
'in' => 'query',
'schema' => [
'description' => '服务商产品所在的行业。',
'type' => 'string',
'required' => false,
'example' => 'AI',
],
],
[
'name' => 'ProductDeliveryTypes',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务商产品交付方式。可选值:'."\n"
."\n"
.'- SaaS'."\n"
."\n"
.'- License'."\n"
."\n"
.'- API'."\n"
."\n"
.'- DesktopSoftware'."\n"
."\n"
.'- Others',
'type' => 'array',
'items' => [
'description' => '服务商产品交付方式。可选值:'."\n"
."\n"
.'- SaaS'."\n"
."\n"
.'- License'."\n"
."\n"
.'- API'."\n"
."\n"
.'- DesktopSoftware'."\n"
."\n"
.'- Others',
'type' => 'string',
'required' => false,
'example' => 'License',
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'ProductSellTypes',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务商产品销售模式。可选值:'."\n"
."\n"
.'- Direct: 直销'."\n"
."\n"
.'- Channel: 渠道',
'type' => 'array',
'items' => [
'description' => '服务商产品销售模式。可选值:'."\n"
."\n"
.'- Direct: 直销'."\n"
."\n"
.'- Channel: 渠道',
'type' => 'string',
'required' => false,
'example' => 'Direct',
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'EnableResellerMode',
'in' => 'query',
'schema' => [
'description' => '是否开启分销。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ProductPublishTime',
'in' => 'query',
'schema' => [
'description' => '产品上市时间。',
'type' => 'string',
'required' => false,
'example' => '2020.10.10',
],
],
[
'name' => 'ProductAnnualRevenue',
'in' => 'query',
'schema' => [
'description' => '产品年度营收',
'type' => 'string',
'required' => false,
'example' => '1000万',
],
],
[
'name' => 'ContactPerson',
'in' => 'query',
'schema' => [
'description' => '联系人。',
'type' => 'string',
'required' => true,
'example' => '张三',
],
],
[
'name' => 'ContactPersonTitle',
'in' => 'query',
'schema' => [
'description' => '联系人职位。',
'type' => 'string',
'required' => true,
'example' => 'CTO',
],
],
[
'name' => 'ContactNumber',
'in' => 'query',
'schema' => [
'description' => '联系人电话。',
'type' => 'string',
'required' => true,
'example' => '186xxxxxxxxx',
],
],
[
'name' => 'ContactEmail',
'in' => 'query',
'schema' => [
'description' => '联系人邮箱。',
'type' => 'string',
'required' => true,
'example' => 'xxxx@xxx.com',
],
],
[
'name' => 'Suggestion',
'in' => 'query',
'schema' => [
'description' => '服务商的诉求。',
'type' => 'string',
'required' => false,
'example' => '无',
],
],
[
'name' => 'ResellBusinessDesc',
'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 of the request',
'type' => 'string',
'example' => 'C4A145D8-xxxx-xxxx-xxxx-9730CDA27578',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4A145D8-xxxx-xxxx-xxxx-9730CDA27578\\"\\n}","type":"json"}]',
'title' => '服务商提交入驻申请',
],
'ListSupplierRegistrations' => [
'summary' => '查看服务商已经提交的入驻申请',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '190812',
'abilityTreeNodes' => [
'FEATUREcomputenest2G0818',
'FEATUREcomputenest1Z49ZW',
'FEATUREcomputenest21Y74A',
],
'tenantRelevance' => 'publicInformation',
],
'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',
'type' => 'string',
'required' => false,
'example' => 'AAAAAYChudnQUoBH+mGWFpb6oP0=',
],
],
[
'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' => 'sr-xxx',
],
'required' => false,
'maxItems' => 20,
],
'Name' => [
'description' => '过滤器名称,可选择一个或者多个名称进行查询。取值范围:'."\n"
."\n"
.'- SupplierUid:服务商UID。'."\n"
."\n"
.'- RegistrationId:审核ID。'."\n"
."\n"
.'- Status:审核状态。'."\n"
."\n"
.'- SupplierName:服务商名称。',
'type' => 'string',
'required' => false,
'example' => 'SupplierUid',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一个查询开始token。',
'type' => 'string',
'example' => 'AAAAAdx9kBO7qKpr9My/+XQo0oY=',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C6CC568D-xxxx-xxxx-xxxx-08EB8E9F9F20',
],
'TotalCount' => [
'description' => '结果总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'MaxResults' => [
'description' => '分页查询时每页行数。其中最大值为100行,默认值为20行。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'SupplierRegistrations' => [
'description' => '服务商入驻申请列表',
'type' => 'array',
'items' => [
'description' => '服务商入驻申请',
'type' => 'object',
'properties' => [
'RegistrationId' => [
'description' => '审核申请ID。',
'type' => 'string',
'example' => 'sr-xxx',
],
'SupplierUid' => [
'description' => '服务商AliUid。',
'type' => 'string',
'example' => '1256xxx23434',
],
'SupplierName' => [
'description' => '服务商名称。',
'type' => 'string',
'example' => '计算巢社区服务',
],
'SupplierNameEn' => [
'description' => '服务商英文名称',
'type' => 'string',
'example' => 'Alibaba Cloud ComputeNest',
],
'SupplierUrl' => [
'description' => '服务商官网地址。',
'type' => 'string',
'example' => 'https://www.guangbao-uni.com',
],
'SupplierDesc' => [
'description' => '服务商描述。',
'type' => 'string',
'example' => '服务商测试申请',
],
'SupplierLogo' => [
'description' => '服务商图标。',
'type' => 'string',
'example' => 'https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-xxx/xxx.png',
],
'ProductBusiness' => [
'description' => '服务商产品所在的行业。',
'type' => 'string',
'example' => 'AI',
],
'ProductDeliveryTypes' => [
'description' => '服务商产品交付方式。可选值:'."\n"
."\n"
.'- SaaS'."\n"
."\n"
.'- License'."\n"
."\n"
.'- API'."\n"
."\n"
.'- 桌面软件'."\n"
."\n"
.'- 其他',
'type' => 'string',
'example' => 'SaaS',
],
'EnableResellerMode' => [
'description' => '是否支持分销',
'type' => 'boolean',
'example' => 'false',
],
'ProductPublishTime' => [
'description' => '产品上市时间',
'type' => 'string',
'example' => '2024.10.24',
],
'ContactPerson' => [
'description' => '联系人。',
'type' => 'string',
'example' => '张三',
],
'ContactPersonTitle' => [
'description' => '联系人职位。',
'type' => 'string',
'example' => 'CTO',
],
'ContactNumber' => [
'description' => '联系人电话。',
'type' => 'string',
'example' => '135xxxxxxxx',
],
'ContactEmail' => [
'description' => '联系人邮箱',
'type' => 'string',
'example' => 'test@163.com',
],
'Status' => [
'description' => '审核状态。可能值:'."\n"
."\n"
.'- Submitted:已提交'."\n"
."\n"
.'- Approved:已通过'."\n"
."\n"
.'- Rejected:已拒绝',
'type' => 'string',
'example' => 'Submitted',
],
'SubmitTime' => [
'description' => '提交时间。',
'type' => 'string',
'example' => '2025-01-22 09:47:58 '."\n",
],
'ProductSellTypes' => [
'description' => '服务商产品销售模式。可选值:'."\n"
."\n"
.'- 直销'."\n"
."\n"
.'- 渠道',
'type' => 'string',
'example' => '直销',
],
'Comment' => [
'description' => '审核意见。',
'type' => 'string',
'example' => '无',
],
'ResellBusinessDesc' => [
'description' => '分销业务介绍',
'type' => 'string',
'example' => '无',
],
'ProductAnnualRevenue' => [
'description' => '服务商产品年度营收',
'type' => 'string',
'example' => '1000万',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAdx9kBO7qKpr9My/+XQo0oY=\\",\\n \\"RequestId\\": \\"C6CC568D-xxxx-xxxx-xxxx-08EB8E9F9F20\\",\\n \\"TotalCount\\": 3,\\n \\"MaxResults\\": 20,\\n \\"SupplierRegistrations\\": [\\n {\\n \\"RegistrationId\\": \\"sr-xxx\\",\\n \\"SupplierUid\\": \\"1256xxx23434\\",\\n \\"SupplierName\\": \\"计算巢社区服务\\",\\n \\"SupplierNameEn\\": \\"Alibaba Cloud ComputeNest\\",\\n \\"SupplierUrl\\": \\"https://www.guangbao-uni.com\\",\\n \\"SupplierDesc\\": \\"服务商测试申请\\",\\n \\"SupplierLogo\\": \\"https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-xxx/xxx.png\\",\\n \\"ProductBusiness\\": \\"AI\\",\\n \\"ProductDeliveryTypes\\": \\"SaaS\\",\\n \\"EnableResellerMode\\": false,\\n \\"ProductPublishTime\\": \\"2024.10.24\\",\\n \\"ContactPerson\\": \\"张三\\",\\n \\"ContactPersonTitle\\": \\"CTO\\",\\n \\"ContactNumber\\": \\"135xxxxxxxx\\",\\n \\"ContactEmail\\": \\"test@163.com\\",\\n \\"Status\\": \\"Submitted\\",\\n \\"SubmitTime\\": \\"2025-01-22 09:47:58\\\\t\\\\n\\",\\n \\"ProductSellTypes\\": \\"直销\\",\\n \\"Comment\\": \\"无\\",\\n \\"ResellBusinessDesc\\": \\"无\\",\\n \\"ProductAnnualRevenue\\": \\"1000万\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查看服务商入驻申请',
],
'UpdateSupplierInformation' => [
'summary' => '调用UpdateSupplierInformation更新服务商信息。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '43088',
'abilityTreeNodes' => [
'FEATUREcomputenest1Z49ZW',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'OperationIp',
'in' => 'query',
'schema' => [
'description' => '托管代运维访问IP段。',
'type' => 'string',
'required' => false,
'example' => '192.xxx.xxx.xxx/16,192.xxx.xxx.xxx',
],
],
[
'name' => 'OperationMfaPresent',
'in' => 'query',
'schema' => [
'description' => '是否开启MFA。默认值为true。可选值:'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false:否。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'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' => 'false',
],
'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',
],
],
'required' => false,
],
],
[
'name' => 'SupplierDesc',
'in' => 'query',
'schema' => [
'description' => '服务商描述。',
'type' => 'string',
'required' => false,
'example' => '阿里云计算巢',
],
],
[
'name' => 'SupplierUrl',
'in' => 'query',
'schema' => [
'description' => '服务商地址。',
'type' => 'string',
'required' => false,
'example' => 'http://www.xxx.xxx.cn',
],
],
[
'name' => 'SupplierLogo',
'in' => 'query',
'schema' => [
'description' => '服务商图标。',
'type' => 'string',
'required' => false,
'example' => 'http://example.aliyundoc.com/cover/34DB-4F4C-9373-003AA060****.png',
],
],
[
'name' => 'SupportContacts',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '服务商的联系方式',
'type' => 'array',
'items' => [
'description' => '服务商的联系方式',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '联系方式的类型',
'type' => 'string',
'required' => false,
'example' => 'Email',
],
'Value' => [
'description' => '联系方式',
'type' => 'string',
'required' => false,
'example' => 'supplier@example.com',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'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',
],
'SupplierName' => [
'description' => '服务商名称。',
'type' => 'string',
'example' => 'A公司',
],
'SupplierUrl' => [
'description' => '服务商地址。',
'type' => 'string',
'example' => 'http://www.xxx.xxx.cn',
],
'SupplierDesc' => [
'description' => '服务商描述。',
'type' => 'string',
'example' => '阿里云计算巢',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"SupplierName\\": \\"A公司\\",\\n \\"SupplierUrl\\": \\"http://www.xxx.xxx.cn\\",\\n \\"SupplierDesc\\": \\"阿里云计算巢\\"\\n}","type":"json"}]',
'title' => '更新服务商信息',
],
'PushMeteringData' => [
'summary' => '该API只支持推送按量付费的计算巢服务实例的计量数据,推送的计量项需要定义为服务商上报',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '186185',
'abilityTreeNodes' => [
'FEATUREcomputenest18JMDW',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Metering',
'in' => 'query',
'schema' => [
'description' => '示例中的参数说明如下:'."\n"
."\n"
.'- InstanceId:云市场实例ID 。参数类型为String。'."\n"
.'- StartTime:计量开始时间。单位秒(格式为Unix时间戳)。参数类型为Long。'."\n"
.'- EndTime:计量结束时间。单位秒(格式为Unix时间戳)。参数类型为Long。'."\n"
.'- Entities:计量实体对象。参数类型为List