'1.0',
'info' => ['style' => 'RPC', 'product' => 'ComputeNest', 'version' => '2021-06-01'],
'directories' => [
[
'children' => ['GetService', 'GetServiceTemplateParameterConstraints', 'GetServiceEstimateCost', 'GenerateServicePolicy', 'GetServiceProvisions', 'ListServices'],
'type' => 'directory',
'title' => 'Services',
],
[
'children' => ['ListServiceCategories'],
'type' => 'directory',
'title' => 'Service categories',
],
[
'children' => ['UpgradeServiceInstance', 'CreateServiceInstance', 'GetServiceInstance', 'ContinueDeployServiceInstance', 'DeleteServiceInstances', 'RenewServiceInstance', 'ListServiceInstanceLogs', 'ListServiceInstanceResources', 'ListServiceInstances', 'StartServiceInstance', 'StopServiceInstance', 'RestartServiceInstance', 'UpdateServiceInstanceSpec', 'ListServiceInstanceUpgradeHistory', 'RollbackServiceInstance', 'UpdateServiceInstanceAttributes', 'ValidateServiceInstanceName'],
'type' => 'directory',
'title' => 'Service instances',
],
[
'children' => ['ListTagKeys', 'UnTagResources', 'TagResources', 'ListTagValues', 'ChangeResourceGroup'],
'type' => 'directory',
'title' => 'Tags and resource groups',
],
[
'children' => ['UpdateUserInformation', 'GetUserInformation'],
'type' => 'directory',
'title' => 'User information',
],
[
'children' => ['ListServiceUsages', 'CancelServiceUsage', 'CreateServiceUsage', 'UpdateServiceUsage'],
'type' => 'directory',
'title' => 'Service usage applications',
],
[
'children' => [
'DeployServiceInstance', 'DescribeRegions', 'ListPolicies', 'GetNetworkAvailableZones', 'RenewServiceInstanceResources', 'ListTagResources', 'GetServiceInstanceSubscriptionEstimateCost', 'ListServiceInstanceBill', 'CheckServiceDeployable', 'CreateRestoreTask', 'GetBackup', 'ListRestoreTasks', 'ListBackups', 'CreateBackup', 'DeleteBackup', 'CreateSkill', 'CreateSkillFileDetect', 'CreateSkillHubConfig', 'CreateSkillSpace', 'DeleteSkill',
'DeleteSkillSpace', 'GetSkill', 'GetSkillFileDetectResult', 'GetSkillHubConfig', 'GetSkillSpace', 'ListPublicSkills', 'ListSkillFiles', 'ListSkillSpaces', 'ListSkills', 'UpdateSkill',
],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CancelServiceUsage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '137527',
'abilityTreeNodes' => ['FEATUREcomputenestHUKJ18'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'service-d6fc5f949a9246xxxxxx'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The token must be unique for each request. It can contain only ASCII characters and must be no more than 64 characters long.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'NeedDelete',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to delete the request.'."\n"
."\n"
.'> If you delete the request, you must submit a new one.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'The region ID.', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CancelServiceUsage',
'summary' => 'Cancels a service usage request.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelServiceUsage'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:CancelServiceUsage',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:*:{#accountId}:service/{#serviceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
],
'ChangeResourceGroup' => [
'summary' => 'Changes the resource group for a cloud resource.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '171476',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the cloud resource whose resource group you want to change.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'si-5dc794a7fd254e******'],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the destination resource group.'."\n"
."\n"
.'You can obtain the resource group ID from the [Resource Management console](https://resourcemanager.console.aliyun.com/resource-groups).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-acfmzmhzo******'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- service: The resource is a service.'."\n"
."\n"
.'- serviceinstance: The resource is a service instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'service'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\"\\n}","type":"json"}]',
'title' => 'ChangeResourceGroup',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceInstance/{#serviceInstanceId}'],
],
],
],
],
],
'CheckServiceDeployable' => [
'summary' => 'Performs a precheck to verify that a service instance can be deployed.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '225993',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9', 'FEATUREcomputenestVUFVAC'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'service-0e6fca6a51a544xxxxxx', 'title' => ''],
],
[
'name' => 'TrialType',
'in' => 'query',
'schema' => ['description' => 'The trial type. Valid values:'."\n"
."\n"
.'- Trial: The service supports trial use.'."\n"
."\n"
.'- NotTrial: The service does not support trial use.', 'type' => 'string', 'required' => false, 'example' => 'NotTrial', 'title' => ''],
],
[
'name' => 'PrePaidAmount',
'in' => 'query',
'schema' => ['description' => 'The total upfront payment amount.', 'type' => 'string', 'required' => false, 'example' => '0.0', 'title' => ''],
],
[
'name' => 'PostPaidAmount',
'in' => 'query',
'schema' => ['description' => 'The total pay-as-you-go amount.', 'type' => 'string', 'required' => false, 'example' => '1.29', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'required' => false, 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [
'x-acs-ext-1' => [
'schema' => ['type' => 'string'],
],
],
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
'CheckResults' => [
'description' => 'The check results.',
'type' => 'array',
'items' => [
'description' => 'The check results.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type of precheck. Valid values:'."\n"
."\n"
.'- Balance: The account balance.'."\n"
."\n"
.'- Quota: The resource quota.', 'type' => 'string', 'example' => 'Balance', 'title' => ''],
'Value' => ['description' => 'The check result.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => '""', 'title' => ''],
'Skippable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"CheckResults\\": [\\n {\\n \\"Type\\": \\"Balance\\",\\n \\"Value\\": \\"true\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Skippable\\": false\\n }\\n ]\\n}","type":"json"}]',
'title' => 'CheckServiceDeployable',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceDeployable'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:CheckServiceDeployable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'ContinueDeployServiceInstance' => [
'summary' => 'If a service instance fails to deploy, you can call the ContinueDeployServiceInstance operation to resume the deployment.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '43087',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9', 'FEATUREcomputenestVUFVAC', 'FEATUREcomputenestZFWIMH', 'FEATUREcomputenestQKB5Y7'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'si-0e6fca6a51a54420****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'Parameters',
'in' => 'query',
'schema' => ['description' => 'The configuration parameters of the service instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{"NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******"}'],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. A dry run checks items such as permissions and the instance status. Valid values:'."\n"
."\n"
.'- true: performs a dry run to check the request. The service instance is not deployed.'."\n"
."\n"
.'- false: sends a regular request. If the request passes the check, the service instance is deployed.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
],
[
'name' => 'Option',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The recreation options.',
'type' => 'array',
'items' => ['description' => 'The recreation option. Valid values:'."\n"
."\n"
.'- TryToFixSignalFailureByRerunEcsCommand: Tries to fix an existing signal failure. If an ALIYUN::ROS::WaitCondition resource fails to be created, this option finds the associated and successfully created ALIYUN::ECS::RunCommand and ALIYUN::ECS::Invocation resources. It then recreates these resources and their dependent resources.'."\n"
."\n"
.'- IgnoreExistingSignalFailure: Ignores an existing signal failure. If a resource of the ALIYUN::ROS::WaitCondition type previously failed to be created, the resource is marked as successfully created in the new creation process.'."\n"
."\n"
.'- AutoRecreatingResources: Automatically recreates resources whose template content or referenced parameters have changed. This includes dependent resources. This option simplifies the configuration of the RecreatingResources.N parameter but may cause unexpected resource recreation.'."\n"
."\n"
.'> This option is valid only for ROS stacks.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'TryToFixSignalFailureByRerunEcsCommand'],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
'DryRunResult' => [
'description' => 'The check result.',
'type' => 'object',
'properties' => [
'ParametersNotAllowedToBeModified' => [
'description' => 'The parameters that cannot be modified. Modifying these parameters always causes a check error.'."\n"
."\n"
.'> This parameter is returned only if DryRun is set to true.',
'type' => 'array',
'items' => ['description' => 'The parameters that cannot be modified. Modifying these parameters always causes a check error.'."\n"
."\n"
.'> This parameter is returned only if DryRun is set to true.', 'type' => 'string', 'title' => '', 'example' => 'cidr'],
'title' => '',
'example' => '',
],
'ParametersConditionallyAllowedToBeModified' => [
'description' => 'The parameters that can be conditionally modified.'."\n"
.'Whether modifying these parameters causes a check error depends on their values.'."\n"
."\n"
.'> This parameter is returned only if DryRun is set to true.',
'type' => 'array',
'items' => ['description' => 'The parameters that can be conditionally modified.'."\n"
.'Whether modifying these parameters causes a check error depends on their values.'."\n"
."\n"
.'> This parameter is returned only if DryRun is set to true.', 'type' => 'string', 'title' => '', 'example' => 'name'],
'title' => '',
'example' => '',
],
'ParametersAllowedToBeModified' => [
'description' => 'The parameters that can be modified. Modifying these parameters does not cause a check error.'."\n"
."\n"
.'> This parameter is returned only if DryRun is set to true.',
'type' => 'array',
'items' => ['description' => 'The parameters that can be modified. Modifying these parameters does not cause a check error.'."\n"
."\n"
.'> This parameter is returned only if DryRun is set to true.', 'type' => 'string', 'title' => '', 'example' => 'description'],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'ServiceInstanceId' => ['description' => 'The ID of the service instance.', 'type' => 'string', 'title' => '', 'example' => 'si-d6ab3a63ccbb4b17****'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"DryRunResult\\": {\\n \\"ParametersNotAllowedToBeModified\\": [\\n \\"cidr\\"\\n ],\\n \\"ParametersConditionallyAllowedToBeModified\\": [\\n \\"name\\"\\n ],\\n \\"ParametersAllowedToBeModified\\": [\\n \\"description\\"\\n ]\\n },\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\"\\n}","type":"json"}]',
'title' => 'ContinueDeployServiceInstance',
'description' => 'If a private service instance that uses the ROS deployment type fails to deploy, you can call the ContinueDeployServiceInstance operation to resume the deployment.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinueDeployServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:ContinueDeployServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
],
'CreateBackup' => [
'summary' => 'Creates a backup for a Compute Nest service instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenestSE9C8Z'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The backup description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'No description'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance to back up.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-56cfb7ec3a634448a96c'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8DC02957-A0FC-5AB2-8C54-496B636EAF12'],
'BackupId' => ['title' => 'Id of the request', 'description' => 'The backup ID.', 'type' => 'string', 'example' => 'backup-cad4a85ff5e340388b93'],
'Description' => ['title' => 'Id of the request', 'description' => 'The description.', 'type' => 'string', 'example' => 'No description'],
'Status' => ['title' => 'Id of the request', 'description' => 'The status of the backup.'."\n"
."\n"
.'- Creating: The backup is being created.'."\n"
."\n"
.'- Created: The backup is created.'."\n"
."\n"
.'- CreateFailed: The backup failed to be created.'."\n"
."\n"
.'- Deleting: The backup is being deleted.'."\n"
."\n"
.'- Deleted: The backup is deleted.'."\n"
."\n"
.'- DeleteFailed: The backup failed to be deleted.', 'type' => 'string', 'example' => 'Creating'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'CreateBackup',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider enabled the upgrade/downgrade feature and configured the corresponding parameters when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8DC02957-A0FC-5AB2-8C54-496B636EAF12\\",\\n \\"BackupId\\": \\"backup-cad4a85ff5e340388b93\\",\\n \\"Description\\": \\"No description\\",\\n \\"Status\\": \\"Creating\\"\\n}","type":"json"}]',
],
'CreateRestoreTask' => [
'summary' => 'Creates a restore job.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232527',
'abilityTreeNodes' => ['FEATUREcomputenestSE9C8Z'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.'."\n"
."\n"
.'Call the [ListServiceInstances](~~396200~~) operation to obtain the service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-49793f3bfa034ec6a990'],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'backup-385d35fb088f453c8fa1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
'RestoreTaskId' => ['description' => 'The ID of the restore job.', 'type' => 'string', 'title' => '', 'example' => 'restore-fdsafda'],
'Status' => ['description' => 'The status of the service instance. Valid values:'."\n"
."\n"
.'- Restoring: The service instance is being restored.'."\n"
."\n"
.'- Restored: The service instance is restored.'."\n"
."\n"
.'- RestoreFailed: The service instance failed to be restored.', 'type' => 'string', 'title' => '', 'example' => 'Restoring'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateRestoreTask',
'description' => '### Prerequisites'."\n"
."\n"
.'Before you call this operation, ensure that the service provider enabled the upgrade and downgrade feature and configured its parameters when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:CreateRestoreTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"RestoreTaskId\\": \\"restore-fdsafda\\",\\n \\"Status\\": \\"Restoring\\"\\n}","type":"json"}]',
],
'CreateServiceInstance' => [
'summary' => 'Creates and deploys a service instance in Compute Nest by specifying parameters such as a region ID, a service instance name, and a service ID.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '36939',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9', 'FEATUREcomputenestVUFVAC', 'FEATUREcomputenestZFWIMH', 'FEATUREcomputenestQKB5Y7'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID. Valid values:'."\n"
."\n"
.'- cn-hangzhou: China (Hangzhou).'."\n"
."\n"
.'- ap-southeast-1: Singapore.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the service instance. The name must meet the following requirements:'."\n"
."\n"
.'- The name can be up to 64 characters in length.'."\n"
."\n"
.'- It must start with a letter or a digit and can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'required' => false, 'example' => 'TestName', 'title' => ''],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'service-0e6fca6a51a54420****', 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The parameters for deploying the user instance.'."\n"
."\n"
.'> If the service instance contains deployment region information, you must specify the region in the deployment parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
.' "RegionId": "cn-hangzhou"'."\n"
.' "NodeCount": 3,'."\n"
.' "SystemDiskSize": 40,'."\n"
.' "InstancePassword": "******"'."\n"
.'}', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client-generated, unique token that ensures the idempotence of the request. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'EnableInstanceOps',
'in' => 'query',
'schema' => ['description' => 'Indicates whether the service instance has the O\\&M feature. Valid values:'."\n"
."\n"
.'- **true**: The service instance has the O\\&M feature.'."\n"
."\n"
.'- **false**: The service instance does not have the O\\&M feature.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name. You must specify this parameter if the service supports multiple templates.', 'type' => 'string', 'example' => 'Template 1', 'required' => false, 'title' => ''],
],
[
'name' => 'OperationMetadata',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The O\\&M configuration.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time of the O\\&M window. This parameter is valid only in managed O\\&M mode.', 'type' => 'string', 'required' => false, 'example' => '2021-12-29T06:48:56Z', 'title' => ''],
'EndTime' => ['description' => 'The end time of the O\\&M window. This parameter is valid only in managed O\\&M mode.', 'type' => 'string', 'required' => false, 'example' => '2022-01-28T06:48:56Z', 'title' => ''],
'Resources' => ['description' => 'The list of imported resources.', 'type' => 'string', 'required' => false, 'example' => '{ "RegionId": "cn-hangzhou", "Type": "ResourceIds", "ResourceIds": { "ALIYUN::ECS::INSTANCE": ["i-xxx", "i-yyy"], "ALIYUN::RDS::INSTANCE": ["rm-xxx", "rm-yyy"], "ALIYUN::VPC::VPC": ["vpc-xxx", "vpc-yyy"], "ALIYUN::SLB::INSTANCE": ["lb-xxx", "lb-yyy"] } }', 'title' => ''],
'ServiceInstanceId' => ['description' => 'The ID of the imported service instance.', 'type' => 'string', 'required' => false, 'example' => 'si-d6ab3a63ccbb4b17****', 'title' => ''],
'ExtraInfo' => ['description' => 'Additional information about the managed O\\&M service.', 'type' => 'string', 'required' => false, 'example' => ' ```json'."\n"
.' {'."\n"
.' "vncInfo": ['."\n"
.' {'."\n"
.' "instanceId": "i-001",'."\n"
.' "username": "admin",'."\n"
.' "password": "******",'."\n"
.' "vncPassword": "******"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ```', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''],
],
[
'name' => 'ContactGroup',
'in' => 'query',
'schema' => ['description' => 'The CloudMonitor alert contact group that receives alerts.', 'type' => 'string', 'example' => 'Cloud account alert contact', 'required' => false, 'title' => ''],
],
[
'name' => 'TrialType',
'in' => 'query',
'schema' => ['description' => 'The type of the service instance. Valid values:'."\n"
."\n"
.'- **Trial**: The service instance supports trial.'."\n"
."\n"
.'- **NotTrial**: The service instance does not support trial.', 'type' => 'string', 'required' => false, 'example' => 'Trial', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The custom tags.',
'type' => 'array',
'items' => [
'description' => 'The custom tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
],
[
'name' => 'SpecificationName',
'in' => 'query',
'schema' => ['description' => 'The name of the specification package.', 'type' => 'string', 'example' => 'Package 1', 'required' => false, 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Indicates whether to perform a dry run for the request. The dry run checks for permissions and instance status. Valid values:'."\n"
."\n"
.'- **true**: Sends the request without creating the service instance.'."\n"
."\n"
.'- **false**: Sends the request and creates the service instance after the check is passed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'SpecificationCode',
'in' => 'query',
'schema' => ['description' => 'The commodity specification code.', 'type' => 'string', 'required' => false, 'example' => 'yuncode5425200001', 'title' => ''],
],
[
'name' => 'EnableUserPrometheus',
'in' => 'query',
'schema' => ['description' => 'Indicates whether to enable Prometheus monitoring. Valid values:'."\n"
."\n"
.'- **true**: Enable.'."\n"
."\n"
.'- **false**: Disable.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'Commodity',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The information about the Alibaba Cloud Marketplace purchase order. You do not need to specify this parameter if the service is not listed in Alibaba Cloud Marketplace or if you use the pay-as-you-go billing method.',
'type' => 'object',
'properties' => [
'PayPeriodUnit' => ['description' => 'The unit of the subscription duration. Valid values:'."\n"
."\n"
.'- **Year**: Year.'."\n"
."\n"
.'- **Month**: Month.'."\n"
."\n"
.'- **Day**: Day.', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''],
'PayPeriod' => ['description' => 'The subscription duration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
'AutoRenew' => ['description' => 'Indicates whether to enable auto-renewal. Valid values:'."\n"
."\n"
.'- **true**: Enable.'."\n"
."\n"
.'- **false**: Disable.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
'AutoPay' => ['description' => 'Indicates whether to enable automatic payment for the order. Valid values:'."\n"
."\n"
.'- **true**: Enable automatic payment.'."\n"
."\n"
.'- **false**: Disable automatic payment.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
'CouponId' => ['description' => 'The coupon ID.', 'type' => 'string', 'required' => false, 'example' => '302070970220', 'title' => ''],
'QuotationId' => ['description' => 'The ID of the private offer in Alibaba Cloud Marketplace.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxxx-xxxx-xxxx', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceAutoPay',
'in' => 'query',
'schema' => ['description' => 'Indicates whether to automatically deduct the payment from your account balance. Valid values:'."\n"
."\n"
.'- **true**: Enable automatic payment.'."\n"
."\n"
.'- **false**: Disable automatic payment.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance to convert to a paid instance.', 'type' => 'string', 'required' => false, 'example' => 'si-d32fbcef30664721b785', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the service instance. Valid values:'."\n"
."\n"
.'- **Created**: The service instance is created.'."\n"
."\n"
.'- **Deploying**: The service instance is being deployed.'."\n"
."\n"
.'- **DeployedFailed**: The service instance failed to be deployed.'."\n"
."\n"
.'- **Deployed**: The service instance is deployed.'."\n"
."\n"
.'- **Upgrading**: The service instance is being upgraded.'."\n"
."\n"
.'- **Deleting**: The service instance is being deleted.'."\n"
."\n"
.'- **Deleted**: The service instance is deleted.'."\n"
."\n"
.'- **DeletedFailed**: The service instance failed to be deleted.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D****', 'title' => ''],
'ServiceInstanceId' => ['description' => 'The service instance ID.', 'type' => 'string', 'example' => 'si-d6ab3a63ccbb4b17****', 'title' => ''],
'MarketInstanceId' => ['description' => 'The ID of the Alibaba Cloud Marketplace instance.', 'type' => 'string', 'example' => '786***45', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2306175xxxxxxxx', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Created\\",\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D****\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"MarketInstanceId\\": \\"786***45\\",\\n \\"OrderId\\": \\"2306175xxxxxxxx\\"\\n}","type":"json"}]',
'title' => 'CreateServiceInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/*'],
],
],
],
],
'translator' => 'manual',
],
'CreateServiceUsage' => [
'summary' => 'Creates a service usage request.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcomputenestJ4D829'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'service-d6fc5f949a9246xxxxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. The value is generated by the client and must be unique for each request. The **ClientToken** value can contain only ASCII characters and must be no more than 64 characters long.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'UserInformation',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The request information.',
'type' => 'object',
'required' => false,
'additionalProperties' => ['description' => 'The request information.', 'type' => 'string', 'example' => '{'."\n"
.' "ServiceId": "xxx",'."\n"
.' "EmailAddress": "邮箱",'."\n"
.' "Company": "公司",'."\n"
.' "Country": "国家",'."\n"
.' "Telephone": "申请人的电话号码",'."\n"
.' "Name": "申请人名字",'."\n"
.' "Title": "申请人的职位",'."\n"
.' "Industry": "行业"'."\n"
.'}', 'title' => ''],
'title' => '',
'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
'title' => 'CreateServiceUsage',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceUsage'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateServiceUsage',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:*:{#accountId}:service/{#serviceId}'],
],
],
],
],
],
'CreateSkill' => [
'summary' => 'Creates a Skill.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SkillName',
'in' => 'query',
'schema' => ['description' => 'The Skill name.', 'type' => 'string', 'required' => false, 'example' => 'skill-creator', 'title' => ''],
],
[
'name' => 'SkillDisplayName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SkillLabels',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The Skill labels.',
'type' => 'array',
'items' => ['description' => 'The Skill label.', 'type' => 'string', 'required' => false, 'example' => 'category:frontend-development', 'title' => ''],
'required' => false,
'example' => '["category:frontend-development"]',
'maxItems' => 100,
'minItems' => 1,
'title' => '',
],
],
[
'name' => 'SkillDescription',
'in' => 'query',
'schema' => ['description' => 'The Skill description.', 'type' => 'string', 'required' => false, 'example' => 'Create new skills, modify and improve existing skills, and measure skill performance', 'title' => ''],
],
[
'name' => 'SkillSpaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the SkillSpace to which the Skill belongs.', 'type' => 'string', 'required' => true, 'example' => 'ss-xxxxx', 'title' => ''],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => 'The source type for creating the Skill.',
'type' => 'string',
'required' => true,
'enum' => ['COPY', 'UPLOAD'],
'example' => 'COPY',
'title' => '',
],
],
[
'name' => 'SourceSkillId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The public Skill ID. This parameter is required when SourceType is set to COPY.', 'type' => 'string', 'required' => false, 'example' => 's-xxxxx'],
],
[
'name' => 'OssUrl',
'in' => 'query',
'schema' => ['description' => 'The OSS URL of the Skill package to upload. This parameter is required when SourceType is set to UPLOAD.', 'type' => 'string', 'required' => false, 'example' => 'https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/skill-creator.zip', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A17F9930-E2DC-5E87-B6D6-B0BCD2B00834'],
'SkillId' => ['title' => '', 'description' => 'Skill ID', 'type' => 'string', 'example' => 's-xxxxx'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Create a skill',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the Upgrade/Downgrade feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A17F9930-E2DC-5E87-B6D6-B0BCD2B00834\\",\\n \\"SkillId\\": \\"s-xxxxx\\"\\n}","type":"json"}]',
],
'CreateSkillFileDetect' => [
'summary' => 'Creates a Skill file detection task.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'OssUrl',
'in' => 'query',
'schema' => ['description' => 'The OSS URL of the Skill compressed file to be detected.', 'type' => 'string', 'required' => true, 'example' => 'https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/skill-creator.zip', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3F976EF8-C10A-57DC-917C-BB7BEB508FFB'],
'HashKey' => ['title' => '', 'description' => 'The unique identifier of the current detection task.', 'type' => 'string', 'example' => '2aceb074-fa72-44d2-99d9-45b17cffe0e7'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Create a skill file detection task',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the Upgrade/Downgrade feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateSkillFileDetect',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F976EF8-C10A-57DC-917C-BB7BEB508FFB\\",\\n \\"HashKey\\": \\"2aceb074-fa72-44d2-99d9-45b17cffe0e7\\"\\n}","type":"json"}]',
],
'CreateSkillHubConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'OssBucketName',
'in' => 'query',
'schema' => ['description' => 'The name of the Object Storage Service (OSS) bucket.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'tidb-test-a', 'title' => ''],
],
[
'name' => 'OssRegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the OSS bucket. For more information, see [OSS regions and endpoints](~~31837~~).', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'A client-generated token to ensure request idempotence. This value must be unique for each request. **ClientToken** must contain only ASCII characters and be no longer than 64 characters.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3F976EF8-C10A-57DC-917C-BB7BEB508FFB'],
],
'title' => '',
'description' => 'Response schema',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'CreateSkillHubConfig',
'summary' => 'Creates a SkillHub config.',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider has enabled the modify configuration feature and set the required parameters.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F976EF8-C10A-57DC-917C-BB7BEB508FFB\\"\\n}","type":"json"}]',
],
'CreateSkillSpace' => [
'summary' => 'Creates a SkillSpace.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SkillSpaceName',
'in' => 'query',
'schema' => ['description' => 'The name of the SkillSpace.', 'type' => 'string', 'required' => true, 'example' => 'office-toolkit-skills', 'title' => ''],
],
[
'name' => 'SkillSpaceDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the SkillSpace.', 'type' => 'string', 'required' => true, 'example' => 'All-in-one office toolkit — generate reports, process data, manage files, and streamline workflows effortlessly.', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
'SkillSpaceId' => ['title' => '', 'description' => 'SkillSpace ID', 'type' => 'string', 'example' => 'ss-xxxxx'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => 'Create a skill space',
'description' => '### Before you begin'."\n"
.'Confirm that the service provider has enabled the Upgrade/Downgrade feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateSkillSpace',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"SkillSpaceId\\": \\"ss-xxxxx\\"\\n}","type":"json"}]',
],
'DeleteBackup' => [
'summary' => 'Deletes a Compute Nest instance backup.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '232519',
'abilityTreeNodes' => ['FEATUREcomputenestSE9C8Z'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'backup-385d35fb088f453c8fa1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'DeleteBackup',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider enabled the upgrade/downgrade feature and configured the upgrade/downgrade parameters when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:DeleteBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
],
'DeleteServiceInstances' => [
'summary' => 'Deletes the specified service instances in a region.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '36935',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. Make sure that the token is unique for each request. The **ClientToken** value can contain only ASCII characters and cannot be longer than 64 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The IDs of the service instances.',
'type' => 'array',
'items' => ['description' => 'The service instance ID. You can specify 1 to 100 service instance IDs.'."\n"
."\n"
.'> To delete multiple service instances, separate them with &&. For example: ServiceInstanceId.1=xxx&\\&ServiceInstanceId.2=yyy.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'si-d6ab3a63ccbb4b17****'],
'required' => true,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'ComputeNest::2021-06-01::GetServiceInstance', 'callbackInterval' => 2000, 'maxCallbackTimes' => 500],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
'title' => 'DeleteServiceInstances',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceInstances'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:DeleteServiceInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
],
],
'DeleteSkill' => [
'summary' => 'Deletes a Skill.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SkillId',
'in' => 'query',
'schema' => ['description' => 'Skill ID', 'type' => 'string', 'required' => true, 'example' => 's-xxxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'Ensures the idempotence of the request. Generate a value from your client that is unique across different requests. **ClientToken** supports only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Delete a skill',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the Upgrade/Downgrade feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
],
'DeleteSkillSpace' => [
'summary' => 'Deletes a Skill workspace.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SkillSpaceId',
'in' => 'query',
'schema' => ['description' => 'SkillSpace ID', 'type' => 'string', 'required' => true, 'example' => 'ss-xxxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'Ensures the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique across different requests. **ClientToken** supports only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
],
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidSkillSpace.NotFound', 'errorMessage' => 'The specified SkillSpace does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Delete a skill workspace',
'description' => '### Before you begin'."\n"
.'Confirm that the service provider has enabled the Upgrade/Downgrade feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:DeleteSkillSpace',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\"\\n}","type":"json"}]',
],
'DeployServiceInstance' => [
'summary' => 'Deploys a service instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '36959',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of a request. Generate a unique value from the client for this parameter. The token can contain only ASCII characters and must be no more than 64 characters in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'si-b58c874912fc4294****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID. Possible values:'."\n"
."\n"
.'- cn-hangzhou: China (Hangzhou).'."\n"
."\n"
.'- ap-southeast-1: Singapore.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D****'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D****\\"\\n}","type":"json"}]',
'title' => 'DeployServiceInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:DeployServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeRegions' => [
'summary' => 'Queries the available regions.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36938',
'abilityTreeNodes' => ['FEATUREcomputenest2G0818', 'FEATUREcomputenest1Z49ZW', 'FEATUREcomputenest21Y74A', 'FEATUREcomputenestHX5MKK', 'FEATUREcomputenestB2MIVU', 'FEATUREcomputenestDWH8PE', 'FEATUREcomputenest8XBPFA', 'FEATUREcomputenestC6045N', 'FEATUREcomputenestA4RHS0', 'FEATUREcomputenestQE1OA6', 'FEATUREcomputenest2LCZ5B', 'FEATUREcomputenestJ4D829', 'FEATUREcomputenest0EG8HU', 'FEATUREcomputenest3Q4PWW', 'FEATUREcomputenestHUKJ18'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
'Regions' => [
'description' => 'The list of available regions.',
'type' => 'array',
'items' => [
'description' => 'The region information.',
'type' => 'object',
'properties' => [
'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => 'computenest.cn-hangzhou.aliyuncs.com'],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"computenest.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeRegions',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
],
],
'ramActions' => [],
],
'GenerateServicePolicy' => [
'summary' => 'Queries the missing access policies before creating a service instance.',
'methods' => ['post'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcomputenest2G0818', 'FEATUREcomputenest1Z49ZW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'service-b3e9ed878b0c4xxxxxx', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'example' => 'draft', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => false, 'example' => '模板1', 'title' => ''],
],
[
'name' => 'TrialType',
'in' => 'query',
'schema' => ['description' => 'The trial type. Default value: NotTrial. Valid values:'."\n"
."\n"
.'- Trial: Trial is supported.'."\n"
."\n"
.'- NotTrial: Trial is not supported.', 'type' => 'string', 'required' => false, 'example' => 'NotTrial', 'title' => ''],
],
[
'name' => 'OperationTypes',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The operation types for which policy information needs to be generated.',
'type' => 'array',
'items' => ['description' => 'The operation type for which policy information needs to be generated. Valid values:'."\n"
."\n"
.'- CreateServiceInstance: Creates a service instance.'."\n"
.'- UpdateServiceInstance: Updates a service instance.'."\n"
.'- DeleteServiceInstance: Deletes a service instance.'."\n"
.'> Default value: all valid values.', 'type' => 'string', 'required' => false, 'example' => 'CreateServiceInstance', 'title' => ''],
'required' => false,
'maxItems' => 30,
'title' => '',
'example' => '',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The parameters required to check the deployment permissions of the service instance.', 'type' => 'object', 'required' => false, 'example' => '{\\"EnablePublicIp\\":null,\\"DeploymentMode\\":\\"ExistingECS\\",\\"ExistingInstanceId\\":\\"i-bp1cg4t5o9kol5tdiw1q\\",\\"RegionId\\":\\"cn-hangzhou\\",\\"InternetChargeType\\":\\"PayByTraffic\\"}', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Policy' => ['description' => 'The custom properties of the required access policy.', 'type' => 'string', 'example' => '{Statement": [{ "Action": ["oos:*"], "Effect": "Allow", "Resource": "*"},{ "Action": ["ecs:DescribeInstances"], "Effect": "Allow", "Resource": "*"},{ "Action": ["ecs:RunInstance"], "Effect": "Allow", "Resource": "*"}], "Version": "1"}', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5040BE9E-8DA2-5C9D-9B70-0EE6027A14BC', 'title' => ''],
'MissingPolicy' => [
'description' => 'The missing access policies.',
'type' => 'array',
'items' => [
'description' => 'The missing access policy.',
'type' => 'object',
'properties' => [
'ServiceName' => ['description' => 'The service name to which the access policy belongs.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
'Resource' => ['description' => 'The specific resource that is authorized. An asterisk (*) indicates all resources.', 'type' => 'string', 'example' => '*', 'title' => ''],
'Action' => [
'description' => 'The access policy information.',
'type' => 'array',
'items' => ['description' => 'The access policy information.', 'type' => 'string', 'example' => '['."\n"
.' "ecs:DescribeInstances",'."\n"
.' "ecs:RunInstance"'."\n"
.' ]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
[],
],
'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' => 'Query service access policies',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateServicePolicy'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GenerateServicePolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
],
],
],
],
],
'GetBackup' => [
'summary' => 'Retrieves the details of a backup.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '246769',
'abilityTreeNodes' => ['FEATUREcomputenestL64NT4'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'backup-cad4a85ff5e340388b93'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'BackupId' => ['title' => 'Id of the request', 'description' => 'The backup ID.', 'type' => 'string', 'example' => 'backup-cad4a85ff5e340388b93'],
'ServiceInstanceId' => ['title' => 'Id of the request', 'description' => 'The service instance ID.', 'type' => 'string', 'example' => 'si-b58c874912fc4294****'],
'StartTime' => ['title' => 'Id of the request', 'description' => 'The time when the backup started.', 'type' => 'string', 'example' => '2022-01-01T11:00:00'],
'EndTime' => ['title' => 'Id of the request', 'description' => 'The time when the backup ended.', 'type' => 'string', 'example' => '2022-01-01T12:00:00'],
'Status' => ['title' => 'Id of the request', 'description' => 'The status.'."\n"
."\n"
.'- Creating: The backup is being created.'."\n"
."\n"
.'- Created: The backup is created.'."\n"
."\n"
.'- CreateFailed: The backup failed to be created.'."\n"
."\n"
.'- Deleting: The backup is being deleted.'."\n"
."\n"
.'- Deleted: The backup is deleted.'."\n"
."\n"
.'- DeleteFailed: The backup failed to be deleted.', 'type' => 'string', 'example' => 'Creating'],
'Description' => ['title' => 'Id of the request', 'description' => 'The backup description.', 'type' => 'string', 'example' => 'No description'],
'CreateTime' => ['title' => 'Id of the request', 'description' => 'The time when the backup was created.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z'],
'ModifiedTime' => ['title' => 'Id of the request', 'description' => 'The time when the backup was last modified.', 'type' => 'string', 'example' => '2025-03-10T19:26:20Z'],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
'StatusDetail' => ['title' => '', 'description' => 'The detailed status of the deployment instance.', 'type' => 'string', 'example' => 'Disk i-xxxx backup failed, error message: error'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'GetBackup',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider enabled the upgrade and downgrade feature and configured its parameters when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:GetBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupId\\": \\"backup-cad4a85ff5e340388b93\\",\\n \\"ServiceInstanceId\\": \\"si-b58c874912fc4294****\\",\\n \\"StartTime\\": \\"2022-01-01T11:00:00\\",\\n \\"EndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Description\\": \\"No description\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"ModifiedTime\\": \\"2025-03-10T19:26:20Z\\",\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"StatusDetail\\": \\"Disk i-xxxx backup failed, error message: error\\"\\n}","type":"json"}]',
],
'GetNetworkAvailableZones' => [
'summary' => 'Returns a list of available zones for a specified region.',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '172337',
'abilityTreeNodes' => ['FEATUREcomputenestHX5MKK'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PrivateVpcConnectionMode',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The connection mode. Valid values: \\`PrivateLink\\` and \\`OverlayLink\\`. \\`OverlayLink\\` is an overlay link based on Application-aware Network Service Mesh (ANSM).', 'example' => 'PrivateLink'],
],
[
'name' => 'ZoneId',
'in' => 'formData',
'schema' => ['type' => 'string', 'title' => '', 'description' => 'The zone for the service deployment.', 'required' => false, 'example' => 'cn-hangzhou-i'],
],
[
'name' => 'NetworkRegionId',
'in' => 'formData',
'schema' => ['type' => 'string', 'title' => '', 'description' => 'The region of the virtual network.', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceEndpointServiceType',
'in' => 'formData',
'schema' => ['type' => 'string', 'title' => '', 'description' => 'The direction of the internal-facing access. Valid values: \\`Forward\\` and \\`Reverse\\`.', 'required' => false, 'example' => 'Forward'],
],
[
'name' => 'ServiceRegionId',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => 'The ID of the region where the service is located.', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'IsPoc',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'description' => 'Specifies whether the service is a trial.', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
'name' => 'ServiceId',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => 'The service ID.', 'required' => false, 'title' => '', 'example' => 'service-55fc2eabbce647fa976b'],
],
[
'name' => 'ServiceVersion',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => 'The service version.', 'required' => false, 'title' => '', 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'type' => 'object',
'properties' => [
'RegionIdList' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'],
'description' => 'The list of region IDs.',
'title' => '',
'example' => '',
],
'ZoneIdList' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => 'The zone ID.', 'title' => '', 'example' => 'cn-hangzhou-i'],
'description' => 'The list of zone IDs.',
'title' => '',
'example' => '',
],
],
'description' => 'The data returned.',
'title' => '',
'example' => '',
],
'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'A17F9930-E2DC-5E87-B6D6-B0BCD2B00834'],
],
'title' => '',
'description' => 'PlainResult',
'example' => '',
],
],
],
'title' => 'GetNetworkAvailableZones',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider enabled the upgrade/downgrade feature and set the related parameters when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetNetworkAvailableZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RegionIdList\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"ZoneIdList\\": [\\n \\"cn-hangzhou-i\\"\\n ]\\n },\\n \\"RequestId\\": \\"A17F9930-E2DC-5E87-B6D6-B0BCD2B00834\\"\\n}","type":"json"}]',
],
'GetService' => [
'summary' => 'Retrieves the details of a specified service.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36940',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'service-0e6fca6a51a544xxxxxx', 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1.0', 'title' => ''],
],
[
'name' => 'ShowDetails',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'Specifies whether to return the detailed information of the service.',
'type' => 'array',
'items' => ['description' => 'Specifies whether to return the detailed information of the service.', 'type' => 'string', 'required' => false, 'example' => 'ServiceInstanceRoleInfo', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'WordPress Community Edition', 'required' => false, 'title' => ''],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => false, 'example' => 'si-b58c874912fc4294****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the service. Valid values:'."\n"
."\n"
.'- Draft: The service is in the draft state.'."\n"
."\n"
.'- Beta: The service is in a pre-release state. The service cannot be modified but can be shared with other users.'."\n"
."\n"
.'- Submitted: The service is submitted for approval. The service cannot be modified.'."\n"
."\n"
.'- Approved: The service is approved. The service cannot be modified but can be published.'."\n"
."\n"
.'- Launching: The service is being published.'."\n"
."\n"
.'- Online: The service is published.'."\n"
."\n"
.'- Offline: The service is unpublished.'."\n"
."\n"
.'- Creating: The service is being created.'."\n"
."\n"
.'- CreateFailed: The service failed to be created.'."\n"
."\n"
.'- Updating: The service is being updated.'."\n"
."\n"
.'- UpdateFailed: The service failed to be updated.', 'type' => 'string', 'example' => 'Online', 'title' => ''],
'DeployMetadata' => ['description' => 'The deployment configuration of the service. The configuration is stored as a JSON string. The data format of the string varies based on the deployment type.', 'type' => 'string', 'example' => '{\\"TemplateUrl\\": \\"http://tidbRosFile\\"}', 'title' => ''],
'PublishTime' => ['description' => 'The time when the service was published.', 'type' => 'string', 'example' => '2021-05-21T00:00:00Z', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA', 'title' => ''],
'Version' => ['description' => 'The service version.', 'type' => 'string', 'example' => '1.0', 'title' => ''],
'DeployType' => ['description' => 'The deployment type. Valid values:'."\n"
."\n"
.'- ros: The service is deployed using ROS.'."\n"
."\n"
.'- terraform: The service is deployed using Terraform.'."\n"
."\n"
.'- spi: The service is deployed by calling a Service Provider Interface (SPI).'."\n"
."\n"
.'- operation: The service is an Alibaba Cloud Managed Services deployment.'."\n"
."\n"
.'- container: The service is deployed using a container.'."\n"
."\n"
.'- pkg: The service is a package service.', 'type' => 'string', 'example' => 'ros', 'title' => ''],
'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'service-0e6fca6a51a544xxxxxx', 'title' => ''],
'SupplierUrl' => ['description' => 'The URL of the service provider.', 'type' => 'string', 'example' => 'http://example.com', 'title' => ''],
'ServiceType' => ['description' => 'The service type. Valid values:'."\n"
."\n"
.'- private: The service is deployed in the user\'s account.'."\n"
."\n"
.'- managed: The service is hosted in the service provider\'s account.'."\n"
."\n"
.'- operation: The service is an Alibaba Cloud Managed Service.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'ServiceProductUrl' => ['description' => 'The URL of the product page.', 'type' => 'string', 'example' => 'http://example1.com', 'title' => ''],
'SupplierName' => ['description' => 'The name of the service provider.', 'type' => 'string', 'example' => 'Company A', 'title' => ''],
'ServiceInfos' => [
'description' => 'The service information.',
'type' => 'array',
'items' => [
'description' => 'The service information.',
'type' => 'object',
'properties' => [
'Locale' => ['description' => 'The language of the service configuration. Valid values:'."\n"
."\n"
.'- zh-CN: Chinese.'."\n"
."\n"
.'- en-US: English.', 'type' => 'string', 'example' => 'zh-CN', 'title' => ''],
'Image' => ['description' => 'The URL of the service icon.', 'type' => 'string', 'example' => 'https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png', 'title' => ''],
'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Database B', 'title' => ''],
'ShortDescription' => ['description' => 'The summary of the service.', 'type' => 'string', 'example' => 'B is an open-source distributed relational database independently designed and developed by Company A.', 'title' => ''],
'Agreements' => [
'description' => 'The service agreements.',
'type' => 'array',
'items' => [
'description' => 'The service agreements.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The agreement name.', 'type' => 'string', 'example' => 'User agreement', 'title' => ''],
'Url' => ['description' => 'The agreement URL.', 'type' => 'string', 'example' => 'https://url', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Softwares' => [
'description' => 'The service software.',
'type' => 'array',
'items' => [
'description' => 'The service software.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The software name.', 'type' => 'string', 'example' => 'wordpress', 'title' => ''],
'Version' => ['description' => 'The software version.', 'type' => 'string', 'example' => '6.0.1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'IsSupportOperated' => ['description' => 'Specifies whether to enable Alibaba Cloud Managed Services. Default value: false. Valid values:'."\n"
."\n"
.'- true: enabled.'."\n"
."\n"
.'- false: disabled.'."\n"
."\n"
.'> This parameter is required when **ServiceType** is set to **private**.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'PolicyNames' => ['description' => 'The policy names. A single policy name can be up to 128 characters in length. Separate multiple names with commas (,). Only policies related to Alibaba Cloud Managed Services are supported.', 'type' => 'string', 'example' => 'policyName1, policyName2', 'title' => ''],
'Duration' => ['description' => 'The duration of the Alibaba Cloud Managed Services. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '259200', 'title' => ''],
'ShareType' => ['description' => 'The share type. Valid values:'."\n"
."\n"
.'- Public: The service is public. Formal and trial deployments are not restricted.'."\n"
."\n"
.'- Restricted: The service is restricted. Formal and trial deployments are restricted.'."\n"
."\n"
.'- OnlyFormalRestricted: Only formal deployments are restricted.'."\n"
."\n"
.'- OnlyTrialRestricted: Only trial deployments are restricted.'."\n"
."\n"
.'- Hidden: The service is hidden, is not visible, and you cannot request permissions for deployment.', 'type' => 'string', 'example' => 'Public', 'title' => ''],
'Permission' => ['description' => 'The permission type. Valid values:'."\n"
."\n"
.'- Deployable: The service is deployable.'."\n"
."\n"
.'- Accessible: The service is accessible.', 'type' => 'string', 'example' => 'Deployable', 'title' => ''],
'AlarmMetadata' => ['description' => 'The alert configuration of the service.'."\n"
."\n"
.'> This configuration takes effect only if you configure an alert policy in **PolicyNames**.', 'type' => 'string', 'example' => '{ "TemplateUrl": "http://template.file.url", // Application group level alarm metadata "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] }', 'title' => ''],
'VersionName' => ['description' => 'The version name.', 'type' => 'string', 'example' => 'v1', 'title' => ''],
'Tags' => [
'description' => 'The service tags.',
'type' => 'array',
'items' => [
'description' => 'The service tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TrialDuration' => ['description' => 'The trial duration in days. The maximum trial duration is 30 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''],
'SupplierDesc' => ['description' => 'The description of the service provider.', 'type' => 'string', 'example' => 'Alibaba Cloud Compute Nest team', 'title' => ''],
'TrialType' => ['description' => 'The trial type. Valid values:'."\n"
."\n"
.'- Trial: The service supports trial.'."\n"
."\n"
.'- NotTrial: The service does not support trial.', 'type' => 'string', 'example' => 'Trial', 'title' => ''],
'TenantType' => ['description' => 'The tenant type. Valid values:'."\n"
."\n"
.'- SingleTenant: The service is a single-tenant service.'."\n"
."\n"
.'- MultiTenant: The service is a multitenancy service.', 'type' => 'string', 'example' => 'SingleTenant', 'title' => ''],
'LicenseMetadata' => ['description' => 'The license metadata.', 'type' => 'string', 'example' => '{\\"PayType\\":\\"CustomFixTime\\",\\"DefaultLicenseDays\\":7,\\"CustomMetadata\\":[{\\"TemplateName\\":\\" template1\\",\\"SpecificationName\\":\\"bandwith-0\\",\\"CustomData\\":\\"1\\"}]}', 'title' => ''],
'OperationMetadata' => ['description' => 'The O\\&M configuration.', 'type' => 'string', 'example' => '{\\"PrometheusConfigMap\\":{\\"New_Vpc_Ack_And_Jumpserver\\":{}}}', 'title' => ''],
'LogMetadata' => ['description' => 'The application log configuration.', 'type' => 'string', 'example' => '{\\"Logstores\\":[]}', 'title' => ''],
'SupplierLogo' => ['description' => 'The icon of the service provider.', 'type' => 'string', 'example' => 'https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png', 'title' => ''],
'DeployFrom' => ['description' => 'The deployment channel. Valid values:'."\n"
."\n"
.'- NoWhere: The service has no deployment channel.'."\n"
."\n"
.'- Marketplace: The service is deployed from Alibaba Cloud Marketplace.'."\n"
."\n"
.'- ComputeNest: The service is deployed from Compute Nest.', 'type' => 'string', 'example' => 'Marketplace', 'title' => ''],
'Categories' => ['description' => 'The service category name.', 'type' => 'string', 'example' => 'AI', 'title' => ''],
'SupplierUid' => ['description' => 'The Alibaba Cloud account ID of the service provider.', 'type' => 'integer', 'format' => 'int64', 'example' => '158927391332*****', 'title' => ''],
'Commodity' => [
'description' => 'The commodity specifications.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'Marketplace: Alibaba Cloud Marketplace.'."\n"
."\n"
.'Css: Lingxiao.', 'type' => 'string', 'example' => 'Marketplace', 'title' => ''],
'ChargeType' => ['description' => 'The billing method.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'**PREPAY** (default): subscription.'."\n"
."\n"
.'**POSTPAY**: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
'OrderTime' => [
'description' => 'The order time.',
'type' => 'object',
'additionalProperties' => [
'type' => 'array',
'items' => ['description' => 'The order time.', 'type' => 'string', 'example' => '[1:Month]', 'title' => ''],
'description' => 'The order time.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmjj00****', 'title' => ''],
'Specifications' => [
'description' => 'The Alibaba Cloud Marketplace specification details.',
'type' => 'array',
'items' => [
'description' => 'The Alibaba Cloud Marketplace specification details.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'cmjj00****'."\n", 'title' => ''],
'Name' => ['description' => 'The specification name.', 'type' => 'string', 'example' => 'specifications1'."\n", 'title' => ''],
'Times' => [
'description' => 'The purchasable duration. Unit: week or year.',
'type' => 'array',
'items' => ['description' => 'The purchasable duration. Unit: week or year.', 'type' => 'string', 'example' => '[1:Month]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'MarketplaceMetadata' => [
'description' => 'The Alibaba Cloud Marketplace metadata.',
'type' => 'object',
'properties' => [
'SpecificationMappings' => [
'description' => 'The mapping between commodity specifications and templates or packages.',
'type' => 'array',
'items' => [
'description' => 'The mapping between commodity specifications and templates or packages.',
'type' => 'object',
'properties' => [
'SpecificationCode' => ['description' => 'The specification code of the Alibaba Cloud Marketplace commodity.', 'type' => 'string', 'example' => 'cmjj00****', 'title' => ''],
'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Standalone edition', 'title' => ''],
'SpecificationName' => ['description' => 'The package name.', 'type' => 'string', 'example' => 'Package 1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'CssMetadata' => [
'description' => 'The Lingxiao configuration metadata.',
'type' => 'object',
'properties' => [
'ComponentsMappings' => [
'description' => 'The billing item mappings.',
'type' => 'array',
'items' => [
'description' => 'The billing item mappings.',
'type' => 'object',
'properties' => [
'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => '单机版', 'title' => ''],
'Mappings' => [
'description' => 'The mappings.',
'type' => 'object',
'additionalProperties' => ['description' => 'The mappings.', 'type' => 'string', 'example' => '{{DBInstanceStorage}}'."\n", 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'SaasBoostMetadata' => ['description' => 'The SaasBoost configuration metadata.', 'type' => 'string', 'example' => '{'."\n"
.' "Enabled":false'."\n"
.' //Public access URL'."\n"
.' "PublicAccessUrl":"https://example.com"'."\n"
.'}', 'title' => ''],
'DeployPage' => ['description' => 'The deployment page.', 'type' => 'string', 'example' => 'Order: Order page'."\n"
.'Detail: Details page', 'title' => ''],
],
'title' => '',
'example' => '',
],
'InstanceRoleInfos' => [
'description' => 'The information about the roles that are created in the service template.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''],
'RoleName' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'ram-for-dts', 'title' => ''],
'PolicyDocument' => ['description' => 'The content of the control policy.', 'type' => 'string', 'example' => '{\\n \\"Version\\": \\"1\\",\\n \\"Statement\\": [\\n {\\n \\"Effect\\": \\"Allow\\",\\n \\"Action\\": \\"*\\",\\n \\"Principal\\": \\"*\\",\\n \\"Resource\\": \\"*\\"\\n }\\n ]\\n}', 'title' => ''],
'Principals' => [
'description' => 'The information about the RAM entity.',
'type' => 'array',
'items' => ['description' => 'The information about the RAM entity.', 'type' => 'string', 'example' => '[{\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}, {\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => 'Information about the ram role created in the service template.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ServiceDocumentInfos' => [
'description' => 'The service documents.',
'type' => 'array',
'items' => [
'description' => 'The service documents.',
'type' => 'object',
'properties' => [
'Locale' => ['description' => 'The language of the service document. Valid values:'."\n"
."\n"
.'- zh-CN: Chinese.'."\n"
."\n"
.'- en-US: English.', 'type' => 'string', 'example' => 'zh-CN', 'title' => ''],
'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => '单机版', 'title' => ''],
'DocumentUrl' => ['description' => 'The document URL.', 'type' => 'string', 'example' => 'https://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'SupportContacts' => [
'description' => 'The contact information of the service provider.',
'type' => 'array',
'items' => [
'description' => 'The contact information of the service provider.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type of the contact information.', 'type' => 'string', 'example' => 'Email'."\n", 'title' => ''],
'Value' => ['description' => 'The contact information.', 'type' => 'string', 'example' => 'supplier@example.com', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ComplianceMetadata' => [
'description' => 'The compliance package metadata.',
'type' => 'object',
'properties' => [
'CompliancePacks' => [
'description' => 'The list of compliance packages.',
'type' => 'array',
'items' => ['description' => 'The compliance package.', 'type' => 'string', 'example' => 'VpcDataRisk', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'ServiceLocaleConfigs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OriginalValue' => ['description' => 'The raw data value of the service information.', 'type' => 'string', 'example' => 'Service Name', 'title' => ''],
'ZhValue' => ['description' => 'The Chinese value of the service information.', 'type' => 'string', 'example' => '服务名称', 'title' => ''],
'EnValue' => ['description' => 'The English value of the service information.', 'type' => 'string', 'example' => 'Service Name', 'title' => ''],
],
'description' => 'The multilingual configurations of the service.',
'title' => '',
'example' => '',
],
'description' => 'The multilingual configurations of the service.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
[],
[],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Online\\",\\n \\"DeployMetadata\\": \\"{\\\\\\\\\\\\\\"TemplateUrl\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"http://tidbRosFile\\\\\\\\\\\\\\"}\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"Version\\": \\"1.0\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-0e6fca6a51a544xxxxxx\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"ServiceProductUrl\\": \\"http://example1.com\\",\\n \\"SupplierName\\": \\"Company A\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png\\",\\n \\"Name\\": \\"Database B\\",\\n \\"ShortDescription\\": \\"B is an open-source distributed relational database independently designed and developed by Company A.\\",\\n \\"Agreements\\": [\\n {\\n \\"Name\\": \\"User agreement\\",\\n \\"Url\\": \\"https://url\\"\\n }\\n ],\\n \\"Softwares\\": [\\n {\\n \\"Name\\": \\"wordpress\\",\\n \\"Version\\": \\"6.0.1\\"\\n }\\n ]\\n }\\n ],\\n \\"IsSupportOperated\\": false,\\n \\"PolicyNames\\": \\"policyName1, policyName2\\",\\n \\"Duration\\": 259200,\\n \\"ShareType\\": \\"Public\\",\\n \\"Permission\\": \\"Deployable\\",\\n \\"AlarmMetadata\\": \\"{ \\\\\\"TemplateUrl\\\\\\": \\\\\\"http://template.file.url\\\\\\", // Application group level alarm metadata \\\\\\"ApplicationGroups\\\\\\": [ { \\\\\\"Name\\\\\\": \\\\\\"applicationGroup1\\\\\\", \\\\\\"TemplateUrl\\\\\\": \\\\\\"url1\\\\\\" }, { \\\\\\"Name\\\\\\": \\\\\\"applicationGroup2\\\\\\", \\\\\\"TemplateUrl\\\\\\": \\\\\\"url2\\\\\\" } ] }\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"TrialDuration\\": 7,\\n \\"SupplierDesc\\": \\"Alibaba Cloud Compute Nest team\\",\\n \\"TrialType\\": \\"Trial\\",\\n \\"TenantType\\": \\"SingleTenant\\",\\n \\"LicenseMetadata\\": \\"{\\\\\\\\\\\\\\"PayType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CustomFixTime\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DefaultLicenseDays\\\\\\\\\\\\\\":7,\\\\\\\\\\\\\\"CustomMetadata\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"TemplateName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\" template1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SpecificationName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bandwith-0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CustomData\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}]}\\",\\n \\"OperationMetadata\\": \\"{\\\\\\\\\\\\\\"PrometheusConfigMap\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"New_Vpc_Ack_And_Jumpserver\\\\\\\\\\\\\\":{}}}\\",\\n \\"LogMetadata\\": \\"{\\\\\\\\\\\\\\"Logstores\\\\\\\\\\\\\\":[]}\\",\\n \\"SupplierLogo\\": \\"https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png\\",\\n \\"DeployFrom\\": \\"Marketplace\\",\\n \\"Categories\\": \\"AI\\",\\n \\"SupplierUid\\": 0,\\n \\"Commodity\\": {\\n \\"Type\\": \\"Marketplace\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"OrderTime\\": {\\n \\"key\\": [\\n \\"[1:Month]\\"\\n ]\\n },\\n \\"CommodityCode\\": \\"cmjj00****\\",\\n \\"Specifications\\": [\\n {\\n \\"Code\\": \\"cmjj00****\\\\n\\",\\n \\"Name\\": \\"specifications1\\\\n\\",\\n \\"Times\\": [\\n \\"[1:Month]\\"\\n ]\\n }\\n ],\\n \\"MarketplaceMetadata\\": {\\n \\"SpecificationMappings\\": [\\n {\\n \\"SpecificationCode\\": \\"cmjj00****\\",\\n \\"TemplateName\\": \\"Standalone edition\\",\\n \\"SpecificationName\\": \\"Package 1\\"\\n }\\n ]\\n },\\n \\"CssMetadata\\": {\\n \\"ComponentsMappings\\": [\\n {\\n \\"TemplateName\\": \\"单机版\\",\\n \\"Mappings\\": {\\n \\"key\\": \\"{{DBInstanceStorage}}\\\\n\\"\\n }\\n }\\n ]\\n },\\n \\"SaasBoostMetadata\\": \\"{\\\\n \\\\\\"Enabled\\\\\\":false\\\\n //Public access URL\\\\n \\\\\\"PublicAccessUrl\\\\\\":\\\\\\"https://example.com\\\\\\"\\\\n}\\",\\n \\"DeployPage\\": \\"Order: Order page\\\\nDetail: Details page\\"\\n },\\n \\"InstanceRoleInfos\\": [\\n {\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"RoleName\\": \\"ram-for-dts\\",\\n \\"PolicyDocument\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\": [\\\\\\\\n {\\\\\\\\n \\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Principal\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Resource\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\"\\\\\\\\n }\\\\\\\\n ]\\\\\\\\n}\\",\\n \\"Principals\\": [\\n \\"[{\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}, {\'PrincipalType\': \'RamUser\', \'PrincipalId\': \'xxx\'}]\\"\\n ]\\n }\\n ],\\n \\"ServiceDocumentInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"TemplateName\\": \\"单机版\\",\\n \\"DocumentUrl\\": \\"https://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2\\"\\n }\\n ],\\n \\"SupportContacts\\": [\\n {\\n \\"Type\\": \\"Email\\\\n\\",\\n \\"Value\\": \\"supplier@example.com\\"\\n }\\n ],\\n \\"ComplianceMetadata\\": {\\n \\"CompliancePacks\\": [\\n \\"VpcDataRisk\\"\\n ]\\n },\\n \\"ServiceLocaleConfigs\\": [\\n {\\n \\"OriginalValue\\": \\"Service Name\\",\\n \\"ZhValue\\": \\"服务名称\\",\\n \\"EnValue\\": \\"Service Name\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'GetService',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetService',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#ServiceId}'],
],
],
],
],
'translator' => 'manual',
],
'GetServiceEstimateCost' => [
'summary' => 'Queries the estimated cost of creating a service instance.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '113848',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'service-12xxxxxx', 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'required' => false, 'title' => ''],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The parameters to deploy the service instance.', 'type' => 'object', 'required' => false, 'example' => '{ \\"RegionId\\": \\"cn-hangzhou\\", \\"InstanceType\\": \\"ecs.g5.large\\"}', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value for each request. The **ClientToken** supports only ASCII characters and cannot be longer than 64 characters.', 'type' => 'string', 'required' => false, 'example' => 'qwertyuiop', 'title' => ''],
],
[
'name' => 'TrialType',
'in' => 'query',
'schema' => ['description' => 'The usage type. Valid values:'."\n"
."\n"
.'- Trial: The service supports a free trial.'."\n"
."\n"
.'- NotTrial: The service does not support a free trial.', 'type' => 'string', 'required' => false, 'example' => 'NotTrial', 'title' => ''],
],
[
'name' => 'SpecificationName',
'in' => 'query',
'schema' => ['description' => 'The specification name.', 'type' => 'string', 'example' => 'Package 1', 'required' => false, 'title' => ''],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => false, 'example' => 'si-d6ab3a63ccbb4b17xxxx', 'title' => ''],
],
[
'name' => 'Commodity',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The subscription period for the purchase order.',
'type' => 'object',
'properties' => [
'PayPeriodUnit' => ['description' => 'The unit of the subscription duration. Valid values:'."\n"
."\n"
.'- Year: Year.'."\n"
."\n"
.'- Month: Month.'."\n"
."\n"
.'- Day: Day.', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''],
'PayPeriod' => ['description' => 'The subscription duration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'CouponId' => ['description' => 'The coupon ID.', 'type' => 'string', 'required' => false, 'example' => '302070970220', 'title' => ''],
'QuotationId' => ['description' => 'The ID of the private offer in Alibaba Cloud Marketplace.', 'type' => 'string', 'required' => false, 'example' => ' 17cde2e8-2f5d-xxxx-xxxx-5120dd215d66', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'OperationName',
'in' => 'query',
'schema' => ['description' => 'The name of the upgrade or downgrade operation.', 'type' => 'string', 'example' => 'Parameter configuration change', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '08ABBB67-39C9-5EE7-98E5-80486F75CE8D'],
'Resources' => [
'description' => 'The list of resources.',
'type' => 'object',
'additionalProperties' => ['description' => 'The list of resources.', 'type' => 'any', 'example' => '{'."\n"
.' "EcsInstance" : {'."\n"
.' "Type" : "ALIYUN::ECS::Instance",'."\n"
.' "Success" : true,'."\n"
.' "Result" : {'."\n"
.' "Order" : {'."\n"
.' "Currency" : "CNY",'."\n"
.' "RuleIds" : [ "102111101338****" ],'."\n"
.' "DetailInfos" : {'."\n"
.' "ResourcePriceModel" : [ {'."\n"
.' "OriginalPrice" : 0,'."\n"
.' "DiscountPrice" : 0,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "bandwidth",'."\n"
.' "TradePrice" : 0'."\n"
.' }, {'."\n"
.' "OriginalPrice" : 0,'."\n"
.' "DiscountPrice" : 0,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "image",'."\n"
.' "TradePrice" : 0'."\n"
.' }, {'."\n"
.' "OriginalPrice" : 0.366666,'."\n"
.' "DiscountPrice" : 0.249012,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "instanceType",'."\n"
.' "TradePrice" : 0.117654'."\n"
.' }, {'."\n"
.' "OriginalPrice" : 0.055555,'."\n"
.' "DiscountPrice" : 0.037729,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "systemDisk",'."\n"
.' "TradePrice" : 0.017826'."\n"
.' } ]'."\n"
.' },'."\n"
.' "TradeAmount" : 0.135,'."\n"
.' "OriginalAmount" : 0.422,'."\n"
.' "Coupons" : {'."\n"
.' "Coupon" : [ ]'."\n"
.' },'."\n"
.' "DiscountAmount" : 0.287'."\n"
.' },'."\n"
.' "OrderSupplement" : {'."\n"
.' "PriceUnit" : "/Hour",'."\n"
.' "ChargeType" : "PostPaid",'."\n"
.' "Quantity" : 1,'."\n"
.' "PriceType" : "Total"'."\n"
.' },'."\n"
.' "Rules" : {'."\n"
.' "Rule" : [ {'."\n"
.' "RuleDescId" : "102111101338****",'."\n"
.' "Name" : "合同优惠_多计费项优惠_3.208750折"'."\n"
.' } ]'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.' }', 'title' => ''],
'example' => '{'."\n"
.' "EcsInstance" : {'."\n"
.' "Type" : "ALIYUN::ECS::Instance",'."\n"
.' "Success" : true,'."\n"
.' "Result" : {'."\n"
.' "Order" : {'."\n"
.' "Currency" : "CNY",'."\n"
.' "RuleIds" : [ "102111101338****" ],'."\n"
.' "DetailInfos" : {'."\n"
.' "ResourcePriceModel" : [ {'."\n"
.' "OriginalPrice" : 0,'."\n"
.' "DiscountPrice" : 0,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "bandwidth",'."\n"
.' "TradePrice" : 0'."\n"
.' }, {'."\n"
.' "OriginalPrice" : 0,'."\n"
.' "DiscountPrice" : 0,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "image",'."\n"
.' "TradePrice" : 0'."\n"
.' }, {'."\n"
.' "OriginalPrice" : 0.366666,'."\n"
.' "DiscountPrice" : 0.249012,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "instanceType",'."\n"
.' "TradePrice" : 0.117654'."\n"
.' }, {'."\n"
.' "OriginalPrice" : 0.055555,'."\n"
.' "DiscountPrice" : 0.037729,'."\n"
.' "SubRules" : {'."\n"
.' "Rule" : [ ]'."\n"
.' },'."\n"
.' "Resource" : "systemDisk",'."\n"
.' "TradePrice" : 0.017826'."\n"
.' } ]'."\n"
.' },'."\n"
.' "TradeAmount" : 0.135,'."\n"
.' "OriginalAmount" : 0.422,'."\n"
.' "Coupons" : {'."\n"
.' "Coupon" : [ ]'."\n"
.' },'."\n"
.' "DiscountAmount" : 0.287'."\n"
.' },'."\n"
.' "OrderSupplement" : {'."\n"
.' "PriceUnit" : "/Hour",'."\n"
.' "ChargeType" : "PostPaid",'."\n"
.' "Quantity" : 1,'."\n"
.' "PriceType" : "Total"'."\n"
.' },'."\n"
.' "Rules" : {'."\n"
.' "Rule" : [ {'."\n"
.' "RuleDescId" : "102111101338****",'."\n"
.' "Name" : "Contract_Discount_Multi-item_67.9125%_Off"'."\n"
.' } ]'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.' }',
'title' => '',
],
'Commodity' => [
'description' => 'The information about the Alibaba Cloud Marketplace purchase order.',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Result' => [
'type' => 'object',
'properties' => [
'Order' => [
'type' => 'object',
'properties' => [
'Currency' => ['description' => 'The currency code.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
'TradeAmount' => ['description' => 'The amount after the discount is applied.', 'type' => 'string', 'example' => '9.99', 'title' => ''],
'DiscountAmount' => ['description' => 'The discount amount.', 'type' => 'string', 'example' => '1.99', 'title' => ''],
'OriginalAmount' => ['description' => 'The original amount.', 'type' => 'string', 'example' => '11.98', 'title' => ''],
],
'description' => 'The order information.',
'title' => '',
'example' => '',
],
'InquiryType' => ['description' => 'The inquiry type. Valid values:'."\n"
."\n"
.'1. Buy: an inquiry for a new purchase.'."\n"
."\n"
.'2. ModificationBuy: an inquiry for an upgrade or downgrade.', 'type' => 'string', 'example' => 'Buy', 'title' => ''],
'SubOrders' => [
'type' => 'object',
'properties' => [
'SubOrder' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModuleInstance' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModuleId' => ['description' => 'The module ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''],
'ModuleName' => ['description' => 'The module name.', 'type' => 'string', 'example' => '数据库类型', 'title' => ''],
'ModuleCode' => ['description' => 'The module code.', 'type' => 'string', 'example' => 'rds_dbtype', 'title' => ''],
'TotalProductFee' => ['description' => 'The original price of the product, in CNY.', 'type' => 'number', 'format' => 'double', 'example' => '10.00', 'title' => ''],
'DiscountFee' => ['description' => 'The discount, in CNY.', 'type' => 'number', 'format' => 'double', 'example' => '1.99', 'title' => ''],
'PayFee' => ['description' => 'The amount payable, in CNY.', 'type' => 'number', 'format' => 'double', 'example' => '8.01', 'title' => ''],
'PriceUnit' => ['description' => 'The unit of the price.', 'type' => 'string', 'example' => '元/GB/小时', 'title' => ''],
'IsPricingModule' => ['description' => 'Indicates whether the module is a billing item.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'NeedOrderPay' => ['description' => 'Indicates whether payment is required for the module in the order.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PriceType' => ['description' => 'The pricing type.', 'type' => 'string', 'example' => 'hourPrice', 'title' => ''],
'ModuleAttrs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The attribute type. Valid values:'."\n"
."\n"
.'1. 1: product attribute'."\n"
."\n"
.'2. 2: specification attribute'."\n"
."\n"
.'3. 3: module attribute'."\n"
."\n"
.'4. 4: external parameter (reserved)', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'Name' => ['description' => 'The attribute name.', 'type' => 'string', 'example' => '20GB', 'title' => ''],
'Code' => ['description' => 'The attribute code.', 'type' => 'string', 'example' => 'rds_storage', 'title' => ''],
'Value' => ['description' => 'The attribute value.', 'type' => 'string', 'example' => '20', 'title' => ''],
'Unit' => ['description' => 'The unit of the value.', 'type' => 'string', 'example' => 'GB', 'title' => ''],
],
'description' => 'The module attribute object.',
'title' => '',
'example' => '',
],
'description' => 'The module attributes.',
'title' => '',
'example' => '',
],
'ModuleNameEn' => ['description' => 'The English name of the module.', 'type' => 'string', 'example' => '数据单元', 'title' => ''],
'PriceUnitEn' => ['description' => 'The English name of the price unit.', 'type' => 'string', 'example' => '元/月', 'title' => ''],
],
'description' => 'The module or instance object.',
'title' => '',
'example' => '',
],
'description' => 'The module or instance information.',
'title' => '',
'example' => '',
],
],
'description' => 'The sub-order object.',
'title' => '',
'example' => '',
],
'description' => 'The sub-orders.',
'title' => '',
'example' => '',
],
],
'description' => 'The sub-orders.',
'title' => '',
'example' => '',
],
'Coupons' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CanPromFee' => ['description' => 'The payable amount.', 'type' => 'number', 'format' => 'double', 'example' => '9.99', 'title' => ''],
'CouponDesc' => ['description' => 'The description of the coupon.', 'type' => 'string', 'example' => '10元优惠券(有效期至2024年9月8日)', 'title' => ''],
'CouponName' => ['description' => 'The name of the coupon.', 'type' => 'string', 'example' => '10元优惠券', 'title' => ''],
'CouponOptionNo' => ['description' => 'The coupon number.', 'type' => 'string', 'example' => '50008800000xxxx', 'title' => ''],
'Selected' => ['description' => 'Indicates whether the coupon is selected.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => 'The coupon.',
'title' => '',
'example' => '',
],
'description' => 'The coupons.',
'title' => '',
'example' => '',
],
],
'description' => 'The Result model.',
'title' => '',
'example' => '',
],
],
'description' => 'The information about the Alibaba Cloud Marketplace purchase order.',
'title' => '',
'example' => '',
],
'example' => '{\'cmgj00059839\': {\'Result\': {\'InquiryType\': \'Buy\', \'Order\': {\'Currency\': \'CNY\', \'DiscountAmount\': \'0.0\', \'TradeAmount\': \'0.01\', \'OriginalAmount\': \'0.01\'}}}}',
'title' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08ABBB67-39C9-5EE7-98E5-80486F75CE8D\\",\\n \\"Resources\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"EcsInstance\\\\\\" : {\\\\n \\\\\\"Type\\\\\\" : \\\\\\"ALIYUN::ECS::Instance\\\\\\",\\\\n \\\\\\"Success\\\\\\" : true,\\\\n \\\\\\"Result\\\\\\" : {\\\\n \\\\\\"Order\\\\\\" : {\\\\n \\\\\\"Currency\\\\\\" : \\\\\\"CNY\\\\\\",\\\\n \\\\\\"RuleIds\\\\\\" : [ \\\\\\"102111101338****\\\\\\" ],\\\\n \\\\\\"DetailInfos\\\\\\" : {\\\\n \\\\\\"ResourcePriceModel\\\\\\" : [ {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"bandwidth\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0\\\\n }, {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"image\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0\\\\n }, {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0.366666,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0.249012,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"instanceType\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0.117654\\\\n }, {\\\\n \\\\\\"OriginalPrice\\\\\\" : 0.055555,\\\\n \\\\\\"DiscountPrice\\\\\\" : 0.037729,\\\\n \\\\\\"SubRules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"Resource\\\\\\" : \\\\\\"systemDisk\\\\\\",\\\\n \\\\\\"TradePrice\\\\\\" : 0.017826\\\\n } ]\\\\n },\\\\n \\\\\\"TradeAmount\\\\\\" : 0.135,\\\\n \\\\\\"OriginalAmount\\\\\\" : 0.422,\\\\n \\\\\\"Coupons\\\\\\" : {\\\\n \\\\\\"Coupon\\\\\\" : [ ]\\\\n },\\\\n \\\\\\"DiscountAmount\\\\\\" : 0.287\\\\n },\\\\n \\\\\\"OrderSupplement\\\\\\" : {\\\\n \\\\\\"PriceUnit\\\\\\" : \\\\\\"/Hour\\\\\\",\\\\n \\\\\\"ChargeType\\\\\\" : \\\\\\"PostPaid\\\\\\",\\\\n \\\\\\"Quantity\\\\\\" : 1,\\\\n \\\\\\"PriceType\\\\\\" : \\\\\\"Total\\\\\\"\\\\n },\\\\n \\\\\\"Rules\\\\\\" : {\\\\n \\\\\\"Rule\\\\\\" : [ {\\\\n \\\\\\"RuleDescId\\\\\\" : \\\\\\"102111101338****\\\\\\",\\\\n \\\\\\"Name\\\\\\" : \\\\\\"合同优惠_多计费项优惠_3.208750折\\\\\\"\\\\n } ]\\\\n }\\\\n }\\\\n }\\\\n }\\"\\n },\\n \\"Commodity\\": {\\n \\"key\\": {\\n \\"Result\\": {\\n \\"Order\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"TradeAmount\\": \\"9.99\\",\\n \\"DiscountAmount\\": \\"1.99\\",\\n \\"OriginalAmount\\": \\"11.98\\"\\n },\\n \\"InquiryType\\": \\"Buy\\",\\n \\"SubOrders\\": {\\n \\"SubOrder\\": [\\n {\\n \\"ModuleInstance\\": [\\n {\\n \\"ModuleId\\": 1234,\\n \\"ModuleName\\": \\"数据库类型\\",\\n \\"ModuleCode\\": \\"rds_dbtype\\",\\n \\"TotalProductFee\\": 10,\\n \\"DiscountFee\\": 1.99,\\n \\"PayFee\\": 8.01,\\n \\"PriceUnit\\": \\"元/GB/小时\\",\\n \\"IsPricingModule\\": true,\\n \\"NeedOrderPay\\": true,\\n \\"PriceType\\": \\"hourPrice\\",\\n \\"ModuleAttrs\\": [\\n {\\n \\"Type\\": 3,\\n \\"Name\\": \\"20GB\\",\\n \\"Code\\": \\"rds_storage\\",\\n \\"Value\\": \\"20\\",\\n \\"Unit\\": \\"GB\\"\\n }\\n ],\\n \\"ModuleNameEn\\": \\"数据单元\\",\\n \\"PriceUnitEn\\": \\"元/月\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Coupons\\": [\\n {\\n \\"CanPromFee\\": 9.99,\\n \\"CouponDesc\\": \\"10元优惠券(有效期至2024年9月8日)\\",\\n \\"CouponName\\": \\"10元优惠券\\",\\n \\"CouponOptionNo\\": \\"50008800000xxxx\\",\\n \\"Selected\\": true\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]',
'title' => 'GetServiceEstimateCost',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceEstimateCost'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceEstimateCost',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#ServiceId}'],
],
],
],
],
'translator' => 'manual',
],
'GetServiceInstance' => [
'summary' => 'Queries the details of a service instance by its region ID, service instance ID, or Alibaba Cloud Marketplace instance ID. The returned information includes the service status, template name, and a list of resources.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36936',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The service instance ID.'."\n"
."\n"
.'> You must specify either `ServiceInstanceId` or `MarketInstanceId` to query the detailed information about the service instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'si-d6ab3a63ccbb4b17****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'MarketInstanceId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The Alibaba Cloud Marketplace instance ID.', 'type' => 'string', 'required' => false, 'example' => '704***59', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Outputs' => ['description' => 'The output fields returned when the service instance is created.'."\n"
."\n"
.'- In ROS mode, all output fields of the template are returned.'."\n"
."\n"
.'- In Service Provider Interface (SPI) mode, the output fields from the independent software vendor (ISV) and the additional features of Compute Nest are returned.', 'type' => 'string', 'example' => '{"InstanceIds":["i-hp38ofxl0dsyfi7z****"]}', 'title' => ''],
'Status' => ['description' => 'The deployment status of the service instance. Valid values:'."\n"
."\n"
.'- Created: The service instance is created.'."\n"
."\n"
.'- Deploying: The service instance is being deployed.'."\n"
."\n"
.'- DeployedFailed: The service instance failed to be deployed.'."\n"
."\n"
.'- Deployed: The service instance is deployed.'."\n"
."\n"
.'- Upgrading: The service instance is being upgraded.'."\n"
."\n"
.'- Deleting: The service instance is being deleted.'."\n"
."\n"
.'- Deleted: The service instance is deleted.'."\n"
."\n"
.'- DeletedFailed: The service instance failed to be deleted.', 'type' => 'string', 'example' => 'Deployed', 'title' => ''],
'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the service instance was updated.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z', 'title' => ''],
'Progress' => ['description' => 'The deployment progress of the service instance. Unit: %.', 'type' => 'integer', 'format' => 'int64', 'example' => '90', 'title' => ''],
'Parameters' => ['description' => 'The parameters that are entered for deploying the service instance.', 'type' => 'string', 'example' => '{"param":"value"}', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', 'title' => ''],
'ServiceInstanceId' => ['description' => 'The service instance ID.', 'type' => 'string', 'example' => 'si-d6ab3a63ccbb4b17****', 'title' => ''],
'CreateTime' => ['description' => 'The time when the service instance was created.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z', 'title' => ''],
'StatusDetail' => ['description' => 'The description of the deployment status of the instance.', 'type' => 'string', 'example' => 'deploy successfully', 'title' => ''],
'Resources' => ['description' => 'The list of resources.', 'type' => 'string', 'example' => '[{"StackId": "stack-xxx"}]', 'title' => ''],
'Service' => [
'description' => 'The details of the service.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The service status. Valid values:'."\n"
."\n"
.'- Draft: The service is pending registration submission.'."\n"
."\n"
.'- Submitted: The registration is submitted.'."\n"
."\n"
.'- Approved: The registration is approved.'."\n"
."\n"
.'- Online: The service is published.'."\n"
."\n"
.'- Offline: The service is unpublished.'."\n"
."\n"
.'- Deleted: The service is deleted.'."\n"
."\n"
.'- Launching: The service is being published.', 'type' => 'string', 'example' => 'Online', 'title' => ''],
'PublishTime' => ['description' => 'The time when the service was published.', 'type' => 'string', 'example' => '2021-05-21T00:00:00Z', 'title' => ''],
'Version' => ['description' => 'The service version.', 'type' => 'string', 'example' => '1', 'title' => ''],
'DeployMetadata' => ['description' => 'The information about the service deployment configuration. The information varies based on the deployment type. The data is stored in the JSON string format.', 'type' => 'string', 'example' => '{"EstimateTime":null,"SupplierDeployMetadata":{"DeployTimeout":null},"TemplateConfigs":[{"Name":" template1","Url":"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json","PredefinedParameters":[],"AllowedRegions":["cn-hangzhou"]}]}', 'title' => ''],
'DeployType' => ['description' => 'The deployment type. Valid values:'."\n"
."\n"
.'- ros: The service is deployed using ROS.'."\n"
."\n"
.'- terraform: The service is deployed using Terraform.'."\n"
."\n"
.'- ack: The service is deployed using ACK.'."\n"
."\n"
.'- spi: The service is deployed by calling SPI.'."\n"
."\n"
.'- operation: The service is deployed using Alibaba Cloud Managed Services.', 'type' => 'string', 'example' => 'ros', 'title' => ''],
'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'service-9c8a3522528b4fe8****', 'title' => ''],
'SupplierUrl' => ['description' => 'The URL of the service provider.', 'type' => 'string', 'example' => 'http://example.com', 'title' => ''],
'ServiceType' => ['description' => 'The service type. Valid values:'."\n"
."\n"
.'- private: The service is deployed in the user\'s account.'."\n"
."\n"
.'- managed: The service is hosted in the service provider\'s account.'."\n"
."\n"
.'- operation: The service is an Alibaba Cloud Managed Service.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'SupplierName' => ['description' => 'The name of the service provider.', 'type' => 'string', 'example' => 'Company A', 'title' => ''],
'ServiceInfos' => [
'description' => 'The service information.',
'type' => 'array',
'items' => [
'description' => 'The service information.',
'type' => 'object',
'properties' => [
'Locale' => ['description' => 'The language of the service instance.', 'type' => 'string', 'example' => 'zh-CN', 'title' => ''],
'Image' => ['description' => 'The URL of the service icon.', 'type' => 'string', 'example' => 'https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png', 'title' => ''],
'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'B数据库', 'title' => ''],
'ShortDescription' => ['description' => 'The summary of the service.', 'type' => 'string', 'example' => 'B is an open-source distributed relational database independently designed and developed by Company A.', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'VersionName' => ['description' => 'The custom version name defined by the service provider.', 'type' => 'string', 'example' => 'Version A', 'title' => ''],
'UpgradeMetadata' => ['description' => 'The upgrade metadata.', 'type' => 'string', 'example' => '{'."\n"
.' "Type": "OOS",'."\n"
.' "Description": "Changelog or something description",'."\n"
.' "SupportUpgradeFromVersions": [1, 2],'."\n"
.' "UpgradeSteps": {'."\n"
.' "PreUpgradeStage": {'."\n"
.' "Description": "Initialize database",'."\n"
.' "Type": "RunCommand",'."\n"
.' "ResourceName": "EcsRole1",'."\n"
.' "CommandType": "runShellScript",'."\n"
.' "CommandContent": "echo hello"'."\n"
.' },'."\n"
.' "UpgradeStage": [{'."\n"
.' "Description": "Update EcsRole1 instance",'."\n"
.' "Type": "RunCommand",'."\n"
.' "ResourceName": "EcsRole1",'."\n"
.' "ArtifactsDownloadDirectory": "/home/admin",'."\n"
.' "CommandType": "runShellScript",'."\n"
.' "CommandContent": "echo hello"'."\n"
.' }],'."\n"
.' "PostUpgradeStage": {'."\n"
.' "Description": "Post-deployment check",'."\n"
.' "Type": "None/RunCommand",'."\n"
.' "ResourceName": "EcsRole1",'."\n"
.' "CommandType": "runShellScript",'."\n"
.' "CommandContent": "echo hello"'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
'UpgradableServiceVersions' => [
'description' => 'The list of service versions to which the service can be upgraded.',
'type' => 'array',
'items' => ['description' => 'The service version to which the service can be upgraded.', 'type' => 'string', 'example' => '1', 'title' => ''],
'title' => '',
'example' => '',
],
'UpgradableServiceInfos' => [
'description' => 'The information about the service versions to which the service can be upgraded.',
'type' => 'array',
'items' => [
'description' => 'The information about the service versions to which the service can be upgraded.',
'type' => 'object',
'properties' => [
'Version' => ['description' => 'The service version.', 'type' => 'string', 'example' => 'draft', 'title' => ''],
'VersionName' => ['description' => 'The version name.', 'type' => 'string', 'example' => '20241112', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ServiceProductUrl' => ['description' => 'The URL of the product page.', 'type' => 'string', 'example' => 'https://service-info-private.oss-cn-hangzhou.aliyuncs.com', 'title' => ''],
'ServiceDocUrl' => ['description' => 'The URL of the product documentation.', 'type' => 'string', 'example' => 'http://example.com', 'title' => ''],
'OperationMetadata' => ['description' => 'The parameters related to O\\&M operations, including service upgrade and downgrade, Prometheus, and log configurations.', 'type' => 'string', 'example' => '{"SupportBackup":false,"PrometheusConfigMap":{},"ModifyParametersConfig":[{"TemplateName":"China edition","Operation":[{"Name":"Plan modification","Description":"Plan modification","Type":"Custom","SupportPredefinedParameters":true,"EnableLogging":false},{"Name":"Parameter modification","Description":"Parameter modification","Type":"Custom","SupportPredefinedParameters":false,"EnableLogging":false,"Parameters":["DataDiskSize"]}]}]}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'OperationStartTime' => ['description' => 'The start time of the managed O\\&M.', 'type' => 'string', 'example' => '2021-12-29T06:48:56Z', 'title' => ''],
'OperationEndTime' => ['description' => 'The end time of the managed O\\&M.', 'type' => 'string', 'example' => '2022-01-28T06:48:56Z', 'title' => ''],
'OperatedServiceInstanceId' => ['description' => 'The ID of the service instance that is managed.', 'type' => 'string', 'example' => 'si-d6ab3a63ccbb4b17****', 'title' => ''],
'EnableInstanceOps' => ['description' => 'Indicates whether the service instance supports managed O\\&M. Valid values:'."\n"
."\n"
.'- true: The service instance supports managed O\\&M.'."\n"
."\n"
.'- false: The service instance does not support managed O\\&M.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'IsOperated' => ['description' => 'Indicates whether managed O\\&M is enabled for the service instance. Valid values:'."\n"
."\n"
.'- true: Managed O\\&M is enabled for the service instance.'."\n"
."\n"
.'- false: Managed O\\&M is not enabled for the service instance.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'NetworkConfig' => [
'description' => 'The network configuration.'."\n"
."\n"
.'> This parameter is deprecated.',
'type' => 'object',
'properties' => [
'EndpointId' => ['description' => 'The endpoint ID of the PrivateLink connection.'."\n"
."\n"
.'> This parameter is deprecated.', 'type' => 'string', 'example' => 'ep-m5ei37240541816b****', 'title' => ''],
'PrivateZoneId' => ['description' => 'The ID of the PrivateZone for the custom private domain name.'."\n"
."\n"
.'> This parameter is deprecated.', 'type' => 'string', 'example' => 'cb7f214f80ac348d87daaeac1f35****', 'title' => ''],
'PrivateVpcConnections' => [
'description' => 'The information about the PrivateLink connection.',
'type' => 'array',
'items' => [
'description' => 'The information about the PrivateLink connection.',
'type' => 'object',
'properties' => [
'EndpointId' => ['description' => 'The endpoint ID of the PrivateLink connection.', 'type' => 'string', 'example' => 'ep-m5ei37240541816b****', 'title' => ''],
'PrivateZoneId' => ['description' => 'The ID of the PrivateZone for the custom private domain name.', 'type' => 'string', 'example' => 'cb7f214f80ac348d87daaeac1f35****', 'title' => ''],
'PrivateZoneName' => ['description' => 'The custom domain name.', 'type' => 'string', 'example' => 'test.computenest.aliyuncs.com', 'title' => ''],
'ConnectionConfigs' => [
'description' => 'The network configurations. This parameter is used for PrivateLink connections.',
'type' => 'array',
'items' => [
'description' => 'The network configurations. This parameter is used for PrivateLink connections.',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-bp1vwnn14rqpyiczj****', 'title' => ''],
'SecurityGroups' => [
'description' => 'The security group name.',
'type' => 'array',
'items' => ['description' => 'The security group name.', 'type' => 'string', 'example' => '\'sg-m5ec4mvoq9egn7xxxxxx', 'title' => ''],
'title' => '',
'example' => '',
],
'VSwitches' => [
'description' => 'The vSwitch name.',
'type' => 'array',
'items' => ['description' => 'The vSwitch name.', 'type' => 'string', 'example' => 'vsw-uf6iqwohr05dw4mxxxxxx', 'title' => ''],
'title' => '',
'example' => '',
],
'IngressEndpointStatus' => ['description' => 'The status of the Ingress endpoint. Valid values:'."\n"
."\n"
.'- Ready: The Ingress endpoint is connected.'."\n"
."\n"
.'- Pending: The Ingress endpoint is being connected.'."\n"
."\n"
.'- Failed: The Ingress endpoint failed to be connected.'."\n"
."\n"
.'- Deleted: The Ingress endpoint is deleted.'."\n"
."\n"
.'- Deleting: The Ingress endpoint is being deleted.', 'type' => 'string', 'example' => 'Ready', 'title' => ''],
'NetworkServiceStatus' => ['description' => 'The status of the network service. Valid values:'."\n"
."\n"
.'- Ready: The network service is connected.'."\n"
."\n"
.'- Pending: The network service is being connected.'."\n"
."\n"
.'- Failed: The network service failed to be connected.'."\n"
."\n"
.'- Deleted: The network service is deleted.'."\n"
."\n"
.'- Deleting: The network service is being deleted.', 'type' => 'string', 'example' => 'Ready', 'title' => ''],
'EndpointIps' => [
'description' => 'The IP address of the PrivateLink endpoint.',
'type' => 'array',
'items' => ['description' => 'The IP address of the PrivateLink endpoint.', 'type' => 'string', 'example' => '192.xxx.xxx.xxx', 'title' => ''],
'title' => '',
'example' => '',
],
'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com', 'title' => ''],
'RegionId' => ['description' => 'The region where the VPC of the endpoint is located when a private connection is established in Compute Nest intranet-connected mode.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'ConnectBandwidth' => ['description' => 'The bandwidth limit for the connection that is established in Compute Nest intranet-connected mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '1536Mbps', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The region ID of the endpoint for the PrivateLink connection.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ReversePrivateVpcConnections' => [
'description' => 'The information about the reverse PrivateLink connection.',
'type' => 'array',
'items' => [
'description' => 'The information about the reverse PrivateLink connection.',
'type' => 'object',
'properties' => [
'EndpointId' => ['description' => 'The endpoint ID of the reverse PrivateLink connection.', 'type' => 'string', 'example' => 'ep-m5ei42370541816b****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Tags' => [
'description' => 'The custom tags.',
'type' => 'array',
'items' => [
'description' => 'The custom tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'LicenseEndTime' => ['description' => 'The time when the license expires.', 'type' => 'string', 'example' => '2022-01-01T12:00:00', 'title' => ''],
'UserId' => ['description' => 'The user\'s Alibaba Cloud account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '130920852836****', 'title' => ''],
'SupplierUid' => ['description' => 'The Alibaba Cloud account ID of the service provider.', 'type' => 'integer', 'format' => 'int64', 'example' => '158927391332*****', 'title' => ''],
'EndTime' => ['description' => 'The time when the service instance expires.', 'type' => 'string', 'example' => '2022-01-01T12:00:00', 'title' => ''],
'Source' => ['description' => 'The source of the service instance. Valid values:'."\n"
."\n"
.'- User: a Compute Nest user.'."\n"
."\n"
.'- Market: Alibaba Cloud Marketplace.'."\n"
."\n"
.'- Supplier: a Compute Nest service provider.', 'type' => 'string', 'example' => 'User', 'title' => ''],
'ServiceType' => ['description' => 'The service type. Valid values:'."\n"
."\n"
.'- private: a service instance that is deployed in the user\'s account.'."\n"
."\n"
.'- managed: a service instance that is hosted in the service provider\'s account.'."\n"
."\n"
.'- operation: a managed service instance.'."\n"
."\n"
.'- poc: a trial service instance.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'PayType' => ['description' => 'The billing method. Valid values:'."\n"
."\n"
.'- Permanent: permanent.'."\n"
."\n"
.'- Subscription: subscription.'."\n"
."\n"
.'- PayAsYouGo: pay-as-you-go.'."\n"
."\n"
.'- CustomFixTime: a custom fixed duration.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''],
'Name' => ['description' => 'The name of the service instance.', 'type' => 'string', 'example' => 'Database B', 'title' => ''],
'EnableUserPrometheus' => ['description' => 'Indicates whether Prometheus monitoring is enabled. Valid values:'."\n"
."\n"
.'- true: enabled.'."\n"
."\n"
.'- false: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Components' => ['description' => 'The extra billing items of Alibaba Cloud Marketplace.', 'type' => 'string', 'example' => '{"TiKVServerCount":"3","package_version":"yuncode5398300001","PDServerCount":"3","TiDBServerCount":"2"}', 'title' => ''],
'PredefinedParameterName' => ['description' => 'The name of the package.', 'type' => 'string', 'example' => 'Package 1', 'title' => ''],
'MarketInstanceId' => ['description' => 'The Alibaba Cloud Marketplace instance ID.', 'type' => 'string', 'example' => '704***59', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''],
'BizStatus' => ['description' => 'The business status of the service instance. Valid values:'."\n"
."\n"
.'- Normal: The service instance is normal.'."\n"
."\n"
.'- Renewing: The service instance is being renewed.'."\n"
."\n"
.'- RenewFoiled: The renewal failed.'."\n"
."\n"
.'- Expired: The service instance has expired.', 'type' => 'string', 'example' => 'Normal', 'title' => ''],
'GrafanaDashBoardUrl' => ['description' => 'The URL of the Grafana dashboard.', 'type' => 'string', 'example' => 'https://g.console.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s', 'title' => ''],
'SupportTrialToPrivate' => ['description' => 'Indicates whether the trial service can be converted to a paid service.', 'type' => 'boolean', 'title' => '', 'example' => ''],
'PolicyNames' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GrantedPermission' => [
'type' => 'object',
'properties' => [
'OperationEndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'PolicyNames' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Outputs\\": \\"{\\\\\\"InstanceIds\\\\\\":[\\\\\\"i-hp38ofxl0dsyfi7z****\\\\\\"]}\\",\\n \\"Status\\": \\"Deployed\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"Progress\\": 90,\\n \\"Parameters\\": \\"{\\\\\\"param\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"StatusDetail\\": \\"deploy successfully\\",\\n \\"Resources\\": \\"[{\\\\\\"StackId\\\\\\": \\\\\\"stack-xxx\\\\\\"}]\\",\\n \\"Service\\": {\\n \\"Status\\": \\"Online\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Version\\": \\"1\\",\\n \\"DeployMetadata\\": \\"{\\\\\\"EstimateTime\\\\\\":null,\\\\\\"SupplierDeployMetadata\\\\\\":{\\\\\\"DeployTimeout\\\\\\":null},\\\\\\"TemplateConfigs\\\\\\":[{\\\\\\"Name\\\\\\":\\\\\\" template1\\\\\\",\\\\\\"Url\\\\\\":\\\\\\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\\\\\\",\\\\\\"PredefinedParameters\\\\\\":[],\\\\\\"AllowedRegions\\\\\\":[\\\\\\"cn-hangzhou\\\\\\"]}]}\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-9c8a3522528b4fe8****\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"SupplierName\\": \\"Company 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 is an open-source distributed relational database independently designed and developed by Company A.\\"\\n }\\n ],\\n \\"VersionName\\": \\"Version A\\",\\n \\"UpgradeMetadata\\": \\"{\\\\n \\\\\\"Type\\\\\\": \\\\\\"OOS\\\\\\",\\\\n \\\\\\"Description\\\\\\": \\\\\\"Changelog or something description\\\\\\",\\\\n \\\\\\"SupportUpgradeFromVersions\\\\\\": [1, 2],\\\\n \\\\\\"UpgradeSteps\\\\\\": {\\\\n \\\\\\"PreUpgradeStage\\\\\\": {\\\\n \\\\\\"Description\\\\\\": \\\\\\"Initialize database\\\\\\",\\\\n \\\\\\"Type\\\\\\": \\\\\\"RunCommand\\\\\\",\\\\n \\\\\\"ResourceName\\\\\\": \\\\\\"EcsRole1\\\\\\",\\\\n \\\\\\"CommandType\\\\\\": \\\\\\"runShellScript\\\\\\",\\\\n \\\\\\"CommandContent\\\\\\": \\\\\\"echo hello\\\\\\"\\\\n },\\\\n \\\\\\"UpgradeStage\\\\\\": [{\\\\n \\\\\\"Description\\\\\\": \\\\\\"Update EcsRole1 instance\\\\\\",\\\\n \\\\\\"Type\\\\\\": \\\\\\"RunCommand\\\\\\",\\\\n \\\\\\"ResourceName\\\\\\": \\\\\\"EcsRole1\\\\\\",\\\\n \\\\\\"ArtifactsDownloadDirectory\\\\\\": \\\\\\"/home/admin\\\\\\",\\\\n \\\\\\"CommandType\\\\\\": \\\\\\"runShellScript\\\\\\",\\\\n \\\\\\"CommandContent\\\\\\": \\\\\\"echo hello\\\\\\"\\\\n }],\\\\n \\\\\\"PostUpgradeStage\\\\\\": {\\\\n \\\\\\"Description\\\\\\": \\\\\\"Post-deployment check\\\\\\",\\\\n \\\\\\"Type\\\\\\": \\\\\\"None/RunCommand\\\\\\",\\\\n \\\\\\"ResourceName\\\\\\": \\\\\\"EcsRole1\\\\\\",\\\\n \\\\\\"CommandType\\\\\\": \\\\\\"runShellScript\\\\\\",\\\\n \\\\\\"CommandContent\\\\\\": \\\\\\"echo hello\\\\\\"\\\\n }\\\\n }\\\\n}\\",\\n \\"UpgradableServiceVersions\\": [\\n \\"1\\"\\n ],\\n \\"UpgradableServiceInfos\\": [\\n {\\n \\"Version\\": \\"draft\\",\\n \\"VersionName\\": \\"20241112\\"\\n }\\n ],\\n \\"ServiceProductUrl\\": \\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"ServiceDocUrl\\": \\"http://example.com\\",\\n \\"OperationMetadata\\": \\"{\\\\\\"SupportBackup\\\\\\":false,\\\\\\"PrometheusConfigMap\\\\\\":{},\\\\\\"ModifyParametersConfig\\\\\\":[{\\\\\\"TemplateName\\\\\\":\\\\\\"China edition\\\\\\",\\\\\\"Operation\\\\\\":[{\\\\\\"Name\\\\\\":\\\\\\"Plan modification\\\\\\",\\\\\\"Description\\\\\\":\\\\\\"Plan modification\\\\\\",\\\\\\"Type\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"SupportPredefinedParameters\\\\\\":true,\\\\\\"EnableLogging\\\\\\":false},{\\\\\\"Name\\\\\\":\\\\\\"Parameter modification\\\\\\",\\\\\\"Description\\\\\\":\\\\\\"Parameter modification\\\\\\",\\\\\\"Type\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"SupportPredefinedParameters\\\\\\":false,\\\\\\"EnableLogging\\\\\\":false,\\\\\\"Parameters\\\\\\":[\\\\\\"DataDiskSize\\\\\\"]}]}]}\\"\\n },\\n \\"OperationStartTime\\": \\"2021-12-29T06:48:56Z\\",\\n \\"OperationEndTime\\": \\"2022-01-28T06:48:56Z\\",\\n \\"OperatedServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"EnableInstanceOps\\": true,\\n \\"IsOperated\\": true,\\n \\"NetworkConfig\\": {\\n \\"EndpointId\\": \\"ep-m5ei37240541816b****\\",\\n \\"PrivateZoneId\\": \\"cb7f214f80ac348d87daaeac1f35****\\",\\n \\"PrivateVpcConnections\\": [\\n {\\n \\"EndpointId\\": \\"ep-m5ei37240541816b****\\",\\n \\"PrivateZoneId\\": \\"cb7f214f80ac348d87daaeac1f35****\\",\\n \\"PrivateZoneName\\": \\"test.computenest.aliyuncs.com\\",\\n \\"ConnectionConfigs\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1vwnn14rqpyiczj****\\",\\n \\"SecurityGroups\\": [\\n \\"\'sg-m5ec4mvoq9egn7xxxxxx\\"\\n ],\\n \\"VSwitches\\": [\\n \\"vsw-uf6iqwohr05dw4mxxxxxx\\"\\n ],\\n \\"IngressEndpointStatus\\": \\"Ready\\",\\n \\"NetworkServiceStatus\\": \\"Ready\\",\\n \\"EndpointIps\\": [\\n \\"192.xxx.xxx.xxx\\"\\n ],\\n \\"DomainName\\": \\"ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ConnectBandwidth\\": 0\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ReversePrivateVpcConnections\\": [\\n {\\n \\"EndpointId\\": \\"ep-m5ei42370541816b****\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"LicenseEndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"UserId\\": 0,\\n \\"SupplierUid\\": 0,\\n \\"EndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"Source\\": \\"User\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"Name\\": \\"Database B\\",\\n \\"EnableUserPrometheus\\": true,\\n \\"Components\\": \\"{\\\\\\"TiKVServerCount\\\\\\":\\\\\\"3\\\\\\",\\\\\\"package_version\\\\\\":\\\\\\"yuncode5398300001\\\\\\",\\\\\\"PDServerCount\\\\\\":\\\\\\"3\\\\\\",\\\\\\"TiDBServerCount\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"PredefinedParameterName\\": \\"Package 1\\",\\n \\"MarketInstanceId\\": \\"704***59\\",\\n \\"ResourceGroupId\\": \\"rg-bp67acfmxazb4p****\\",\\n \\"BizStatus\\": \\"Normal\\",\\n \\"GrafanaDashBoardUrl\\": \\"https://g.console.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s\\",\\n \\"SupportTrialToPrivate\\": false,\\n \\"PolicyNames\\": \\"\\",\\n \\"GrantedPermission\\": {\\n \\"OperationEndTime\\": \\"\\",\\n \\"PolicyNames\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => 'GetServiceInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
],
'translator' => 'manual',
],
'GetServiceInstanceSubscriptionEstimateCost' => [
'summary' => 'Queries the estimated renewal cost of subscription resources in a privately deployed service instance. You can query the cost for all resources associated with a service instance ID, or for a specific set of resources.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136636',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-d6ab3a63ccbb4b17****'],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => ['description' => 'The order type. Valid value: Renewal.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Renewal'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => ['description' => 'The unit of the renewal duration for all subscription resources of the service instance. This is the unit for the Period parameter. Valid values: Month and Year. Default value: Month.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Month'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The token must be unique for each request. It can contain only ASCII characters and cannot be longer than 64 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => 'The renewal duration for all subscription resources of the service instance. The unit is specified by PeriodUnit.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'],
],
[
'name' => 'ResourcePeriod',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The renewal configuration for the resources.',
'type' => 'array',
'items' => [
'description' => 'The renewal configuration for the resources.',
'type' => 'object',
'properties' => [
'ResourceArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'acs:ecs:cn-guangzhou:1361753504587228:instance/i-7xv9pgeqvhxg10jji3vd'],
'PeriodUnit' => ['description' => 'The unit of the renewal duration for the resource. This is the unit for the Period parameter. Valid values: Month and Year. Default value: Month.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Month'],
'Period' => ['description' => 'The renewal duration. The unit is specified by PeriodUnit.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 1000,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response data',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21'],
'ResourcePrices' => [
'description' => 'The list of resource price information.',
'type' => 'array',
'items' => [
'description' => 'The resource price information.',
'type' => 'object',
'properties' => [
'ResourceArn' => ['description' => 'The ARN of the resource.', 'type' => 'string', 'title' => '', 'example' => 'acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2'],
'PeriodUnit' => ['description' => 'The unit of the renewal duration. This is the unit for the Period parameter. Valid values: Month and Year. Default value: Month.', 'type' => 'string', 'title' => '', 'example' => 'Month'],
'Period' => ['description' => 'The renewal duration. The unit is specified by PeriodUnit.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'OriginalAmount' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '900'],
'TradeAmount' => ['description' => 'The discounted price.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '500'],
'DiscountAmount' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '100'],
'Currency' => ['description' => 'The currency. Valid values:'."\n"
."\n"
.'- CNY: Chinese Yuan.'."\n"
."\n"
.'- USD: US Dollar.'."\n"
."\n"
.'- JPY: Japanese Yen.', 'type' => 'string', 'title' => '', 'example' => 'CNY'],
'DetailInfos' => [
'description' => 'The price details of the pricing module.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OriginalAmount' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '900'],
'TradeAmount' => ['description' => 'The discounted price.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '500'],
'DiscountAmount' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '100'],
'Resource' => ['description' => 'The identifier of the pricing module.', 'type' => 'string', 'title' => '', 'example' => 'instance'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Rules' => [
'description' => 'The discount details.',
'type' => 'array',
'items' => [
'description' => 'The discount details.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the discount.', 'type' => 'string', 'title' => '', 'example' => 'test'],
'RuleDescId' => ['description' => 'The discount ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1021199213'],
'Description' => ['description' => 'The description of the discount.', 'type' => 'string', 'title' => '', 'example' => 'test'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\",\\n \\"ResourcePrices\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"Period\\": 1,\\n \\"OriginalAmount\\": 900,\\n \\"TradeAmount\\": 500,\\n \\"DiscountAmount\\": 100,\\n \\"Currency\\": \\"CNY\\",\\n \\"DetailInfos\\": [\\n {\\n \\"OriginalAmount\\": 900,\\n \\"TradeAmount\\": 500,\\n \\"DiscountAmount\\": 100,\\n \\"Resource\\": \\"instance\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"RuleDescId\\": 1021199213,\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'GetServiceInstanceSubscriptionEstimateCost',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceInstanceSubscriptionEstimateCost'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:GetServiceInstanceSubscriptionEstimateCost',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
],
],
'GetServiceProvisions' => [
'summary' => 'Retrieves the provisions of a service, such as its activation status and service roles.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcomputenest2G0818', 'FEATUREcomputenest1Z49ZW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'service-0efc0db451794bxxxxxx'],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Template 1'],
],
[
'name' => 'TrialType',
'in' => 'query',
'schema' => ['description' => 'The usage type. Valid values:'."\n"
."\n"
.'- Trial: The service supports trial use.'."\n"
."\n"
.'- NotTrial: The service does not support trial use.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Trial'],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The parameters for deploying the user instance.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{\\"RegionId\\":\\"cn-hangzhou\\",\\"ZoneId\\":\\"cn-hangzhou-g\\",\\"EcsInstanceType\\":\\"ecs.g5.large\\",\\"InstancePassword\\":\\"xxxxxxxx\\",\\"PayType\\":\\"PostPaid\\",\\"PayPeriodUnit\\":\\"Month\\",\\"PayPeriod\\":1}'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8C27145F-C9F4-545D-A355-DCDDAD63D548'],
'ServiceProvisions' => [
'description' => 'The service details.',
'type' => 'array',
'items' => [
'description' => 'The service details.',
'type' => 'object',
'properties' => [
'ServiceName' => ['description' => 'The service name.', 'type' => 'string', 'title' => '', 'example' => 'CS'],
'Status' => ['description' => 'The activation status of the service. Valid values:'."\n"
."\n"
.'- Enabled: The service is activated.'."\n"
."\n"
.'- EnabledByDefault: The service is activated by default.'."\n"
."\n"
.'- Disabled: The service is not activated.'."\n"
."\n"
.'- Unknown: The activation status is unknown.', 'type' => 'string', 'title' => '', 'example' => 'Enabled'],
'AutoEnableService' => ['description' => 'Indicates whether the service is automatically activated as defined in the template. Valid values:'."\n"
."\n"
.'- true: The service is automatically activated.'."\n"
."\n"
.'- false: The service is manually activated.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
'RoleProvision' => [
'description' => 'The information about the service role. If this parameter is empty, no service role is associated with the service.',
'type' => 'object',
'properties' => [
'Roles' => [
'description' => 'The list of service roles.',
'type' => 'array',
'items' => [
'description' => 'The list of service roles.',
'type' => 'object',
'properties' => [
'RoleName' => ['description' => 'The role name.', 'type' => 'string', 'title' => '', 'example' => 'AliyunCSManagedVKRole'],
'Created' => ['description' => 'Indicates whether the role is created. Valid values:'."\n"
."\n"
.'- true: The role is created.'."\n"
."\n"
.'- false: The role is not created.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
'Function' => ['description' => 'The purpose of the role.'."\n"
.'Default value: Default. This value indicates that the role is the default role for the service.', 'type' => 'string', 'title' => '', 'example' => 'Default'],
'ApiForCreation' => [
'description' => 'The information about the API operation used to create the role.',
'type' => 'object',
'properties' => [
'ApiName' => ['description' => 'The API operation name.', 'type' => 'string', 'title' => '', 'example' => 'CreateServiceLinkedRole'],
'ApiProductId' => ['description' => 'The ID of the product to which the API operation belongs.', 'type' => 'string', 'title' => '', 'example' => 'rds'],
'ApiType' => ['description' => 'The API type.'."\n"
.'Valid values:'."\n"
."\n"
.'- Open: public API.'."\n"
."\n"
.'- Inner: internal API.', 'type' => 'string', 'title' => '', 'example' => 'Open'],
'parameters' => ['description' => 'The API parameters. ${variable} indicates a dynamic parameter.', 'type' => 'object', 'title' => '', 'example' => '{ "ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs", "RegionId": "${RegionId}" }'],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'AuthorizationURL' => ['description' => 'The authorization URL for accessing the cloud resources of the service.'."\n"
.'This URL is returned if the role is not created.', 'type' => 'string', 'title' => '', '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/"}'],
],
'title' => '',
'example' => '',
],
'StatusReason' => ['description' => 'The reason why the Alibaba Cloud service is not activated or the activation status is unknown.'."\n"
."\n"
.'> This parameter is returned when Status is set to Disabled or Unknown.', 'type' => 'string', 'title' => '', 'example' => 'No permission'],
'EnableURL' => ['description' => 'The URL for activating the Alibaba Cloud service.'."\n"
."\n"
.'> This parameter is returned when Status is set to Disabled.', 'type' => 'string', 'title' => '', 'example' => 'https://common-buy.aliyun.com/?commodityCode=sls'],
'CommodityProvisions' => [
'description' => 'The commodity details. Some services, such as ACS, require the activation of multiple commodities.',
'type' => 'array',
'items' => [
'description' => 'The commodity details. Some services, such as ACS, require the activation of multiple commodities.',
'type' => 'object',
'properties' => [
'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'title' => '', 'example' => 'acs_postpaid_public_cn'],
'Status' => ['description' => 'The activation status of the Alibaba Cloud service. Valid values:'."\n"
."\n"
.'- Enabled: The service is activated.'."\n"
."\n"
.'- Disabled: The service is not activated.', 'type' => 'string', 'title' => '', 'example' => 'Disabled'],
'EnableURL' => ['description' => 'The URL for activating the commodity.', 'type' => 'string', 'title' => '', 'example' => 'https://common-buy.aliyun.com/?commodityCode=acs_postpaid_public_cn'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27145F-C9F4-545D-A355-DCDDAD63D548\\",\\n \\"ServiceProvisions\\": [\\n {\\n \\"ServiceName\\": \\"CS\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"AutoEnableService\\": true,\\n \\"RoleProvision\\": {\\n \\"Roles\\": [\\n {\\n \\"RoleName\\": \\"AliyunCSManagedVKRole\\",\\n \\"Created\\": true,\\n \\"Function\\": \\"Default\\",\\n \\"ApiForCreation\\": {\\n \\"ApiName\\": \\"CreateServiceLinkedRole\\",\\n \\"ApiProductId\\": \\"rds\\",\\n \\"ApiType\\": \\"Open\\",\\n \\"parameters\\": {\\n \\"ServiceLinkedRole\\": \\"AliyunServiceRoleForRdsPgsqlOnEcs\\",\\n \\"RegionId\\": \\"${RegionId}\\"\\n }\\n }\\n }\\n ],\\n \\"AuthorizationURL\\": \\"https://ram.console.aliyun.com/role/authorization?request={\\\\\\"Services\\\\\\":[{\\\\\\"Service\\\\\\":\\\\\\"CS\\\\\\",\\\\\\"Roles\\\\\\":[{\\\\\\"RoleName\\\\\\":\\\\\\"AliyunCSManagedVKRole\\\\\\",\\\\\\"TemplateId\\\\\\":\\\\\\"AliyunCSManagedVKRole\\\\\\"},{\\\\\\"RoleName\\\\\\":\\\\\\"AliyunCSDefaultRole\\\\\\",\\\\\\"TemplateId\\\\\\":\\\\\\"Default\\\\\\"}]}],\\\\\\"ReturnUrl\\\\\\":\\\\\\"https://cs.console.aliyun.com/\\\\\\"}\\"\\n },\\n \\"StatusReason\\": \\"No permission\\",\\n \\"EnableURL\\": \\"https://common-buy.aliyun.com/?commodityCode=sls\\",\\n \\"CommodityProvisions\\": [\\n {\\n \\"CommodityCode\\": \\"acs_postpaid_public_cn\\",\\n \\"Status\\": \\"Disabled\\",\\n \\"EnableURL\\": \\"https://common-buy.aliyun.com/?commodityCode=acs_postpaid_public_cn\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'GetServiceProvisions',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceProvisions'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceProvisions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
],
],
],
],
'translator' => 'manual',
],
'GetServiceTemplateParameterConstraints' => [
'summary' => 'Queries the parameter constraints for a Resource Orchestration Service (ROS) template in a specified region using the template name and service ID.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136289',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9', 'FEATUREcomputenestVUFVAC'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'service-731f788406024axxxxxx', 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'required' => true, 'title' => ''],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The configuration parameters of the service instance.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ParameterKey' => ['description' => 'The name of the parameter. If you do not specify the name and value of the parameter, Resource Orchestration Service (ROS) uses the default value that is specified in the template.'."\n"
."\n"
.'> The Parameters parameter is optional. If you specify Parameters, ParameterKey is required.', 'type' => 'string', 'required' => false, 'example' => 'InstanceType', 'title' => ''],
'ParameterValue' => ['description' => 'The value of the parameter that is defined in the template.'."\n"
."\n"
.'> The Parameters parameter is optional. If you specify Parameters, ParameterValue is required.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. Generate a unique value from your client for each request. The token can contain only ASCII characters and cannot be more than 64 characters long.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'DeployRegionId',
'in' => 'query',
'schema' => ['description' => 'The deployment region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'TrialType',
'in' => 'query',
'schema' => ['description' => 'The usage type. Valid values:'."\n"
."\n"
.'- Trial: The service supports a trial.'."\n"
."\n"
.'- NotTrial: The service does not support a trial.', 'type' => 'string', 'required' => false, 'example' => 'NotTrial', 'title' => ''],
],
[
'name' => 'SpecificationName',
'in' => 'query',
'schema' => ['description' => 'The specification name.', 'type' => 'string', 'example' => 'Package 1', 'required' => false, 'title' => ''],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => false, 'example' => 'si-461ee95f46ca46xxxxxx', 'title' => ''],
],
[
'name' => 'EnablePrivateVpcConnection',
'in' => 'query',
'schema' => ['description' => 'Indicates whether PrivateLink is enabled. Valid values:'."\n"
."\n"
.'- true: enabled'."\n"
."\n"
.'- false: disabled', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C', 'title' => ''],
'ParameterConstraints' => [
'description' => 'The parameter constraints.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type of the parameter.', 'type' => 'string', 'example' => 'String', 'title' => ''],
'AllowedValues' => [
'description' => 'The valid values of the parameter.',
'type' => 'array',
'items' => ['description' => 'A valid value of the parameter.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''],
'title' => '',
'example' => '',
],
'AssociationParameterNames' => [
'description' => 'The associated parameters.',
'type' => 'array',
'items' => ['description' => 'An associated parameter.', 'type' => 'string', 'example' => 'InstanceType', 'title' => ''],
'title' => '',
'example' => '',
],
'ParameterKey' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'ZoneInfo', 'title' => ''],
'Behavior' => ['description' => 'The behavior of the parameter. Valid values:'."\n"
."\n"
.'- NoLimit: No limits are imposed on the value of this parameter.'."\n"
."\n"
.'- NotSupport: The values of this parameter cannot be queried.'."\n"
."\n"
.'- QueryError: The query failed.'."\n"
."\n"
.'> If AllowedValues is not returned, Behavior and BehaviorReason are returned to describe the behavior of the parameter and the reason.', 'type' => 'string', 'example' => 'NoLimit', 'title' => ''],
'BehaviorReason' => ['description' => 'The reason for the parameter behavior.', 'type' => 'string', 'example' => 'No resource property refer to the parameter', 'title' => ''],
'OriginalConstraints' => [
'description' => 'The original constraints.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AllowedValues' => [
'description' => 'The valid values of the parameter.',
'type' => 'array',
'items' => ['description' => 'A valid value of the parameter.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
'title' => '',
'example' => '',
],
'PropertyName' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'ZoneId', 'title' => ''],
'ResourceName' => ['description' => 'The name of the resource that is defined in the template.', 'type' => 'string', 'example' => 'MyECS', 'title' => ''],
'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ALIYUN::ECS::InstanceGroup', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'QueryErrors' => [
'description' => 'The details of the query failure.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => 'The error details.', 'type' => 'string', 'example' => 'record not exist', 'title' => ''],
'ResourceName' => ['description' => 'The resource name.', 'type' => 'string', 'example' => 'MyECS', 'title' => ''],
'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ALIYUN::ECS::InstanceGroup', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'FamilyConstraints' => [
'description' => 'The constraints on the specification family.',
'type' => 'array',
'items' => ['description' => 'A constraint on the specification family.', 'type' => 'string', 'example' => '约束族1', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C\\",\\n \\"ParameterConstraints\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"AllowedValues\\": [\\n \\"cn-hangzhou-h\\"\\n ],\\n \\"AssociationParameterNames\\": [\\n \\"InstanceType\\"\\n ],\\n \\"ParameterKey\\": \\"ZoneInfo\\",\\n \\"Behavior\\": \\"NoLimit\\",\\n \\"BehaviorReason\\": \\"No resource property refer to the parameter\\",\\n \\"OriginalConstraints\\": [\\n {\\n \\"AllowedValues\\": [\\n \\"cn-hangzhou-a\\"\\n ],\\n \\"PropertyName\\": \\"ZoneId\\",\\n \\"ResourceName\\": \\"MyECS\\",\\n \\"ResourceType\\": \\"ALIYUN::ECS::InstanceGroup\\"\\n }\\n ],\\n \\"QueryErrors\\": [\\n {\\n \\"ErrorMessage\\": \\"record not exist\\",\\n \\"ResourceName\\": \\"MyECS\\",\\n \\"ResourceType\\": \\"ALIYUN::ECS::InstanceGroup\\"\\n }\\n ]\\n }\\n ],\\n \\"FamilyConstraints\\": [\\n \\"约束族1\\"\\n ]\\n}","type":"json"}]',
'title' => 'GetServiceTemplateParameterConstraints',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceTemplateParameterConstraints'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceTemplateParameterConstraints',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
],
],
],
],
'translator' => 'machine',
],
'GetSkill' => [
'summary' => 'Queries the details of a Skill.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SkillId',
'in' => 'query',
'schema' => ['description' => 'The unique ID of the Skill.', 'type' => 'string', 'required' => true, 'example' => 's-06e9dca2-0ac9-4d2e-a965-e9db9c057e00', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
'SkillId' => ['title' => '', 'description' => 'Skill ID', 'type' => 'string', 'example' => 's-xxxxx'],
'SkillName' => ['title' => '', 'description' => 'The Skill name.', 'type' => 'string', 'example' => 'skill-creator'],
'SkillDisplayName' => ['title' => '', 'description' => 'The Skill display name.', 'type' => 'string', 'example' => ''],
'SkillDescription' => ['title' => '', 'description' => 'The Skill description.', 'type' => 'string', 'example' => 'Create new skills, modify and improve existing skills, and measure skill performance.'],
'Locales' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OriginalValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ZhValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EnValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'SkillLabels' => [
'description' => 'The Skill labels.',
'type' => 'array',
'items' => ['description' => 'The Skill label.', 'type' => 'string', 'example' => 'category:frontend-development', 'title' => ''],
'title' => '',
'example' => '',
],
'SkillSpaceId' => ['title' => '', 'description' => 'The ID of the SkillSpace to which the Skill belongs.', 'type' => 'string', 'example' => 'ss-xxxxx'],
'CreateTime' => ['description' => 'The time when the Skill was created.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z', 'title' => ''],
'UpdateTime' => ['title' => '', 'description' => 'The time when the Skill was last updated.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z'],
],
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidSkill.NotFound', 'errorMessage' => 'The specified Skill does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => 'View skill details',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the specification change feature and configured the specification change parameters when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"SkillId\\": \\"s-xxxxx\\",\\n \\"SkillName\\": \\"skill-creator\\",\\n \\"SkillDisplayName\\": \\"\\",\\n \\"SkillDescription\\": \\"Create new skills, modify and improve existing skills, and measure skill performance.\\",\\n \\"Locales\\": [\\n {\\n \\"OriginalValue\\": \\"\\",\\n \\"ZhValue\\": \\"\\",\\n \\"EnValue\\": \\"\\"\\n }\\n ],\\n \\"SkillLabels\\": [\\n \\"category:frontend-development\\"\\n ],\\n \\"SkillSpaceId\\": \\"ss-xxxxx\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\"\\n}","type":"json"}]',
],
'GetSkillFileDetectResult' => [
'summary' => 'Retrieves the result of a Skill file detection task.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'HashKey',
'in' => 'query',
'schema' => ['description' => 'The unique identifier for the detection task.', 'type' => 'string', 'required' => true, 'example' => '2aceb074-fa72-44d2-99d9-45b17cffe0e7', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3F976EF8-C10A-57DC-917C-BB7BEB508FFB'],
'HashKey' => ['description' => 'The unique identifier for the detection task.', 'type' => 'string', 'title' => '', 'example' => '8cfb1102cc5f56fe752f6e9b8c6f7f3d'],
'Result' => ['description' => 'The file detection result. Valid values:'."\n"
."\n"
.'0: safe file'."\n"
."\n"
.'1: suspicious file'."\n"
."\n"
.'3: The detection is in progress.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
'Score' => ['description' => 'The file detection score. The score ranges correspond to the following threat levels:'."\n"
."\n"
.'0–60: safe'."\n"
."\n"
.'61–70: risk'."\n"
."\n"
.'71–80: suspicious'."\n"
."\n"
.'81–100: malicious', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'],
'Code' => ['description' => 'The result code. A value of "200" indicates success. Other values indicate an error.', 'type' => 'string', 'title' => '', 'example' => '200'],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'Successful'],
],
'title' => '',
'description' => 'Response schema',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'GetSkillFileDetectResult',
'description' => '### Prerequisites'."\n"
."\n"
.'This operation is available only if the service provider enabled the modification feature and configured the relevant parameters during service creation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F976EF8-C10A-57DC-917C-BB7BEB508FFB\\",\\n \\"HashKey\\": \\"8cfb1102cc5f56fe752f6e9b8c6f7f3d\\",\\n \\"Result\\": 0,\\n \\"Score\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\"\\n}","type":"json"}]',
],
'GetSkillHubConfig' => [
'summary' => 'Retrieves the SkillHub configuration.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '2849EE73-AFFA-5AFD-9575-12FA886451DA'],
'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'mybucket'],
'OssRegionId' => ['description' => 'The region where the OSS bucket is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-zhangjiakou'],
'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'title' => '', 'example' => '2021-05-20T00:00:00Z'],
'UpdateTime' => ['description' => 'The time when the configuration was last updated.', 'type' => 'string', 'title' => '', 'example' => '2021-05-20T00:00:00Z'],
],
'title' => '',
'description' => 'The response data.',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidSkillHubConfig.NotFound', 'errorMessage' => 'The specified SkillHubConfig does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'GetSkillHubConfig',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure the service provider enabled the modification feature and configured its parameters when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2849EE73-AFFA-5AFD-9575-12FA886451DA\\",\\n \\"OssBucketName\\": \\"mybucket\\",\\n \\"OssRegionId\\": \\"cn-zhangjiakou\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\"\\n}","type":"json"}]',
],
'GetSkillSpace' => [
'summary' => 'Queries the details of a SkillSpace.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SkillSpaceId',
'in' => 'query',
'schema' => ['description' => 'SkillSpace ID', 'type' => 'string', 'required' => true, 'example' => 'ss-xxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
'SkillSpaceId' => ['title' => '', 'description' => 'SkillSpace ID', 'type' => 'string', 'example' => 'ss-xxxxx'],
'SkillSpaceName' => ['title' => '', 'description' => 'The SkillSpace name.', 'type' => 'string', 'example' => 'office-toolkit-skills'],
'SkillSpaceDescription' => ['title' => '', 'description' => 'The SkillSpace description.', 'type' => 'string', 'example' => 'All-in-one office toolkit — generate reports, process data, manage files, and streamline workflows effortlessly.'],
'CreateTime' => ['title' => '', 'description' => 'The time when the SkillSpace was created.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the SkillSpace was last updated.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z'],
],
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidSkillSpace.NotFound', 'errorMessage' => 'The specified SkillSpace does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => 'View skillSpace details',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the specification change feature and configured the specification change parameters when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetSkillSpace',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"SkillSpaceId\\": \\"ss-xxxxx\\",\\n \\"SkillSpaceName\\": \\"office-toolkit-skills\\",\\n \\"SkillSpaceDescription\\": \\"All-in-one office toolkit — generate reports, process data, manage files, and streamline workflows effortlessly.\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\"\\n}","type":"json"}]',
],
'GetUserInformation' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcomputenest0EG8HU'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '52EBAF16-22F6-53DB-AE1E-44764FC62AF0'],
'DeliverySettings' => [
'description' => 'The delivery settings.',
'type' => 'object',
'properties' => [
'OssEnabled' => ['description' => 'Specifies whether to deliver data to Object Storage Service (OSS). Valid values:'."\n"
."\n"
.'- true: Enabled.'."\n"
."\n"
.'- false: Disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => '0101data'],
'OssPath' => ['description' => 'The path in OSS.', 'type' => 'string', 'title' => '', 'example' => '/test'],
'OssExpirationDays' => ['description' => 'The number of days to save screen recordings.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '7'],
'ActiontrailDeliveryToOssEnabled' => ['description' => 'Specifies whether to use the delivery feature. Valid values:'."\n"
."\n"
.'- true: Enabled.'."\n"
."\n"
.'- false: Disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'title' => 'GetUserInformation',
'summary' => 'Queries user information.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserInformation'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetUserInformation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'UserInfo', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:UserInfo'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52EBAF16-22F6-53DB-AE1E-44764FC62AF0\\",\\n \\"DeliverySettings\\": {\\n \\"OssEnabled\\": true,\\n \\"OssBucketName\\": \\"0101data\\",\\n \\"OssPath\\": \\"/test\\",\\n \\"OssExpirationDays\\": 7,\\n \\"ActiontrailDeliveryToOssEnabled\\": true\\n }\\n}","type":"json"}]',
],
'ListBackups' => [
'summary' => 'Queries a list of backups for Compute Nest service instances.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232493',
'abilityTreeNodes' => ['FEATUREcomputenestSE9C8Z'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0='],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'The filter values.',
'type' => 'array',
'items' => ['description' => 'A filter value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'si-xxx'],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'The name of the filter. You can query by one or more filter names. Valid values:'."\n"
."\n"
.'- BackupId: The backup ID.'."\n"
."\n"
.'- ServiceInstanceId: The service instance ID.'."\n"
."\n"
.'- Status: The status.'."\n"
."\n"
.'- StartTime: The start time.'."\n"
."\n"
.'- EndTime: The end time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ServiceInstanceId'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'docRequired' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '', 'description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BB58FE53-ED8F-5D12-9746-CD3A5F463D95'],
'NextToken' => ['title' => '', 'description' => 'The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'required' => true, 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0='],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Backups' => [
'description' => 'The backups.',
'type' => 'array',
'items' => [
'description' => 'The details of a backup.',
'type' => 'object',
'properties' => [
'BackupId' => ['description' => 'The backup ID.', 'type' => 'string', 'title' => '', 'example' => 'backup-4e13aa8ca6a34150addd'],
'ServiceInstanceId' => ['description' => 'The service instance ID.', 'type' => 'string', 'title' => '', 'example' => 'si-7b6138dfce1e4c41ab71'],
'StartTime' => ['description' => 'The time when the backup started.', 'type' => 'string', 'title' => '', 'example' => '2025-06-30T16:00:00Z'],
'EndTime' => ['description' => 'The time when the backup ended.', 'type' => 'string', 'title' => '', 'example' => '2024-08-15T02:24:00Z'],
'Status' => ['description' => 'The status.'."\n"
."\n"
.'- Creating: The backup is being created.'."\n"
."\n"
.'- Created: The backup is created.'."\n"
."\n"
.'- CreateFailed: The backup failed to be created.'."\n"
."\n"
.'- Deleting: The backup is being deleted.'."\n"
."\n"
.'- Deleted: The backup is deleted.'."\n"
."\n"
.'- DeleteFailed: The backup failed to be deleted.', 'type' => 'string', 'title' => '', 'example' => 'Creating'],
'Description' => ['description' => 'The description of the backup.', 'type' => 'string', 'title' => '', 'example' => 'No description'],
'BackupMode' => ['description' => 'The backup mode. The return value is:'."\n"
."\n"
.'- **Manual**: The backup is created manually.', 'type' => 'string', 'title' => '', 'example' => 'Manual'],
'RetentionDays' => ['description' => 'The retention period in days. Backups are deleted after the retention period expires. By default, this parameter is empty, which means that the backups do not expire.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'StatusDetail' => ['description' => 'The details of the status.', 'type' => 'string', 'title' => '', 'example' => 'Disk i-xxxx backup failed, error message: error '],
'ModifiedTime' => ['description' => 'The time when the backup was last updated.', 'type' => 'string', 'title' => '', 'example' => '2024-09-03T19:54:38+08:00'],
'CreateTime' => ['description' => 'The time when the backup was created.', 'type' => 'string', 'title' => '', 'example' => '2024-09-03T19:54:38+08:00'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'ListBackups',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider enabled the upgrade and downgrade feature and configured the related parameters when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListBackups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"BB58FE53-ED8F-5D12-9746-CD3A5F463D95\\",\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=\\",\\n \\"MaxResults\\": 100,\\n \\"Backups\\": [\\n {\\n \\"BackupId\\": \\"backup-4e13aa8ca6a34150addd\\",\\n \\"ServiceInstanceId\\": \\"si-7b6138dfce1e4c41ab71\\",\\n \\"StartTime\\": \\"2025-06-30T16:00:00Z\\",\\n \\"EndTime\\": \\"2024-08-15T02:24:00Z\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Description\\": \\"No description\\",\\n \\"BackupMode\\": \\"Manual\\",\\n \\"RetentionDays\\": 1,\\n \\"StatusDetail\\": \\"Disk i-xxxx backup failed, error message: error\\\\t\\",\\n \\"ModifiedTime\\": \\"2024-09-03T19:54:38+08:00\\",\\n \\"CreateTime\\": \\"2024-09-03T19:54:38+08:00\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListPolicies' => [
'summary' => 'Retrieves a list of access policies.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '43373',
'abilityTreeNodes' => ['FEATUREcomputenestJ4D829'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. If this parameter is empty, no more results exist.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4='],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '51945B04-6AA6-410D-93BA-236E0248B104'],
'NextToken' => ['title' => 'NextToken', 'description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => 'AAAAAZ9FmxgN6wKfeK/GOKRnnjU='],
'Policies' => [
'description' => 'The list of access policies.',
'type' => 'array',
'items' => [
'description' => 'The information about the access policy.',
'type' => 'object',
'properties' => [
'Description' => ['description' => 'The description of the access policy.', 'type' => 'string', 'title' => '', 'example' => 'Read-only permission'],
'PolicyName' => ['description' => 'The name of the access policy.', 'type' => 'string', 'title' => '', 'example' => 'AliyunComputeNestPolicyForReadOnly'],
'PolicyType' => ['description' => 'The type of the access policy.'."\n"
."\n"
.'- Custom: A custom policy.'."\n"
."\n"
.'- System: A system policy.', 'type' => 'string', 'title' => '', 'example' => 'System'],
'PolicyDocument' => ['description' => 'The content of the policy.', 'type' => 'string', 'title' => '', 'example' => '{"Action":["*:Describe*","*:List*","*:Get*","*:BatchGet*","*:Query*","*:BatchQuery*","actiontrail:LookupEvents"],"Resource":["*"],"Effect":"Allow"}'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\",\\n \\"NextToken\\": \\"AAAAAZ9FmxgN6wKfeK/GOKRnnjU=\\",\\n \\"Policies\\": [\\n {\\n \\"Description\\": \\"Read-only permission\\",\\n \\"PolicyName\\": \\"AliyunComputeNestPolicyForReadOnly\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"PolicyDocument\\": \\"{\\\\\\"Action\\\\\\":[\\\\\\"*:Describe*\\\\\\",\\\\\\"*:List*\\\\\\",\\\\\\"*:Get*\\\\\\",\\\\\\"*:BatchGet*\\\\\\",\\\\\\"*:Query*\\\\\\",\\\\\\"*:BatchQuery*\\\\\\",\\\\\\"actiontrail:LookupEvents\\\\\\"],\\\\\\"Resource\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"Effect\\\\\\":\\\\\\"Allow\\\\\\"}\\"\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
'title' => 'ListPolicies',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPolicies'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListPolicies',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Policy', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:policy/*'],
],
],
],
],
'translator' => 'manual',
],
'ListPublicSkills' => [
'summary' => 'Queries the list of public skills.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'Anonymous' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'The list of filter values. Valid values of N: 1 to 10.',
'type' => 'array',
'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => 's-xxxxx', 'title' => ''],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'The filter name. You can specify one or more names for the query. Valid values:'."\n"
."\n"
.'- SkillId: the skill ID. Exact match.'."\n"
."\n"
.'- SkillName: the skill name.'."\n"
."\n"
.'- MatchType: the match type that controls how SkillName is matched. Valid values: exact, prefix, and fuzzy.'."\n"
."\n"
.'- Keyword: keyword match against the skill name or skill description. Fuzzy match.'."\n"
."\n"
.'- SkillLabels: the skill label set. Fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'SkillId', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'default' => '10', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NeedDownloadUrl',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to include the download URL for the skill package.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3F976EF8-C10A-57DC-917C-BB7BEB508FFB'],
'NextToken' => ['title' => '', 'description' => 'The token for the next page.', 'type' => 'string', 'example' => 'AAAAAZ9FmxgN6wKfeK/GOKRnnjU='],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Skills' => [
'title' => '',
'description' => 'The list of skills.',
'type' => 'array',
'items' => [
'description' => 'The skill details object.',
'type' => 'object',
'properties' => [
'SkillId' => ['title' => '', 'description' => 'Skill ID', 'type' => 'string', 'example' => 's-xxxxx'],
'SkillName' => ['title' => '', 'description' => 'The skill name.', 'type' => 'string', 'example' => 'skill-creator'],
'SkillDisplayName' => ['title' => '', 'description' => 'The skill display name.', 'type' => 'string', 'example' => ''],
'SkillDescription' => ['title' => '', 'description' => 'The skill description.', 'type' => 'string', 'example' => 'Create new skills, modify and improve existing skills, and measure skill performance.'],
'Locales' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OriginalValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ZhValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EnValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'SkillLabels' => [
'description' => 'The skill label set.',
'type' => 'array',
'items' => ['description' => 'The skill label.', 'type' => 'string', 'example' => 'category:frontend-development', 'title' => ''],
'title' => '',
'example' => '',
],
'SkillSpaceId' => ['title' => '', 'description' => 'The ID of the SkillSpace to which the skill belongs.', 'type' => 'string', 'example' => 'ss-xxxxx'],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-09-11T02:18:42Z', 'title' => ''],
'UpdateTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-11-03T22:58:52Z'],
'DownloadUrl' => ['description' => 'The download URL for the skill package.', 'type' => 'string', 'example' => 'https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/skill-creator.zip', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Query public skill list',
'description' => '### Before you begin'."\n"
.'Make sure the service provider has enabled the specification change feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F976EF8-C10A-57DC-917C-BB7BEB508FFB\\",\\n \\"NextToken\\": \\"AAAAAZ9FmxgN6wKfeK/GOKRnnjU=\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Skills\\": [\\n {\\n \\"SkillId\\": \\"s-xxxxx\\",\\n \\"SkillName\\": \\"skill-creator\\",\\n \\"SkillDisplayName\\": \\"\\",\\n \\"SkillDescription\\": \\"Create new skills, modify and improve existing skills, and measure skill performance.\\",\\n \\"Locales\\": [\\n {\\n \\"OriginalValue\\": \\"\\",\\n \\"ZhValue\\": \\"\\",\\n \\"EnValue\\": \\"\\"\\n }\\n ],\\n \\"SkillLabels\\": [\\n \\"category:frontend-development\\"\\n ],\\n \\"SkillSpaceId\\": \\"ss-xxxxx\\",\\n \\"CreateTime\\": \\"2025-09-11T02:18:42Z\\",\\n \\"UpdateTime\\": \\"2025-11-03T22:58:52Z\\",\\n \\"DownloadUrl\\": \\"https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/skill-creator.zip\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListRestoreTasks' => [
'summary' => 'Queries a list of restore jobs.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232531',
'abilityTreeNodes' => ['FEATUREcomputenestSE9C8Z'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU='],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'A list of filter values.',
'type' => 'array',
'items' => ['description' => 'A list of filter values.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'si-xxxx'],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'The name of the filter. You can query by one or more filter names. Valid values:'."\n"
."\n"
.'- RestoreTaskId: The restore job ID.'."\n"
."\n"
.'- ServiceInstanceId: The service instance ID.'."\n"
."\n"
.'- Status: The status.'."\n"
."\n"
.'- StartTime: The start time.'."\n"
."\n"
.'- EndTime: The end time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ServiceInstanceId'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'docRequired' => true,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '', 'description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21'],
'NextToken' => ['title' => '', 'description' => 'The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'required' => true, 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4='],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries returned for the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'RestoreTasks' => [
'description' => 'The list of restore jobs.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RestoreTaskId' => ['description' => 'The ID of the restore job.', 'type' => 'string', 'title' => '', 'example' => 'restore-xxxxxx'],
'ServiceInstanceId' => ['description' => 'The ID of the service instance.', 'type' => 'string', 'title' => '', 'example' => 'si-8c367c27c84e44a79d36'],
'BackupId' => ['description' => 'The backup ID.', 'type' => 'string', 'title' => '', 'example' => 'backup-728f128bf92c4e3da970'],
'EndTime' => ['description' => 'The time when the restore job ended.', 'type' => 'string', 'title' => '', 'example' => '2025-01-27T18:00:00Z'],
'Status' => ['description' => 'The status of the service instance. Valid values:'."\n"
."\n"
.'- Restoring: The service instance is being restored.'."\n"
."\n"
.'- Restored: The service instance was restored.'."\n"
."\n"
.'- RestoreFailed: The service instance failed to be restored.', 'type' => 'string', 'title' => '', 'example' => 'Restoring'],
'StartTime' => ['description' => 'The time when the restore job started.', 'type' => 'string', 'title' => '', 'example' => '2025-01-27T16:00:00Z'],
'StatusDetail' => ['description' => 'The details of the instance status.', 'type' => 'string', 'title' => '', 'example' => 'i-xxxx failed, error message: error'],
'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'title' => '', 'example' => '2023-09-07T11:37:37Z'],
'ModifiedTime' => ['description' => 'The time when the job was last updated.', 'type' => 'string', 'title' => '', 'example' => '2025-05-07T12:16:16Z'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListRestoreTasks',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider enabled the upgrade and downgrade feature and configured its parameters when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListRestoreTasks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\",\\n \\"NextToken\\": \\"BBBAAfu+XtuBE55iRLHEYYuojI4=\\",\\n \\"MaxResults\\": 20,\\n \\"RestoreTasks\\": [\\n {\\n \\"RestoreTaskId\\": \\"restore-xxxxxx\\",\\n \\"ServiceInstanceId\\": \\"si-8c367c27c84e44a79d36\\",\\n \\"BackupId\\": \\"backup-728f128bf92c4e3da970\\",\\n \\"EndTime\\": \\"2025-01-27T18:00:00Z\\",\\n \\"Status\\": \\"Restoring\\",\\n \\"StartTime\\": \\"2025-01-27T16:00:00Z\\",\\n \\"StatusDetail\\": \\"i-xxxx failed, error message: error\\",\\n \\"CreateTime\\": \\"2023-09-07T11:37:37Z\\",\\n \\"ModifiedTime\\": \\"2025-05-07T12:16:16Z\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListServiceCategories' => [
'summary' => 'Lists the available service categories.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '203728',
'abilityTreeNodes' => ['FEATUREcomputenestB2MIVU'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response structure.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
'Categories' => [
'description' => 'A list of service category names.',
'type' => 'array',
'items' => ['description' => 'The name of the service category.', 'type' => 'string', 'title' => '', 'example' => 'AI'],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"Categories\\": [\\n \\"AI\\"\\n ]\\n}","type":"json"}]',
'title' => 'ListServiceCategories',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceCategories'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListServiceCategories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListServiceInstanceBill' => [
'summary' => 'Call the ListServiceInstanceBill operation to query bills for service instances.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '177374',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38=', 'title' => ''],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.', 'type' => 'string', 'required' => false, 'example' => 'si-49793f3bfa034ec6a990', 'title' => ''],
],
[
'name' => 'BillingCycle',
'in' => 'query',
'schema' => ['description' => 'The billing cycle in YYYY-MM format. Only billing cycles in the last 18 months are supported.', 'type' => 'string', 'required' => true, 'example' => '2024-05', 'title' => ''],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => ['description' => 'The granularity of the bills to query. Valid values:'."\n"
."\n"
.'- MONTHLY: monthly. The data is consistent with the bills aggregated by billing cycle in the User Center.'."\n"
."\n"
.'- DAILY: daily. The data is consistent with the bills aggregated by day in the User Center.'."\n"
."\n"
.'If you set this parameter to DAILY, you must also specify **BillingDate**.', 'type' => 'string', 'required' => false, 'example' => 'DAILY', 'title' => ''],
],
[
'name' => 'BillingDate',
'in' => 'query',
'schema' => ['description' => 'The billing date. This parameter is required only when **Granularity** is set to DAILY. The format is YYYY-MM-DD.', 'type' => 'string', 'required' => false, 'example' => '2025-04-01', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2849EE73-AFFA-5AFD-9575-12FA886451DA', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries returned per page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Item' => [
'description' => 'A list of billing information for the service instance.',
'type' => 'array',
'items' => [
'description' => 'The billing information for the service instance.',
'type' => 'object',
'properties' => [
'SplitBillingCycle' => ['description' => 'The month of the split bill.', 'type' => 'string', 'example' => '2021-07', 'title' => ''],
'BillingDate' => ['description' => 'The billing date in YYYY-MM-DD format. This parameter is returned only when **Granularity** is set to DAILY.', 'type' => 'string', 'example' => '2024-10-23', 'title' => ''],
'SubscriptionType' => ['description' => 'The billing method. Valid values:'."\n"
."\n"
.'- Subscription: subscription.'."\n"
."\n"
.'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''],
'ProductName' => ['description' => 'The name of the product to which the resource belongs.', 'type' => 'string', 'example' => 'NLB', 'title' => ''],
'BillingItemCode' => ['description' => 'The code of the billable item.', 'type' => 'string', 'example' => 'disk'."\n", 'title' => ''],
'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'sls', 'title' => ''],
'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'example' => 'sls', 'title' => ''],
'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-bp1z88pb48487907u', 'title' => ''],
'DeductedByResourcePackage' => ['description' => 'The amount deducted by a resource plan.', 'type' => 'string', 'example' => '0', 'title' => ''],
'ListPriceUnit' => ['description' => 'The unit of the list price.', 'type' => 'string', 'example' => 'CNY/GB', 'title' => ''],
'Usage' => ['description' => 'The number of input tokens.', 'type' => 'string', 'example' => '{\'EmbeddingTokens\': 314}', 'title' => ''],
'ListPrice' => ['description' => 'The list price.', 'type' => 'string', 'example' => '0.12', 'title' => ''],
'UsageUnit' => ['description' => 'The unit of the usage.', 'type' => 'string', 'example' => 'GB'."\n", 'title' => ''],
'PretaxGrossAmount' => ['description' => 'The pretax gross amount.', 'type' => 'string', 'example' => '0', 'title' => ''],
'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'string', 'example' => '0', 'title' => ''],
'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'string', 'example' => '0', 'title' => ''],
'BillingCycle' => ['description' => 'The billing cycle of the computing resources for the instance. This parameter is supported only for pay-as-you-go instances. Valid values:'."\n"
."\n"
.'- **Day**: daily billing.'."\n"
."\n"
.'- **Month**: monthly billing.', 'type' => 'string', 'example' => '2025-02', 'title' => ''],
'BillingItem' => ['description' => 'The billable item.', 'type' => 'string', 'example' => 'Bandwidth', 'title' => ''],
'Currency' => ['description' => 'The currency. Valid values:'."\n"
."\n"
.'- CNY: Chinese Yuan.'."\n"
."\n"
.'- USD: US Dollar.'."\n"
."\n"
.'- JPY: Japanese Yen.', 'type' => 'string', 'example' => 'RMB', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=\\",\\n \\"RequestId\\": \\"2849EE73-AFFA-5AFD-9575-12FA886451DA\\",\\n \\"TotalCount\\": 0,\\n \\"MaxResults\\": 10,\\n \\"Item\\": [\\n {\\n \\"SplitBillingCycle\\": \\"2021-07\\",\\n \\"BillingDate\\": \\"2024-10-23\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"ProductName\\": \\"NLB\\",\\n \\"BillingItemCode\\": \\"disk\\\\n\\",\\n \\"ProductCode\\": \\"sls\\",\\n \\"ProductDetail\\": \\"sls\\",\\n \\"InstanceID\\": \\"rm-bp1z88pb48487907u\\",\\n \\"DeductedByResourcePackage\\": \\"0\\",\\n \\"ListPriceUnit\\": \\"CNY/GB\\",\\n \\"Usage\\": \\"{\'EmbeddingTokens\': 314}\\",\\n \\"ListPrice\\": \\"0.12\\",\\n \\"UsageUnit\\": \\"GB\\\\n\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"InvoiceDiscount\\": \\"0\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"BillingCycle\\": \\"2025-02\\",\\n \\"BillingItem\\": \\"Bandwidth\\",\\n \\"Currency\\": \\"RMB\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListServiceInstanceBill',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceBill'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceBill',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
'translator' => 'manual',
],
'ListServiceInstanceLogs' => [
'summary' => 'Retrieves the deployment and upgrade logs of a service instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '55519',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. Set this to the NextToken value that was returned in the last response.', 'type' => 'string', 'required' => false, 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', 'title' => ''],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => true, 'example' => 'si-70a3b15bb626435b****', 'title' => ''],
],
[
'name' => 'LogSource',
'in' => 'query',
'schema' => ['description' => 'The log source. Valid values:'."\n"
."\n"
.'- computeNest (default): The deployment and upgrade logs of the service instance.'."\n"
."\n"
.'- application: The logs generated by the application.'."\n"
."\n"
.'- actionTrail: The ActionTrail audit logs.'."\n"
."\n"
.'- ros: The ROS logs.'."\n"
."\n"
.'- compliancePack: The compliance package logs.', 'type' => 'string', 'required' => false, 'example' => 'computeNest', 'title' => ''],
],
[
'name' => 'Logstore',
'in' => 'query',
'schema' => ['description' => 'The Logstore. This parameter is required when you query application logs.', 'type' => 'string', 'required' => false, 'example' => 'logabc', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'A list of filter values. The value of N can be from 1 to 10.',
'type' => 'array',
'items' => ['description' => 'The value of the filter condition.', 'type' => 'string', 'required' => false, 'example' => '- StartTime:2024-07-01T02:41:20Z'."\n"
.'- EndTime:2024-07-01T02:41:20Z'."\n"
.'- EventName:DeleteInstance'."\n"
.'- ResourceName:i-bp1dgfcx8vl4w9m7a1st'."\n"
.'- ApplicationGroupName:groupA', 'title' => ''],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => [
'description' => 'The filter name. You can query by one or more filter names. Valid values:'."\n"
."\n"
.'- StartTime: Queries logs by the start time of the log event.'."\n"
."\n"
.'- EndTime: Queries logs by the end time of the ActionTrail event.'."\n"
."\n"
.'- EventName: Queries logs by the name of the ActionTrail event.'."\n"
."\n"
.'- ResourceName: Queries logs by the ActionTrail resource name.'."\n"
."\n"
.'- ApplicationGroupName: Queries logs by the application group name.',
'enumValueTitles' => ['EndTime' => 'EndTime', 'ResourceName' => 'ResourceName', 'StartTime' => 'StartTime', 'EventName' => 'EventName'],
'type' => 'string',
'required' => false,
'example' => '- StartTime'."\n"
.'- EndTime'."\n"
.'- EventName'."\n"
.'- ResourceName'."\n"
.'- ApplicationGroupName',
'title' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => [
'description' => 'The sort order. Valid values:'."\n"
."\n"
.'- Ascending: Ascending order.'."\n"
."\n"
.'- Descending (default): Descending order.',
'enumValueTitles' => ['Descending' => 'Descending', 'Ascending' => 'Ascending'],
'type' => 'string',
'required' => false,
'example' => '- Ascending'."\n"
.'- Descending',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51945B04-6AA6-410D-93BA-236E0248B104', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries returned per page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'ServiceInstancesLogs' => [
'description' => 'The service instance logs.',
'type' => 'array',
'items' => [
'description' => 'The service instance logs.',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => 'The timestamp of the service instance log.', 'type' => 'string', 'example' => '2021-05-21T00:00:00Z', 'title' => ''],
'Source' => ['description' => 'The source of the service instance log. Valid values:'."\n"
."\n"
.'computeNest: The deployment and upgrade logs of the service instance.'."\n"
."\n"
.'application: The logs generated by the application.'."\n"
."\n"
.'actionTrail: The ActionTrail audit logs.'."\n"
."\n"
.'ros: The ROS logs.'."\n"
."\n"
.'compliancePack: The compliance package logs.', 'type' => 'string', 'example' => 'ros', 'title' => ''],
'Content' => ['description' => 'The log content.', 'type' => 'string', 'example' => 'Start creating service instance', 'title' => ''],
'LogType' => ['description' => 'The log type. Valid values:'."\n"
."\n"
.'- serviceInstance: The logs generated by the service instance.'."\n"
."\n"
.'- resource: The logs generated by the ROS resource.', 'type' => 'string', 'example' => 'serviceInstance', 'title' => ''],
'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ROS.Stack', 'title' => ''],
'ResourceId' => ['description' => 'The associated ID.', 'type' => 'string', 'example' => 'si-5c6525c0589545c3****', 'title' => ''],
'Status' => ['description' => 'The log status. Valid values:'."\n"
."\n"
.'- Creating: The instance is being created.'."\n"
."\n"
.'- Created: The instance is created.'."\n"
."\n"
.'- Deploying: The instance is being deployed.'."\n"
."\n"
.'- Deployed: The instance is deployed.'."\n"
."\n"
.'- DeployedFailed: The deployment failed.'."\n"
."\n"
.'- Expired: The instance has expired.'."\n"
."\n"
.'- ExtendSuccess: The renewal is successful.'."\n"
."\n"
.'- Upgrading: The instance is being upgraded.'."\n"
."\n"
.'- UpgradeSuccess: The upgrade is successful.', 'type' => 'string', 'example' => 'Creating', 'title' => ''],
'CompliancePackType' => ['description' => 'The threat type of the compliance package. For example, VpcDataRisk indicates a data security check in a VPC.', 'type' => 'string', 'example' => 'VpcDataRisk'."\n"
."\n", 'title' => ''],
'ComplianceRuleName' => ['description' => 'The name of the specific threat rule in the compliance package. For example, ecs-move-out-vpc indicates the migration of an ECS instance out of a VPC.', 'type' => 'string', 'example' => 'ecs-move-out-vpc', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Source\\": \\"ros\\",\\n \\"Content\\": \\"Start creating service instance\\",\\n \\"LogType\\": \\"serviceInstance\\",\\n \\"ResourceType\\": \\"ROS.Stack\\",\\n \\"ResourceId\\": \\"si-5c6525c0589545c3****\\",\\n \\"Status\\": \\"Creating\\",\\n \\"CompliancePackType\\": \\"VpcDataRisk\\\\n\\\\n\\",\\n \\"ComplianceRuleName\\": \\"ecs-move-out-vpc\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListServiceInstanceLogs',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceLogs'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceLogs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceInstanceId}'],
],
],
],
],
],
'ListServiceInstanceResources' => [
'summary' => 'Queries the resources of a service instance based on parameters such as the service instance ID, Alibaba Cloud Resource Name (ARN), and region ID.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '89603',
'abilityTreeNodes' => ['FEATUREcomputenest2G0818'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. Set this to the NextToken value from a previous API call.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc='],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-d8a0cc2a1ee04dce****'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource tags.',
'type' => 'array',
'items' => [
'description' => 'The resource tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the resource tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1'],
'Value' => ['description' => 'The value of the resource tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'value1'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type of the service instance. Valid values:'."\n"
."\n"
.'- AliyunResource: an Alibaba Cloud resource.'."\n"
."\n"
.'- ContainerResource: a container group (pod) resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AliyunResource'],
],
[
'name' => 'Filters',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => 'The filter conditions. Valid values:'."\n"
."\n"
.'- ExpireTimeStart: The start of the time range to query the expiration time of subscription resources.'."\n"
.' >This parameter applies only to service instances in private deployments.>'."\n"
."\n"
.'- ExpireTimeEnd: The end of the time range to query the expiration time of subscription resources.'."\n"
.' >This parameter applies only to service instances in private deployments.>'."\n"
."\n"
.'- PayType: The billing method.> This parameter applies only to service instances in private deployments.>'."\n"
.' Valid values:'."\n"
."\n"
.' - Subscription: subscription.'."\n"
."\n"
.' - PayAsYouGo: pay-as-you-go.'."\n"
."\n"
.'- ResourceARN: The Alibaba Cloud Resource Name (ARN) of the resource.'."\n"
."\n"
.'resource name (ARN).',
'type' => 'array',
'items' => [
'description' => 'The filter parameters.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the filter. Valid values:'."\n"
."\n"
.'- ExpireTimeStart'."\n"
."\n"
.'- ExpireTimeEnd'."\n"
."\n"
.'- PayType'."\n"
."\n"
.'- ResourceARN', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ExpireTimeStart'],
'Values' => [
'description' => 'The filter condition values.',
'type' => 'array',
'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-01-01T12:00:00'."\n"
.'Z'],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc='],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'B288A0BE-D927-4888-B0F7-B35EF84B6E6F'],
'MaxResults' => ['description' => 'The number of entries returned on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
'Resources' => [
'description' => 'The list of resources.',
'type' => 'array',
'items' => [
'description' => 'The details of a resource.',
'type' => 'object',
'properties' => [
'ResourceARN' => ['description' => 'The ARN of the resource.', 'type' => 'string', 'title' => '', 'example' => 'arn:acs:sag:cn-hangzhou:130920852836****:ccn/ccn-b3qf0q439sq2de****'],
'PayType' => ['description' => 'The billing method. Valid values:'."\n"
."\n"
.'- Subscription: subscription.'."\n"
."\n"
.'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'Subscription'],
'RenewStatus' => ['description' => 'The renewal status. Valid values:'."\n"
."\n"
.'- AutoRenewal: auto-renewal.'."\n"
."\n"
.'- ManualRenewal: manual renewal.'."\n"
."\n"
.'- NotRenewal: no renewal.', 'type' => 'string', 'title' => '', 'example' => 'AutoRenewal'],
'CreateTime' => ['description' => 'The time when the resource was created.', 'type' => 'string', 'title' => '', 'example' => '2022-01-01T12:00:00'],
'ExpireTime' => ['description' => 'The time when the resource expires.', 'type' => 'string', 'title' => '', 'example' => '2022-03-01T12:00:00'],
'RenewalPeriod' => ['description' => 'The renewal period.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'RenewalPeriodUnit' => ['description' => 'The unit of the renewal period. Valid values:'."\n"
."\n"
.'- Month: month.'."\n"
."\n"
.'- Year: year.', 'type' => 'string', 'title' => '', 'example' => 'Month'],
'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'RDS'],
'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'],
'Status' => ['description' => 'The status of the resource. Valid values:'."\n"
."\n"
.'- running: The resource is running.'."\n"
."\n"
.'- waiting: The resource is pending.'."\n"
."\n"
.'- terminated: The resource is terminated.'."\n"
."\n"
.'> This parameter is returned only for container resources.', 'type' => 'string', 'title' => '', 'example' => 'running'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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\\": \\"running\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListServiceInstanceResources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceResources'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
],
'ListServiceInstanceUpgradeHistory' => [
'summary' => 'You can call ListServiceInstanceUpgradeHistory to query the upgrade history of a service instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcomputenest7EAOIM'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token to retrieve the next page of results. Do not specify this parameter for the first request. For subsequent requests, specify the token returned in the previous request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4='],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-70a3b15bb62643xxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI41'],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE3EDF4E-B3B1-19B6-BD01-30D4D00F6E5D'],
'MaxResults' => ['description' => 'The number of entries returned per page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
'UpgradeHistory' => [
'description' => 'The upgrade history records.',
'type' => 'array',
'items' => [
'description' => 'An upgrade history record.',
'type' => 'object',
'properties' => [
'UpgradeHistoryId' => ['description' => 'The ID of the upgrade history.', 'type' => 'string', 'title' => '', 'example' => 'exec-123'],
'Type' => ['description' => 'The type of upgrade. Valid values:'."\n"
."\n"
.'- Upgrade'."\n"
."\n"
.'- Rollback', 'type' => 'string', 'title' => '', 'example' => 'Upgrade'],
'FromVersion' => ['description' => 'The version before the upgrade.', 'type' => 'string', 'title' => '', 'example' => '1'],
'ToVersion' => ['description' => 'The version after the upgrade.', 'type' => 'string', 'title' => '', 'example' => '3'],
'Status' => ['description' => 'The status of the upgrade. Valid values:'."\n"
."\n"
.'- upgrading'."\n"
."\n"
.'- UpgradeSuccessful'."\n"
."\n"
.'- UpgradeFailed', 'type' => 'string', 'title' => '', 'example' => 'UpgradeFailed'],
'Results' => ['description' => 'The upgrade results.', 'type' => 'string', 'title' => '', 'example' => '{\\"PreUpgradeExecutionId\\":\\"exec-123\\"}'],
'StartTime' => ['description' => 'The time when the upgrade started.', 'type' => 'string', 'title' => '', 'example' => '2022-04-26T08:09:51Z'],
'EndTime' => ['description' => 'The time when the upgrade ended.', 'type' => 'string', 'title' => '', 'example' => '2022-04-26T09:09:51Z'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI41\\",\\n \\"RequestId\\": \\"EE3EDF4E-B3B1-19B6-BD01-30D4D00F6E5D\\",\\n \\"MaxResults\\": 20,\\n \\"UpgradeHistory\\": [\\n {\\n \\"UpgradeHistoryId\\": \\"exec-123\\",\\n \\"Type\\": \\"Upgrade\\",\\n \\"FromVersion\\": \\"1\\",\\n \\"ToVersion\\": \\"3\\",\\n \\"Status\\": \\"UpgradeFailed\\",\\n \\"Results\\": \\"{\\\\\\\\\\\\\\"PreUpgradeExecutionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec-123\\\\\\\\\\\\\\"}\\",\\n \\"StartTime\\": \\"2022-04-26T08:09:51Z\\",\\n \\"EndTime\\": \\"2022-04-26T09:09:51Z\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]',
'title' => 'ListServiceInstanceUpgradeHistory',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceUpgradeHistory'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceUpgradeHistory',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
],
'ListServiceInstances' => [
'summary' => 'Queries service instances for your account in a specified region.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36941',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The query token. Set it to the **NextToken** value returned from the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'The list of filter values.',
'type' => 'array',
'items' => ['description' => 'The list of filter values. The value of N can be from 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'The name of the filter. You can specify one or more filter names to query resources. Valid values:'."\n"
."\n"
.'- Name: The name of the service. To perform a fuzzy search, enter the value in the \\*xxx\\* format. For example, if the service name is My Service, you can enter \\*My\\* or \\*Service\\* for a fuzzy search.'."\n"
."\n"
.'- ServiceInstanceName: The name of the service instance. A fuzzy query is performed if you enter one service instance name. A term query is performed if you enter multiple service instance names.'."\n"
."\n"
.'- ServiceInstanceId: The service instance ID.'."\n"
."\n"
.'- ServiceId: The service ID.'."\n"
."\n"
.'- Version: The service version.'."\n"
."\n"
.'- Status: The instance status.'."\n"
."\n"
.'- DeployType: The deployment type.'."\n"
."\n"
.'- ServiceType: The service type.'."\n"
."\n"
.'- OperationStartTimeBefore: The time before the start of the Alibaba Cloud Managed Services.'."\n"
."\n"
.'- OperationStartTimeAfter: The time after the start of the Alibaba Cloud Managed Services.'."\n"
."\n"
.'- OperationEndTimeBefore: The time before the end of the Alibaba Cloud Managed Services.'."\n"
."\n"
.'- OperationEndTimeAfter: The time after the end of the Alibaba Cloud Managed Services.'."\n"
."\n"
.'- OperatedServiceInstanceId: The ID of the managed service instance under a private service.'."\n"
."\n"
.'- OperationServiceInstanceId: The ID of the service instance under a pure managed service.'."\n"
."\n"
.'- EnableInstanceOps: Indicates whether the Alibaba Cloud Managed Services feature is enabled for the service instance.', 'type' => 'string', 'required' => false, 'example' => 'ServiceInstanceId', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The custom tags.',
'type' => 'array',
'items' => [
'description' => 'The custom tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4=', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E50287CB-AABF-4877-92C0-289B339A1546', 'title' => ''],
'TotalCount' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries returned per page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'ServiceInstances' => [
'description' => 'The information about the service instances.',
'type' => 'array',
'items' => [
'description' => 'The information about the service instances.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the service instance.', 'type' => 'string', 'example' => 'TestName', 'title' => ''],
'Status' => ['description' => 'The status of the service instance. Possible values:'."\n"
."\n"
.'- Created: The service instance is created.'."\n"
."\n"
.'- Deploying: The service instance is being deployed.'."\n"
."\n"
.'- DeployedFailed: The service instance failed to be deployed.'."\n"
."\n"
.'- Deployed: The service instance is deployed.'."\n"
."\n"
.'- Upgrading: The service instance is being upgraded.'."\n"
."\n"
.'- Deleting: The service instance is being deleted.'."\n"
."\n"
.'- Deleted: The service instance is deleted.'."\n"
."\n"
.'- DeletedFailed: The service instance failed to be deleted.', 'type' => 'string', 'example' => 'Deployed', 'title' => ''],
'Outputs' => ['description' => 'The output information of the service instance.', 'type' => 'string', 'example' => '{"managementUrl": "http://xx.xx"}', 'title' => ''],
'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z', 'title' => ''],
'Parameters' => ['description' => 'The parameter information of the service instance.', 'type' => 'string', 'example' => '{"param":"value"}', 'title' => ''],
'ServiceInstanceId' => ['description' => 'The service instance ID.', 'type' => 'string', 'example' => 'si-d6ab3a63ccbb4b17****', 'title' => ''],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-05-20T00:00:00Z', 'title' => ''],
'StatusDetail' => ['description' => 'The description of the deployment information of the service instance.', 'type' => 'string', 'example' => 'deploy successfully', 'title' => ''],
'Progress' => ['description' => 'The deployment progress of the service instance. Unit: %.', 'type' => 'integer', 'format' => 'int64', 'example' => '90', 'title' => ''],
'Resources' => ['description' => 'The list of resources.', 'type' => 'string', 'example' => '[{"StackId": "stack-xxx"}]', 'title' => ''],
'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''],
'OperatedServiceInstanceId' => ['description' => 'The ID of the service instance that is managed by Alibaba Cloud.', 'type' => 'string', 'example' => 'si-d6ab3a63ccbb4b17****', 'title' => ''],
'Service' => [
'description' => 'The service.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The service status.', 'type' => 'string', 'example' => 'Online', 'title' => ''],
'PublishTime' => ['description' => 'The publishing time.', 'type' => 'string', 'example' => '2021-05-21T00:00:00Z', 'title' => ''],
'Version' => ['description' => 'The service version.', 'type' => 'string', 'example' => '1.0', 'title' => ''],
'DeployType' => ['description' => 'The deployment type. Possible values:'."\n"
."\n"
.'- ros: The service is deployed using ROS.'."\n"
."\n"
.'- terraform: The service is deployed using Terraform.'."\n"
."\n"
.'- ack: The service is deployed using ACK.'."\n"
."\n"
.'- spi: The service is deployed by calling SPI.'."\n"
."\n"
.'- operation: The service is deployed using Alibaba Cloud Managed Services.', 'type' => 'string', 'example' => 'ros', 'title' => ''],
'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'service-0e6fca6a51a54420****', 'title' => ''],
'SupplierUrl' => ['description' => 'The service provider\'s URL.', 'type' => 'string', 'example' => 'http://example.com', 'title' => ''],
'ServiceType' => ['description' => 'The service type. Possible values:'."\n"
."\n"
.'- private: The service is deployed in the user\'s account.'."\n"
."\n"
.'- managed: The service is hosted in the service provider\'s account.'."\n"
."\n"
.'- operation: The service is an Alibaba Cloud Managed Service.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'SupplierName' => ['description' => 'The name of the service provider.', 'type' => 'string', 'example' => 'Company A Ltd.', 'title' => ''],
'ServiceInfos' => [
'description' => 'The service information.',
'type' => 'array',
'items' => [
'description' => 'The service information.',
'type' => 'object',
'properties' => [
'Locale' => ['description' => 'The language of the service instance.', 'type' => 'string', 'example' => 'zh-CN', 'title' => ''],
'Image' => ['description' => 'The URL of the service icon.', 'type' => 'string', 'example' => 'https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png', 'title' => ''],
'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Database B', 'title' => ''],
'ShortDescription' => ['description' => 'The service overview.', 'type' => 'string', 'example' => 'B is an open-source distributed relational database independently designed and developed by Company A.', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'VersionName' => ['description' => 'The custom version name defined by the service provider.', 'type' => 'string', 'example' => 'Version A', 'title' => ''],
'Commodity' => [
'description' => 'The commodity specifications.',
'type' => 'object',
'properties' => [
'SaasBoostMetadata' => ['description' => 'The metadata of the Software as a Service (SaaS) Boost configuration.', 'type' => 'string', 'example' => '{'."\n"
.' //Enable/disable SaaS Boost binding'."\n"
.' "Enabled":true/false,default is false'."\n"
.' //Public access URL'."\n"
.' "PublicAccessUrl":"https://example.com"'."\n"
.'}', 'title' => ''],
'Type' => ['description' => 'The type. Possible values:'."\n"
."\n"
.'- Marketplace: Alibaba Cloud Marketplace.'."\n"
."\n"
.'- Css: Lingxiao.'."\n"
."\n"
.'- SaasBoost: SaaS Boost.', 'type' => 'string', 'example' => 'Marketplace', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'OperationStartTime' => ['description' => 'The start time of the Alibaba Cloud Managed Services.', 'type' => 'string', 'example' => '2021-12-29T06:48:56Z', 'title' => ''],
'OperationEndTime' => ['description' => 'The end time of the Alibaba Cloud Managed Services.', 'type' => 'string', 'example' => '2022-01-28T06:48:56Z', 'title' => ''],
'EnableInstanceOps' => ['description' => 'Indicates whether the service instance has the Alibaba Cloud Managed Services feature. Possible values:'."\n"
."\n"
.'- true: The service instance has the Alibaba Cloud Managed Services feature.'."\n"
."\n"
.'- false: The service instance does not have the Alibaba Cloud Managed Services feature.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Tags' => [
'description' => 'The custom tags.',
'type' => 'array',
'items' => [
'description' => 'The custom tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Source' => ['description' => 'The source from which the service instance was created.', 'type' => 'string', 'example' => 'Supplier', 'title' => ''],
'EndTime' => ['description' => 'The expiration time of the service instance.', 'type' => 'string', 'example' => '2022-01-01T12:00:00', 'title' => ''],
'ServiceType' => ['description' => 'The service type. Possible values:'."\n"
."\n"
.'- private: The service is deployed in the user\'s account.'."\n"
."\n"
.'- managed: The service is hosted in the service provider\'s account.'."\n"
."\n"
.'- operation: The service is an Alibaba Cloud Managed Service.'."\n"
."\n"
.'- poc: The service instance is a trial instance.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'PayType' => ['description' => 'The billing method. Valid values:'."\n"
."\n"
.'- Permanent: The service is purchased permanently.'."\n"
."\n"
.'- Subscription: The service is a subscription instance from Alibaba Cloud Marketplace.'."\n"
."\n"
.'- PayAsYouGo: The service is a pay-as-you-go instance from Alibaba Cloud Marketplace.'."\n"
."\n"
.'- CustomFixTime: The service has a custom fixed duration.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''],
'MarketInstanceId' => ['description' => 'The ID of the Alibaba Cloud Marketplace instance.', 'type' => 'string', 'example' => '5827****', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekz6scpcxxxxxx', 'title' => ''],
'BizStatus' => ['description' => 'The business status of the service instance. Possible values:'."\n"
."\n"
.'- Normal: The service instance is running as expected.'."\n"
."\n"
.'- Renewing: The service instance is being renewed.'."\n"
."\n"
.'- RenewFoiled: The renewal of the service instance failed.'."\n"
."\n"
.'- Expired: The service instance has expired.', 'type' => 'string', 'example' => 'Normal', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2306175xxxxxxxx', 'title' => ''],
'SupportTrialToPrivate' => ['description' => 'Indicates whether the trial instance can be converted to a regular instance.', 'type' => 'boolean', 'title' => '', 'example' => ''],
'PolicyNames' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GrantedPermission' => [
'type' => 'object',
'properties' => [
'OperationEndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'PolicyNames' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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 \\"Name\\": \\"TestName\\",\\n \\"Status\\": \\"Deployed\\",\\n \\"Outputs\\": \\"{\\\\\\"managementUrl\\\\\\": \\\\\\"http://xx.xx\\\\\\"}\\",\\n \\"UpdateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"Parameters\\": \\"{\\\\\\"param\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"ServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"CreateTime\\": \\"2021-05-20T00:00:00Z\\",\\n \\"StatusDetail\\": \\"deploy successfully\\",\\n \\"Progress\\": 90,\\n \\"Resources\\": \\"[{\\\\\\"StackId\\\\\\": \\\\\\"stack-xxx\\\\\\"}]\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"OperatedServiceInstanceId\\": \\"si-d6ab3a63ccbb4b17****\\",\\n \\"Service\\": {\\n \\"Status\\": \\"Online\\",\\n \\"PublishTime\\": \\"2021-05-21T00:00:00Z\\",\\n \\"Version\\": \\"1.0\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-0e6fca6a51a54420****\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"SupplierName\\": \\"Company A Ltd.\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png\\",\\n \\"Name\\": \\"Database B\\",\\n \\"ShortDescription\\": \\"B is an open-source distributed relational database independently designed and developed by Company A.\\"\\n }\\n ],\\n \\"VersionName\\": \\"Version A\\",\\n \\"Commodity\\": {\\n \\"SaasBoostMetadata\\": \\"{\\\\n //Enable/disable SaaS Boost binding\\\\n \\\\\\"Enabled\\\\\\":true/false,default is false\\\\n //Public access URL\\\\n \\\\\\"PublicAccessUrl\\\\\\":\\\\\\"https://example.com\\\\\\"\\\\n}\\",\\n \\"Type\\": \\"Marketplace\\"\\n }\\n },\\n \\"OperationStartTime\\": \\"2021-12-29T06:48:56Z\\",\\n \\"OperationEndTime\\": \\"2022-01-28T06:48:56Z\\",\\n \\"EnableInstanceOps\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Source\\": \\"Supplier\\",\\n \\"EndTime\\": \\"2022-01-01T12:00:00\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"MarketInstanceId\\": \\"5827****\\",\\n \\"ResourceGroupId\\": \\"rg-aekz6scpcxxxxxx\\",\\n \\"BizStatus\\": \\"Normal\\",\\n \\"OrderId\\": \\"2306175xxxxxxxx\\",\\n \\"SupportTrialToPrivate\\": false,\\n \\"PolicyNames\\": \\"\\",\\n \\"GrantedPermission\\": {\\n \\"OperationEndTime\\": \\"\\",\\n \\"PolicyNames\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListServiceInstances',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstances'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListServiceInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/*'],
],
],
],
],
'translator' => 'manual',
],
'ListServiceUsages' => [
'summary' => 'Queries your service usages.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '137236',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. This value is the NextToken value returned from the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU=', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the filter. You can query by one or more names. Valid values:'."\n"
."\n"
.'- ServiceId: The service ID.'."\n"
."\n"
.'- ServiceName: The service name.'."\n"
."\n"
.'- Status: The service status.'."\n"
."\n"
.'- SupplierName: The name of the supplier.', 'type' => 'string', 'required' => false, 'example' => 'ServiceId', 'title' => ''],
'Value' => [
'description' => 'A list of filter values.',
'type' => 'array',
'items' => ['description' => 'The filter values. You can specify up to 10 values.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18AD0960-A9FE-1AC8-ADF8-22131Fxxxxxx'],
'NextToken' => ['title' => 'NextToken', 'description' => 'A pagination token. It is returned when the results are not complete. To retrieve the next page of results, include this token in the NextToken parameter of the next request.', 'type' => 'string', 'example' => 'AAAAAYChudnQUoBH+mGWFpb6oP0='],
'MaxResults' => ['description' => 'The number of entries returned on each page. The maximum value is 100. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ServiceUsages' => [
'description' => 'The service usage details.',
'type' => 'array',
'items' => [
'description' => 'The service usage details.',
'type' => 'object',
'properties' => [
'UserAliUid' => ['description' => 'The Alibaba Cloud account ID of the user.', 'type' => 'integer', 'format' => 'int64', 'example' => '127383705958xxxx', 'title' => ''],
'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'service-c9f36ec6d19b4exxxxxx', 'title' => ''],
'ServiceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Deployment link permission request', 'title' => ''],
'SupplierName' => ['description' => 'The name of the supplier.', 'type' => 'string', 'example' => 'Acceptance test', 'title' => ''],
'Status' => ['description' => 'The service status. Valid values:'."\n"
."\n"
.'- Submitted: The request is submitted and pending approval.'."\n"
."\n"
.'- Approved: The request is approved.'."\n"
."\n"
.'- Rejected: The request is rejected.'."\n"
."\n"
.'- Canceled: The request is canceled.', 'type' => 'string', 'example' => 'Submitted', 'title' => ''],
'Comments' => ['description' => 'The remarks of the approval.', 'type' => 'string', 'example' => 'Review approved.', 'title' => ''],
'CreateTime' => ['description' => 'The time when the request was created.', 'type' => 'string', 'example' => '2022-05-25T02:02:02Z', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the request was last updated.', 'type' => 'string', 'example' => '2022-05-25T02:02:02Z', 'title' => ''],
'UserInformation' => [
'description' => 'The user information.',
'type' => 'object',
'additionalProperties' => ['description' => 'The user information.', 'type' => 'string', 'example' => '{'."\n"
.' "ServiceId": "xxx",'."\n"
.' "EmailAddress": "邮箱",'."\n"
.' "Company": "公司",'."\n"
.' "Country": "国家",'."\n"
.' "Telephone": "申请人的电话号码",'."\n"
.' "Name": "申请人名字",'."\n"
.' "Title": "申请人的职位",'."\n"
.' "Industry": "行业"'."\n"
.'}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'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\\": \\"Deployment link permission request\\",\\n \\"SupplierName\\": \\"Acceptance test\\",\\n \\"Status\\": \\"Submitted\\",\\n \\"Comments\\": \\"Review approved.\\",\\n \\"CreateTime\\": \\"2022-05-25T02:02:02Z\\",\\n \\"UpdateTime\\": \\"2022-05-25T02:02:02Z\\",\\n \\"UserInformation\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"ServiceId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"EmailAddress\\\\\\": \\\\\\"邮箱\\\\\\",\\\\n \\\\\\"Company\\\\\\": \\\\\\"公司\\\\\\",\\\\n \\\\\\"Country\\\\\\": \\\\\\"国家\\\\\\",\\\\n \\\\\\"Telephone\\\\\\": \\\\\\"申请人的电话号码\\\\\\",\\\\n \\\\\\"Name\\\\\\": \\\\\\"申请人名字\\\\\\",\\\\n \\\\\\"Title\\\\\\": \\\\\\"申请人的职位\\\\\\",\\\\n \\\\\\"Industry\\\\\\": \\\\\\"行业\\\\\\"\\\\n}\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListServiceUsages',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceUsages'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListServiceUsages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'ListServices' => [
'summary' => 'Queries information about your services.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '118470',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. Set this to the NextToken value returned from the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'The filter values.',
'type' => 'array',
'items' => ['description' => 'The filter values. The value of N can be from 1 to 10.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'The filter name. You can specify one or more filter names to query services. Valid values:'."\n"
."\n"
.'- ServiceId: The service ID.'."\n"
."\n"
.'- Name: The service name.'."\n"
."\n"
.'- Status: The service status.'."\n"
."\n"
.'- SupplierName: The service provider name.', 'type' => 'string', 'required' => false, 'example' => 'Status', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
[
'name' => 'InUsed',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the service is in use. Valid values:'."\n"
."\n"
.'- false: The service is not in use.'."\n"
."\n"
.'- true: The service is in use.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The custom tags.',
'type' => 'array',
'items' => [
'description' => 'The custom tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 50,
'title' => '',
'example' => '',
],
],
[
'name' => 'FuzzyKeyword',
'in' => 'query',
'schema' => ['description' => 'The keyword for a fuzzy query.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''],
],
[
'name' => 'ServiceAccessType',
'in' => 'query',
'schema' => ['description' => 'The service access type.', 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''],
],
[
'name' => 'OrderByType',
'in' => 'query',
'schema' => ['description' => 'The sorting type for services.', 'type' => 'string', 'required' => false, 'example' => 'UpdateTime', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI41', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F976EF8-C10A-57DC-917C-BB7BEB508FFB', 'title' => ''],
'TotalCount' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries returned per page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'Services' => [
'description' => 'The list of services.',
'type' => 'array',
'items' => [
'description' => 'The list of services.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The service status. Valid values:'."\n"
."\n"
.'- Draft: The service is in the draft state.'."\n"
."\n"
.'- Submitted: The service is submitted for review. You cannot modify the service.'."\n"
."\n"
.'- Approved: The service is approved. You cannot modify the service, but you can publish it.'."\n"
."\n"
.'- Launching: The service is being published.'."\n"
."\n"
.'- Online: The service is published.'."\n"
."\n"
.'- Offline: The service is unpublished.', 'type' => 'string', 'example' => 'Online', 'title' => ''],
'PublishTime' => ['description' => 'The time when the service was published.', 'type' => 'string', 'example' => '2022-01-21T10:35:44Z', 'title' => ''],
'Version' => ['description' => 'The service version.', 'type' => 'string', 'example' => '4', 'title' => ''],
'DeployType' => ['description' => 'The deployment type. Valid values:'."\n"
."\n"
.'- ros: The service is deployed using ROS.'."\n"
."\n"
.'- terraform: The service is deployed using Terraform.'."\n"
."\n"
.'- spi: The service is deployed by calling SPI.', 'type' => 'string', 'example' => 'ros', 'title' => ''],
'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'service-6b5d632edd394dxxxxxx', 'title' => ''],
'SupplierUrl' => ['description' => 'The service provider\'s URL.', 'type' => 'string', 'example' => 'http://example.com', 'title' => ''],
'ServiceType' => ['description' => 'The service type. Valid values:'."\n"
."\n"
.'- private: The service is deployed in the user\'s account.'."\n"
."\n"
.'- managed: The service is hosted in the service provider\'s account.'."\n"
."\n"
.'- operation: The service is an Alibaba Cloud Managed Service.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'SupplierName' => ['description' => 'The service provider name.', 'type' => 'string', 'example' => 'Company A Ltd.', 'title' => ''],
'ServiceInfos' => [
'description' => 'The service information.',
'type' => 'array',
'items' => [
'description' => 'The service information.',
'type' => 'object',
'properties' => [
'Locale' => ['description' => 'The language of the service configuration. Valid values:'."\n"
."\n"
.'- zh-CN: Chinese.'."\n"
."\n"
.'- en-US: English.', 'type' => 'string', 'example' => 'zh-CN', 'title' => ''],
'Image' => ['description' => 'The URL of the service icon.', 'type' => 'string', 'example' => 'http://img.tidb.oss.url', 'title' => ''],
'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Database B', 'title' => ''],
'ShortDescription' => ['description' => 'The service overview.', 'type' => 'string', 'example' => 'B is an open-source distributed relational database independently designed and developed by Company A.', 'title' => ''],
'Softwares' => [
'description' => 'The software information of the service.',
'type' => 'array',
'items' => [
'description' => 'The software information of the service.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The software name.', 'type' => 'string', 'example' => 'wordpress', 'title' => ''],
'Version' => ['description' => 'The software version.', 'type' => 'string', 'example' => '6.0.1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'CommodityCode' => ['description' => 'The commodity code of the service in Alibaba Cloud Marketplace.', 'type' => 'string', 'example' => 'cmjj00xxxx', 'title' => ''],
'ServiceProductUrl' => ['description' => 'The URL of the product page.', 'type' => 'string', 'example' => 'http://example1.com', 'title' => ''],
'Categories' => ['description' => 'The category of the data disk. Valid values:'."\n"
."\n"
.'- cloud\\_efficiency: ultra disk.'."\n"
."\n"
.'- cloud\\_ssd: standard SSD.'."\n"
."\n"
.'- cloud\\_essd: ESSD.'."\n"
."\n"
.'- cloud: basic disk.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''],
'VersionName' => ['description' => 'The custom version name defined by the service provider.', 'type' => 'string', 'example' => 'v2.0.0', 'title' => ''],
'DeployFrom' => ['description' => 'The deployment source of the service. Valid values:'."\n"
."\n"
.'- NoWhere: The service has no deployment source.'."\n"
."\n"
.'- Marketplace: The service is deployed from Alibaba Cloud Marketplace.'."\n"
."\n"
.'- ComputeNest: The service is deployed from Compute Nest.', 'type' => 'string', 'example' => 'ComputeNest', 'title' => ''],
'Score' => ['description' => 'The service score.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'Tags' => [
'description' => 'The service tags.',
'type' => 'array',
'items' => [
'description' => 'The service tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TrialDuration' => ['description' => 'The trial duration. Unit: days. The maximum trial duration is 30 days.', 'type' => 'string', 'example' => '7', 'title' => ''],
'TrialType' => ['description' => 'The trial type. Valid values:'."\n"
."\n"
.'- Trial: The service supports trial.'."\n"
."\n"
.'- NotTrial: The service does not support trial.', 'type' => 'string', 'example' => 'Trial', 'title' => ''],
'TenantType' => ['description' => 'The tenant type. Valid values:'."\n"
."\n"
.'- SingleTenant: single-tenant.'."\n"
."\n"
.'- MultiTenant: multi-tenant.', 'type' => 'string', 'example' => 'SingleTenant', 'title' => ''],
'VirtualInternetService' => ['description' => 'Indicates whether the service is a virtual Internet service. Valid values:'."\n"
."\n"
.'- false: No.'."\n"
."\n"
.'- true: Yes.', 'type' => 'string', 'example' => 'false', 'title' => ''],
'SupplierUid' => ['description' => 'The Alibaba Cloud account ID of the service provider.', 'type' => 'integer', 'format' => 'int64', 'example' => '1436322xxxxx', 'title' => ''],
'Commodity' => [
'description' => 'The commodity specifications.',
'type' => 'object',
'properties' => [
'DeployPage' => ['description' => 'The deployment page.', 'type' => 'string', 'example' => 'Order: Order page'."\n"
.'Detail: Details page', 'title' => ''],
'CommodityCode' => ['description' => 'The commodity specification code.', 'type' => 'string', 'example' => 'cmjj00****'."\n"
."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'SupplierNameEng' => ['description' => 'The English name of the service provider.', 'type' => 'string', 'example' => 'Alibaba Cloud', 'title' => ''],
'ServiceLocaleConfigs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OriginalValue' => ['description' => 'The raw data value of the business information.', 'type' => 'string', 'example' => 'Service Name'."\n", 'title' => ''],
'ZhValue' => ['description' => 'The Chinese value of the business information.', 'type' => 'string', 'example' => '服务名称', 'title' => ''],
'EnValue' => ['description' => 'The English value of the business information.', 'type' => 'string', 'example' => 'Service Name'."\n", 'title' => ''],
],
'description' => 'The multi-language configurations of the service.',
'title' => '',
'example' => '',
],
'description' => 'The multi-language configurations of the service.',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAfu+XtuBE55iRLHEYYuojI41\\",\\n \\"RequestId\\": \\"3F976EF8-C10A-57DC-917C-BB7BEB508FFB\\",\\n \\"TotalCount\\": 1,\\n \\"MaxResults\\": 20,\\n \\"Services\\": [\\n {\\n \\"Status\\": \\"Online\\",\\n \\"PublishTime\\": \\"2022-01-21T10:35:44Z\\",\\n \\"Version\\": \\"4\\",\\n \\"DeployType\\": \\"ros\\",\\n \\"ServiceId\\": \\"service-6b5d632edd394dxxxxxx\\",\\n \\"SupplierUrl\\": \\"http://example.com\\",\\n \\"ServiceType\\": \\"private\\",\\n \\"SupplierName\\": \\"Company A Ltd.\\",\\n \\"ServiceInfos\\": [\\n {\\n \\"Locale\\": \\"zh-CN\\",\\n \\"Image\\": \\"http://img.tidb.oss.url\\",\\n \\"Name\\": \\"Database B\\",\\n \\"ShortDescription\\": \\"B is an open-source distributed relational database independently designed and developed by Company A.\\",\\n \\"Softwares\\": [\\n {\\n \\"Name\\": \\"wordpress\\",\\n \\"Version\\": \\"6.0.1\\"\\n }\\n ]\\n }\\n ],\\n \\"CommodityCode\\": \\"cmjj00xxxx\\",\\n \\"ServiceProductUrl\\": \\"http://example1.com\\",\\n \\"Categories\\": \\"cloud_ssd\\",\\n \\"VersionName\\": \\"v2.0.0\\",\\n \\"DeployFrom\\": \\"ComputeNest\\",\\n \\"Score\\": 5,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"TrialDuration\\": \\"7\\",\\n \\"TrialType\\": \\"Trial\\",\\n \\"TenantType\\": \\"SingleTenant\\",\\n \\"VirtualInternetService\\": \\"false\\",\\n \\"SupplierUid\\": 0,\\n \\"Commodity\\": {\\n \\"DeployPage\\": \\"Order: Order page\\\\nDetail: Details page\\",\\n \\"CommodityCode\\": \\"cmjj00****\\\\n\\\\n\\"\\n },\\n \\"SupplierNameEng\\": \\"Alibaba Cloud\\",\\n \\"ServiceLocaleConfigs\\": [\\n {\\n \\"OriginalValue\\": \\"Service Name\\\\n\\",\\n \\"ZhValue\\": \\"服务名称\\",\\n \\"EnValue\\": \\"Service Name\\\\n\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListServices',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServices',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'ListSkillFiles' => [
'summary' => 'Retrieves the list of skill files.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SkillId',
'in' => 'query',
'schema' => ['description' => 'Skill ID', 'type' => 'string', 'required' => true, 'example' => 's-xxxxx', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'The list of filter values. Valid values of N: 1 to 10.',
'type' => 'array',
'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'No supported filter names are available.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38=', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page in a paging query. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'default' => '10', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2849EE73-AFFA-5AFD-9575-12FA886451DA'],
'NextToken' => ['title' => '', 'description' => 'The pagination token for the next page.', 'type' => 'string', 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU='],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['title' => '', 'description' => 'The actual number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SkillFiles' => [
'title' => '',
'description' => 'The list of skill files.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FilePath' => ['title' => '', 'description' => 'The relative path of the internal file in the skill.', 'type' => 'string', 'example' => 'SKILL.md'],
'SignedUrl' => ['title' => '', 'description' => 'The accessible OSS URL.', 'type' => 'string', 'example' => 'https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/SKILL.md'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Retrieve skill file list',
'description' => '### Before you begin'."\n"
.'Make sure the service provider has enabled the specification change feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListSkillFiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2849EE73-AFFA-5AFD-9575-12FA886451DA\\",\\n \\"NextToken\\": \\"AAAAAWns8w4MmhzeptXVRG0PUEU=\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 1,\\n \\"SkillFiles\\": [\\n {\\n \\"FilePath\\": \\"SKILL.md\\",\\n \\"SignedUrl\\": \\"https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/SKILL.md\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListSkillSpaces' => [
'summary' => 'Queries a list of SkillSpaces.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'The list of filter values. Valid values of N: 1 to 10.',
'type' => 'array',
'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => 'ss-xxxx', 'title' => ''],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'The filter name. You can specify one or more names for the query. Valid values:'."\n"
."\n"
.'- SkillSpaceId: the SkillSpace ID. Exact match.'."\n"
."\n"
.'- SkillSpaceName: the SkillSpace name.'."\n"
."\n"
.'- MatchType: the match type that controls the matching behavior of SkillSpace. Valid values: exact, prefix, and fuzzy.', 'type' => 'string', 'required' => false, 'example' => 'SkillSpaceId', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token. Set this parameter to the value of NextToken that was returned in the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'BBBAAfu+XtuBE55iRLHEYYuojI4=', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page in a paging query. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'default' => '10', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
'NextToken' => ['title' => '', 'description' => 'The token for the next page.', 'type' => 'string', 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU='],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SkillSpaces' => [
'title' => '',
'description' => 'The list of SkillSpaces.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillSpaceId' => ['title' => '', 'description' => 'SkillSpace ID', 'type' => 'string', 'example' => 'ss-xxxxx'],
'SkillSpaceName' => ['title' => '', 'description' => 'The name of the SkillSpace.', 'type' => 'string', 'example' => 'office-toolkit-skills'],
'SkillSpaceDescription' => ['title' => '', 'description' => 'The description of the SkillSpace.', 'type' => 'string', 'example' => 'All-in-one office toolkit — generate reports, process data, manage files, and streamline workflows effortlessly.'],
'CreateTime' => ['title' => '', 'description' => 'The time when the SkillSpace was created.', 'type' => 'string', 'example' => '2025-11-03T22:58:52Z'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the SkillSpace was last updated.', 'type' => 'string', 'example' => '2025-11-03T22:57:29Z'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => 'Query skillSpace list',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the specification change feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListSkillSpaces',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"NextToken\\": \\"AAAAAWns8w4MmhzeptXVRG0PUEU=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 1,\\n \\"SkillSpaces\\": [\\n {\\n \\"SkillSpaceId\\": \\"ss-xxxxx\\",\\n \\"SkillSpaceName\\": \\"office-toolkit-skills\\",\\n \\"SkillSpaceDescription\\": \\"All-in-one office toolkit — generate reports, process data, manage files, and streamline workflows effortlessly.\\",\\n \\"CreateTime\\": \\"2025-11-03T22:58:52Z\\",\\n \\"UpdateTime\\": \\"2025-11-03T22:57:29Z\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListSkills' => [
'summary' => 'Queries a list of skills.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Filter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter.',
'type' => 'array',
'items' => [
'description' => 'The filter.',
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'The list of filter values. Valid values of N: 1 to 10.',
'type' => 'array',
'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => 's-xxxxx', 'title' => ''],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
'Name' => ['description' => 'The filter name. You can specify one or more names for the query. Valid values:'."\n"
."\n"
.'- SkillId: the skill ID. Exact match.'."\n"
."\n"
.'- SkillSpaceId: the SkillSpace ID. Exact match.'."\n"
."\n"
.'- SkillName: the skill name.'."\n"
."\n"
.'- MatchType: the match type that controls how SkillName is matched. Valid values: exact, prefix, and fuzzy.'."\n"
."\n"
.'- SkillType: the skill type. Valid values: official and custom.'."\n"
."\n"
.'- Keyword: keyword match for the skill name or skill description. Fuzzy match.'."\n"
."\n"
.'- SkillLabels: the skill labels. Fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'SkillId', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'NextToken', 'type' => 'string', 'required' => false, 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU=', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return in this request.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'default' => '10', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NeedDownloadUrl',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to include the download URL of the skill package.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
'NextToken' => ['title' => '', 'description' => 'The token for the next page.', 'type' => 'string', 'example' => 'AAAAAWns8w4MmhzeptXVRG0PUEU='],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Skills' => [
'title' => '',
'description' => 'The list of skills.',
'type' => 'array',
'items' => [
'description' => 'The skill details.',
'type' => 'object',
'properties' => [
'SkillId' => ['title' => '', 'description' => 'Skill ID', 'type' => 'string', 'example' => 's-xxxxx'],
'SkillName' => ['title' => '', 'description' => 'The skill name.', 'type' => 'string', 'example' => 'skill-creator'],
'SkillDisplayName' => ['title' => '', 'description' => 'The skill display name.', 'type' => 'string', 'example' => ''],
'SkillDescription' => ['title' => '', 'description' => 'The skill description.', 'type' => 'string', 'example' => 'Create new skills, modify and improve existing skills, and measure skill performance. '],
'Locales' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OriginalValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ZhValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EnValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'SkillLabels' => [
'description' => 'The set of skill labels.',
'type' => 'array',
'items' => ['description' => 'The skill label.', 'type' => 'string', 'example' => 'category:frontend-development', 'title' => ''],
'title' => '',
'example' => '',
],
'SkillSpaceId' => ['title' => '', 'description' => 'The ID of the SkillSpace to which the skill belongs.', 'type' => 'string', 'example' => 'ss-xxxxx'],
'CreateTime' => ['title' => '', 'description' => 'The time when the skill was created.', 'type' => 'string', 'example' => '2026-05-10T02:22:18Z'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the skill was last updated.', 'type' => 'string', 'example' => '2025-11-03T22:58:52Z'],
'DownloadUrl' => ['description' => 'The download URL of the skill package.', 'type' => 'string', 'example' => 'https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/skill-creator.zip', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Query skill list',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the specification change feature and completed the specification change parameter settings when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListSkills',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"NextToken\\": \\"AAAAAWns8w4MmhzeptXVRG0PUEU=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Skills\\": [\\n {\\n \\"SkillId\\": \\"s-xxxxx\\",\\n \\"SkillName\\": \\"skill-creator\\",\\n \\"SkillDisplayName\\": \\"\\",\\n \\"SkillDescription\\": \\"Create new skills, modify and improve existing skills, and measure skill performance. \\",\\n \\"Locales\\": [\\n {\\n \\"OriginalValue\\": \\"\\",\\n \\"ZhValue\\": \\"\\",\\n \\"EnValue\\": \\"\\"\\n }\\n ],\\n \\"SkillLabels\\": [\\n \\"category:frontend-development\\"\\n ],\\n \\"SkillSpaceId\\": \\"ss-xxxxx\\",\\n \\"CreateTime\\": \\"2026-05-10T02:22:18Z\\",\\n \\"UpdateTime\\": \\"2025-11-03T22:58:52Z\\",\\n \\"DownloadUrl\\": \\"https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/skill-creator.zip\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListTagKeys' => [
'summary' => 'This operation lists existing tag keys.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117094',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token to start the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4='],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- service: service.'."\n"
."\n"
.'- serviceinstance: service instance.'."\n"
."\n"
.'- artifact: artifact.'."\n"
."\n"
.'- dataset: dataset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'service'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token to start the next query.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAZ9FmxgN6wKfeK/GOKRnnjU='],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '8872ACE6-0297-54A4-8AAD-3A8623EC6C5D'],
'Keys' => [
'description' => 'A list of tag keys.',
'type' => 'array',
'items' => ['description' => 'A list of tag keys.', 'type' => 'string', 'title' => '', 'example' => ' ['."\n"
.' 0 : "lzqtest-huhehaote"'."\n"
.' 1 : "lzqros"'."\n"
.' 2 : "aaa"'."\n"
.']'],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListTagKeys',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagKeys'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListTagKeys',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAZ9FmxgN6wKfeK/GOKRnnjU=\\",\\n \\"RequestId\\": \\"8872ACE6-0297-54A4-8AAD-3A8623EC6C5D\\",\\n \\"Keys\\": [\\n \\" [\\\\n 0 : \\\\\\"lzqtest-huhehaote\\\\\\"\\\\n 1 : \\\\\\"lzqros\\\\\\"\\\\n 2 : \\\\\\"aaa\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]',
],
'ListTagResources' => [
'summary' => 'Queries a list of tagged resources.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117188',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token to retrieve the next page of results. Set this parameter to the \\`NextToken\\` value from the previous API call.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AAAAAfu+XtuBE55iRLHEYYuojI4='],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- service: a service.'."\n"
."\n"
.'- serviceinstance: a service instance.'."\n"
."\n"
.'- artifact: an artifact.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'service'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'A list of tags.',
'type' => 'array',
'items' => [
'description' => 'A list of tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1'],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'value1'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource IDs. You can specify up to 50 resource IDs.',
'type' => 'array',
'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'si-5dc794a7fd254e******'],
'required' => false,
'maxItems' => 50,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38='],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
'TagResources' => [
'description' => 'A collection of resources and their tags. This collection includes information such as resource IDs, resource types, and tag key-value pairs.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceType' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- service: a service.'."\n"
."\n"
.'- serviceinstance: a service instance.'."\n"
."\n"
.'- artifact: an artifact.'."\n"
."\n"
.'- dataset: a dataset.', 'type' => 'string', 'title' => '', 'example' => 'serviceinstance'],
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 'si-44b9923be2d048eb8f5f'],
'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'test'],
'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'major'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAVz7BQqj2xtiNSC3d3RAD38=\\",\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"serviceinstance\\",\\n \\"ResourceId\\": \\"si-44b9923be2d048eb8f5f\\",\\n \\"TagKey\\": \\"test\\",\\n \\"TagValue\\": \\"major\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListTagResources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListTagValues' => [
'summary' => 'Lists the tag values for a specified tag key.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117166',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AAAAAfmTH5rcd4YFfob4P0uDAAc='],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- service: service.'."\n"
."\n"
.'- serviceinstance: service instance.'."\n"
."\n"
.'- artifact: deployment.'."\n"
."\n"
.'- dataset: dataset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'service'],
],
[
'name' => 'Key',
'in' => 'query',
'schema' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ECS'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAVz7BQqj2xtiNSC3d3RAD38='],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0631D623-D917-1C2D-ACD6-5B3B19XXXXXX'],
'Values' => [
'description' => 'The information about the tag values.',
'type' => 'array',
'items' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => ' ['."\n"
.' 0 : "20211220"'."\n"
.']'],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListTagValues',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagValues'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListTagValues',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAVz7BQqj2xtiNSC3d3RAD38=\\",\\n \\"RequestId\\": \\"0631D623-D917-1C2D-ACD6-5B3B19XXXXXX\\",\\n \\"Values\\": [\\n \\" [\\\\n 0 : \\\\\\"20211220\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]',
],
'RenewServiceInstance' => [
'summary' => 'Renews a service instance.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '36939',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run of the renewal request, including permission and instance status checks. Valid values:'."\n"
."\n"
.'- **true**: Sends the request without renewing the service instance.'."\n"
."\n"
.'- **false**: Sends the request and renews the service instance after the checks pass.'."\n"
."\n"
.'Default value: false. The operation is allowed only when the service instance is in the Pending Renewal or Renewal Failed state.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => false, 'example' => 'si-70a3b15bb626435b****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB58FE53-ED8F-5D12-9746-CD3A5F463D95', 'title' => ''],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'RenewServiceInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB58FE53-ED8F-5D12-9746-CD3A5F463D95\\"\\n}","type":"json"}]',
],
'RenewServiceInstanceResources' => [
'summary' => 'Renews the subscription resources for a private deployment service instance. This operation supports two renewal methods: renewing all subscription resources for a service instance or renewing only specific resources. You can use only one method per request.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136231',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-b58c874912fc4294****'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => ['description' => 'The time unit of the renewal duration for all subscription resources in the service instance. This parameter specifies the unit for \\`Period\\`. Valid values: \\`Month\\` and \\`Year\\`. Default value: \\`Month\\`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Month'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure that the request is idempotent. Generate a unique value for this parameter from your client for each request. The token can contain only ASCII characters and must not exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => 'The renewal duration for all subscription resources in the service instance. The unit is specified by \\`PeriodUnit\\`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'],
],
[
'name' => 'ResourcePeriod',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resource renewals.',
'type' => 'array',
'items' => [
'description' => 'The resource renewal configuration.',
'type' => 'object',
'properties' => [
'ResourceArn' => ['description' => 'The Aliyun Resource Name (ARN) of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2'],
'PeriodUnit' => ['description' => 'The time unit of the renewal duration for the resource. This parameter specifies the unit for \\`Period\\`. Valid values: \\`Month\\` and \\`Year\\`. Default value: \\`Month\\`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Month'],
'Period' => ['description' => 'The renewal duration for the resource. The unit is specified by \\`PeriodUnit\\`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 1000,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
'RenewalResult' => [
'description' => 'The renewal result.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The number of resources to be renewed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'],
'Succeeded' => ['description' => 'The number of successfully renewed resources.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '9'],
'Failed' => ['description' => 'The number of resources that failed to be renewed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
],
'title' => '',
'example' => '',
],
'FailureDetails' => [
'description' => 'The details of renewal failures.',
'type' => 'array',
'items' => [
'description' => 'The details of a renewal failure.',
'type' => 'object',
'properties' => [
'ResourceArn' => ['description' => 'The ARN of the resource.', 'type' => 'string', 'title' => '', 'example' => 'acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2'],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Renewal failure reason.'],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'InvalidPeriod'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\",\\n \\"RenewalResult\\": {\\n \\"TotalCount\\": 10,\\n \\"Succeeded\\": 9,\\n \\"Failed\\": 1\\n },\\n \\"FailureDetails\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2\\",\\n \\"ErrorMessage\\": \\"Renewal failure reason.\\",\\n \\"ErrorCode\\": \\"InvalidPeriod\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'RenewServiceInstanceResources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewServiceInstanceResources'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:RenewServiceInstanceResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#AccountId}:serviceinstance/{#serviceInstanceId}'],
],
],
],
],
'translator' => 'manual',
],
'RestartServiceInstance' => [
'summary' => 'Restarts a service instance in the Deployed state.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213219',
'abilityTreeNodes' => ['FEATUREcomputenestVIKWP9'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. The token must be unique for each request. The token can contain only ASCII characters and cannot be longer than 64 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-42665544****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the service instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.'."\n"
."\n"
.'Call the [ListServiceInstances](~~396200~~) operation to obtain the service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-d6ab3a63ccbb4b17****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\"\\n}","type":"json"}]',
'title' => 'RestartServiceInstance',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider enabled the restart O\\&M operation when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:RestartServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
],
],
'RollbackServiceInstance' => [
'summary' => 'Rolls back an upgraded service instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '144097',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'si-d6ab3a63ccbb4bxxxxxx'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure request idempotence. Generate a unique value for this parameter from your client. **ClientToken** supports only ASCII characters and cannot be more than 64 characters long.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
'title' => 'RollbackServiceInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RollbackServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:RollbackServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
],
'StartServiceInstance' => [
'summary' => 'Call the StartServiceInstance operation to start a service instance that is in the Stopped or StartFailed state.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213207',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value on your client. This value can contain only ASCII characters and must be no more than 64 characters long.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-42665544****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the service instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.'."\n"
."\n"
.'Call the [ListServiceInstances](~~396200~~) operation to obtain the service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-d6ab3a63ccbb4b17****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '464C8CB6-A548-5206-B83C-D32A8E43EC21'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464C8CB6-A548-5206-B83C-D32A8E43EC21\\"\\n}","type":"json"}]',
'title' => 'StartServiceInstance',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider configured the start and stop O\\&M actions when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:StartServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
],
],
'StopServiceInstance' => [
'summary' => 'Call the StopServiceInstance operation to shut down a service instance that is in the Deployed or StopFailed state.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213173',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique token for each request. The token can contain only ASCII characters and cannot be longer than 64 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-42665544****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the service instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.'."\n"
."\n"
.'Call the [ListServiceInstances](~~396200~~) operation to obtain the service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-b58c874912fc4294****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
'title' => 'StopServiceInstance',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider configured the Operations and Maintenance (O\\&M) operations for startup and shutdown when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:StopServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
],
],
'TagResources' => [
'summary' => 'You can call TagResources to create and attach tags to multiple resources.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117177',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource tags.',
'type' => 'array',
'items' => [
'description' => 'The resource tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Key1'],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Value1'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- service: a service.'."\n"
."\n"
.'- serviceinstance: a service instance.'."\n"
."\n"
.'- artifact: a deployment.'."\n"
."\n"
.'- dataset: a dataset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'service'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource IDs.',
'type' => 'array',
'items' => ['description' => 'The resource ID. A maximum of 50 resource IDs can be specified.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'r-xxx'],
'required' => true,
'maxItems' => 50,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\"\\n}","type":"json"}]',
'title' => 'TagResources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
],
'UnTagResources' => [
'summary' => 'Detaches tags from specified resources.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117186',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- service: A service.'."\n"
."\n"
.'- serviceinstance: A service instance.'."\n"
."\n"
.'- artifact: An artifact.'."\n"
."\n"
.'- dataset: A dataset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'service'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource IDs.',
'type' => 'array',
'items' => ['description' => 'The resource ID. A maximum of 50 resource IDs can be specified.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'r-xxx'],
'required' => true,
'maxItems' => 50,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to remove all tags from the resources. This parameter is valid only when \\`TagKey\\` is not specified. The default value is false. Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tag keys of the resources.',
'type' => 'array',
'items' => ['description' => 'The tag key of the resource.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Key1'],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\"\\n}","type":"json"}]',
'title' => 'UnTagResources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnTagResources'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:UnTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
],
],
'UpdateServiceInstanceAttributes' => [
'summary' => 'Updates the attributes of a service instance.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '226389',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.'."\n"
."\n"
.'Call the [ListServiceInstances](~~396200~~) operation to obtain the service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-d6ab3a63ccbb4b17xxxx'],
],
[
'name' => 'EnableOperation',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable managed O\\&M.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
'name' => 'GrantedPermission',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'OperationEndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'PolicyNames' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\"\\n}","type":"json"}]',
'title' => 'UpdateServiceInstanceAttributes',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceInstanceAttributes'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateServiceInstanceAttributes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
],
'UpdateServiceInstanceSpec' => [
'summary' => 'You can call the UpdateServiceInstanceSpec operation to upgrade or downgrade a service instance if its parameters or package settings do not meet your requirements.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '161941',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the service instance.'."\n"
."\n"
.'Call the [ListServiceInstances](~~396200~~) operation to obtain the service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'si-d6ab3a63ccbb4b17****'],
],
[
'name' => 'PredefinedParametersName',
'in' => 'query',
'schema' => ['description' => 'The name of the service instance package.'."\n"
."\n"
.'Set this parameter if the service provider set **Change Type** to **Package Change** for the upgrade/downgrade operation.'."\n"
."\n"
.'To obtain the package name, check the **PredefinedParameters** property of the **DeployMetadata** parameter that is returned by the [GetService](~~2340828~~) operation.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Package 1'],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The parameters for changing the service instance.'."\n"
."\n"
.'Set this parameter if the service provider set **Change Type** to **Parameter Change** for the upgrade/downgrade operation.'."\n"
."\n"
.'> - To obtain the change parameters, check the **ModifyParametersConfig** property of the **OperationMetadata** parameter that is returned by the [GetService](~~2340828~~) operation.'."\n"
.'>'."\n"
.'> - View the change parameters on the **Service Instance Change** page in the [Compute Nest console](https://computenest.console.aliyun.com/service/instance/cn-hangzhou).'."\n"
."\n"
.'For example, if the service is configured to upgrade the ECS instance type, enter an instance specification that is higher than the current one.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{'."\n"
.' "InstanceType": "ecs.g8ise.2xlarge"'."\n"
.'}'],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run for the request. A dry run checks for issues such as permissions and instance status.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true: Sends the request to perform a dry run. The service instance is not modified.'."\n"
."\n"
.'- false: Sends the request to perform the operation. The service instance is modified after the request passes the checks.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
'name' => 'EnableUserPrometheus',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable Prometheus monitoring.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'true: Enables Prometheus monitoring.'."\n"
."\n"
.'false: Disables Prometheus monitoring.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
'name' => 'OperationName',
'in' => 'query',
'schema' => ['description' => 'The name of the upgrade/downgrade operation.'."\n"
."\n"
.'To obtain the name and content of the upgrade/downgrade operation, check the **ModifyParametersConfig** property of the **OperationMetadata** parameter that is returned by the [GetService](~~2340828~~) operation.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Plan configuration change'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. This token is generated by your client and must be unique for each request. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-42665544****'],
],
[
'name' => 'Commodity',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The information about the Alibaba Cloud Marketplace purchase order. This parameter is not required if the service is not listed on Alibaba Cloud Marketplace or if the service uses the pay-as-you-go billing method.',
'type' => 'object',
'properties' => [
'AutoPay' => ['description' => 'Specifies whether to enable automatic payment.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- **true** (default): Automatic payment is enabled. Make sure that your account has a sufficient balance.'."\n"
."\n"
.'- **false**: An order is generated but the payment is not completed. If your account balance is insufficient, set AutoPay to false to generate an unpaid order. You can then log on to the [ApsaraDB RDS console](https://rdsnext.console.aliyun.com/dashboard/cn-beijing) to pay for the order.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06BF8F22-02DC-4750-83DF-3FFC11C065EA'],
'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => '23396265896****'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06BF8F22-02DC-4750-83DF-3FFC11C065EA\\",\\n \\"OrderId\\": \\"23396265896****\\"\\n}","type":"json"}]',
'title' => 'UpdateServiceInstanceSpec',
'description' => '### Prerequisites'."\n"
."\n"
.'Ensure that the service provider has enabled the upgrade/downgrade feature and configured the related parameters when the service was created.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceInstanceSpec'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateServiceInstanceSpec',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:*:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
'translator' => 'manual',
],
'UpdateServiceUsage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '137525',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'service-39f4f251e94843xxxxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. **ClientToken** supports only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAYChudnQUoBH+mGWFpb6oP0=', 'title' => ''],
],
[
'name' => 'UserInformation',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The user information.',
'type' => 'object',
'required' => false,
'additionalProperties' => ['description' => 'The user information.', 'type' => 'string', 'example' => '{'."\n"
.' "ServiceId": "xxx",'."\n"
.' "EmailAddress": "邮箱",'."\n"
.' "Company": "公司",'."\n"
.' "Country": "国家",'."\n"
.' "Telephone": "申请人的电话号码",'."\n"
.' "Name": "申请人名字",'."\n"
.' "Title": "申请人的职位",'."\n"
.' "Industry": "行业"'."\n"
.'}', 'title' => ''],
'title' => '',
'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateServiceUsage',
'summary' => 'Updates the information about a service usage request.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceUsage'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateServiceUsage',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:*:{#accountId}:service/{#serviceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\"\\n}","type":"json"}]',
],
'UpdateSkill' => [
'summary' => 'Updates a skill.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232490',
'abilityTreeNodes' => ['FEATUREcomputenest4KI7CZ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SkillId',
'in' => 'query',
'schema' => ['description' => 'The ID of the skill to update.', 'type' => 'string', 'required' => true, 'example' => 's-xxxxx', 'title' => ''],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => ['description' => 'The source type for updating the skill.', 'type' => 'string', 'required' => false, 'example' => 'COPY', 'title' => ''],
],
[
'name' => 'SourceSkillId',
'in' => 'query',
'schema' => ['description' => 'Required when SourceType is set to COPY. The ID of the public skill.', 'type' => 'string', 'required' => false, 'example' => 's-xxxxx', 'title' => ''],
],
[
'name' => 'OssUrl',
'in' => 'query',
'schema' => ['description' => 'Required when SourceType is set to UPLOAD. The OSS URL of the skill package to upload.', 'type' => 'string', 'required' => false, 'example' => 'https://embedding-pic.oss-cn-beijing-internal.aliyuncs.com/skill-creator1.zip', 'title' => ''],
],
[
'name' => 'SkillDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the skill.', 'type' => 'string', 'required' => false, 'example' => 'Create new skills. ', 'title' => ''],
],
[
'name' => 'SkillName',
'in' => 'query',
'schema' => ['description' => 'The name of the skill.', 'type' => 'string', 'required' => false, 'example' => 'skill-creator', 'title' => ''],
],
[
'name' => 'SkillDisplayName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SkillLabels',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The labels of the skill.',
'type' => 'array',
'items' => ['description' => 'The label of the skill.', 'type' => 'string', 'required' => false, 'example' => 'category:frontend-development', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '13FE89A5-C036-56BF-A0FF-A31C59819FD7'],
],
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidSkill.NotFound', 'errorMessage' => 'The specified Skill does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Update a skill',
'description' => '### Before you begin'."\n"
.'Make sure that the service provider has enabled the specification change feature and configured the specification change parameters when creating the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13FE89A5-C036-56BF-A0FF-A31C59819FD7\\"\\n}","type":"json"}]',
],
'UpdateUserInformation' => [
'summary' => 'The UpdateUserInformation operation updates user information.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136314',
'abilityTreeNodes' => ['FEATUREcomputenest18JMDW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'DeliverySettings',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The configurations to modify.',
'type' => 'object',
'properties' => [
'OssEnabled' => ['description' => 'Specifies whether to deliver data to Object Storage Service (OSS). Valid values:'."\n"
."\n"
.'- true: Delivery is enabled.'."\n"
."\n"
.'- false: Delivery is disabled.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"mybucket"'],
'OssPath' => ['description' => 'The OSS path.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"path1/path2/"'],
'OssExpirationDays' => ['description' => 'The number of days to retain screen recordings.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '7'],
'ActiontrailDeliveryToOssEnabled' => ['description' => 'Specifies whether to deliver ActionTrail events to OSS. Valid values:'."\n"
."\n"
.'- true: Delivery is enabled.'."\n"
."\n"
.'- false: Delivery is disabled.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '51945B04-6AA6-410D-93BA-236E0248B104'],
],
'example' => '',
],
],
],
'title' => 'UpdateUserInformation',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserInformation'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateUserInformation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'UserInfo', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:UserInfo'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51945B04-6AA6-410D-93BA-236E0248B104\\"\\n}","type":"json"}]',
],
'UpgradeServiceInstance' => [
'summary' => 'Upgrades a service instance to a new version.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '122810',
'abilityTreeNodes' => ['FEATUREcomputenestYPH9R9'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ServiceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The service instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'si-d6ab3a63ccbb4bxxxxxx'],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version to upgrade to.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '2'],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The parameters required for the upgrade. This is used when new parameters are added to the new service version.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{ \\"RegionId\\": \\"cn-hangzhou\\", \\"InstanceType\\": \\"ecs.g5.large\\"}'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The token must be unique for each request. It can contain only ASCII characters and must be no more than 64 characters long.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. A dry run checks for issues such as permissions and the instance status. Valid values:'."\n"
."\n"
.'- true: Sends the request without upgrading the service instance.'."\n"
."\n"
.'- false: Sends the request and upgrades the service instance after the check is passed.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D550C'],
'UpgradeRequiredParameters' => [
'description' => 'The new parameters required for the service upgrade. This parameter is returned only when DryRun is set to true. Include these parameters in the request when you perform the upgrade.',
'type' => 'array',
'items' => ['description' => 'The name of a parameter required for the upgrade.', 'type' => 'string', 'title' => '', 'example' => 'InstancePassword'],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D550C\\",\\n \\"UpgradeRequiredParameters\\": [\\n \\"InstancePassword\\"\\n ]\\n}","type":"json"}]',
'title' => 'UpgradeServiceInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeServiceInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpgradeServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
],
],
'ValidateServiceInstanceName' => [
'summary' => 'Validates the name of a service instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '204410',
'abilityTreeNodes' => ['FEATUREcomputenest2G0818', 'FEATUREcomputenest1Z49ZW', 'FEATUREcomputenest21Y74A'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'service-12xxxxxx', 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'query',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false],
],
[
'name' => 'ServiceInstanceName',
'in' => 'query',
'schema' => ['description' => 'The name of the service instance.', 'type' => 'string', 'required' => true, 'example' => 'testName', 'title' => ''],
],
[
'name' => 'IsTrial',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the service instance is a trial instance.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The name of the template. Specify this parameter if the service supports multiple templates.', 'type' => 'string', 'example' => 'Template 1', 'title' => '', 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique token for each request. The **ClientToken** supports only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4DB0F536-B3BE-4F0D-BD29-E83FB56D****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ValidateServiceInstanceName',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateServiceInstanceName'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ValidateServiceInstanceName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DB0F536-B3BE-4F0D-BD29-E83FB56D****\\"\\n}","type":"json"}]',
'translator' => 'manual',
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'computenest.cn-hangzhou.aliyuncs.com', 'endpoint' => 'computenest.cn-hangzhou.aliyuncs.com', 'vpc' => 'computenest-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'computenest.ap-southeast-1.aliyuncs.com', 'endpoint' => 'computenest.ap-southeast-1.aliyuncs.com', 'vpc' => 'computenest-vpc.ap-southeast-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'EntityNotExist.ResourceGroup', 'message' => 'The resource group does not exist.', 'http_code' => 404, 'description' => 'The resource group does not exist.'],
['code' => 'InternalError', 'message' => 'Internal error.', 'http_code' => 500, 'description' => 'Internal server error.'],
['code' => 'NotSupported', 'message' => 'Update the completely same stack is not supported.', 'http_code' => 400, 'description' => 'When changing the configuration of a service instance, there must be a configuration modification.'],
['code' => 'SupplierPocQuotaExceeded', 'message' => 'Supplier\'s trial quota has been exceeded.', 'http_code' => 400, 'description' => 'The service provider\'s trial quota has been exceeded and cannot be created. If you need to create a trial service instance, please contact the service provider and remind the service provider to apply for the corresponding quota in the quota center.'],
['code' => 'TrialNotSupported', 'message' => 'Service does not support trial.', 'http_code' => 400, 'description' => 'Service does not support trial.'],
['code' => 'UserPocQuotaExceeded', 'message' => 'User\'s trial quota has been exceeded.', 'http_code' => 400, 'description' => 'The user\'s trial quota has been exceeded and cannot be created. If you need to create a trial service instance, please apply for the corresponding quota in the quota center.'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBackups'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceLogs'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinueDeployServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RollbackServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelServiceUsage'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceUpgradeHistory'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnTagResources'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceResources'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceUsage'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceDeployable'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewServiceInstanceResources'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagKeys'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRestoreTasks'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateServiceInstanceName'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceInstances'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNetworkAvailableZones'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserInformation'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateServicePolicy'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagValues'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceInstanceSubscriptionEstimateCost'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstances'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceUsage'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceEstimateCost'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBackup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceCategories'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPolicies'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserInformation'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceInstanceAttributes'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceProvisions'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceUsages'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceInstanceBill'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRestoreTask'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceTemplateParameterConstraints'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartServiceInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceInstanceSpec'],
],
],
'ram' => [
'productCode' => 'ComputeNest',
'productName' => 'Compute Nest',
'ramCodes' => ['computenest', 'computenestsupplier'],
'ramLevel' => 'RESOURCE',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'CreateServiceInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/*'],
],
],
],
[
'apiName' => 'DeleteSkillSpace',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:DeleteSkillSpace',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpgradeServiceInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpgradeServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'UpdateUserInformation',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateUserInformation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'UserInfo', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:UserInfo'],
],
],
],
[
'apiName' => 'ListServices',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServices',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListBackups',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListBackups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListServiceInstanceLogs',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceLogs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceInstanceId}'],
],
],
],
[
'apiName' => 'GetServiceProvisions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceProvisions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
],
],
],
[
'apiName' => 'StartServiceInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:StartServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'GetSkillFileDetectResult',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetSkillFileDetectResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateServiceUsage',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateServiceUsage',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:*:{#accountId}:service/{#serviceId}'],
],
],
],
[
'apiName' => 'ListTagValues',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListTagValues',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteServiceInstances',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:DeleteServiceInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'RollbackServiceInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:RollbackServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'GetUserInformation',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetUserInformation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'UserInfo', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:UserInfo'],
],
],
],
[
'apiName' => 'UpdateServiceInstanceAttributes',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateServiceInstanceAttributes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'RenewServiceInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:RenewServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListRestoreTasks',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListRestoreTasks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ValidateServiceInstanceName',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ValidateServiceInstanceName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelServiceUsage',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:CancelServiceUsage',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:*:{#accountId}:service/{#serviceId}'],
],
],
],
[
'apiName' => 'CreateServiceUsage',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateServiceUsage',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:*:{#accountId}:service/{#serviceId}'],
],
],
],
[
'apiName' => 'ListServiceInstanceUpgradeHistory',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceUpgradeHistory',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'CreateRestoreTask',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:CreateRestoreTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSkill',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetServiceInstanceSubscriptionEstimateCost',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:GetServiceInstanceSubscriptionEstimateCost',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'GetSkillHubConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetSkillHubConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenewServiceInstanceResources',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:RenewServiceInstanceResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#AccountId}:serviceinstance/{#serviceInstanceId}'],
],
],
],
[
'apiName' => 'CreateSkillHubConfig',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateSkillHubConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ContinueDeployServiceInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:ContinueDeployServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'GenerateServicePolicy',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GenerateServicePolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
],
],
],
[
'apiName' => 'GetServiceTemplateParameterConstraints',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceTemplateParameterConstraints',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
],
],
],
[
'apiName' => 'ListTagKeys',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListTagKeys',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'CreateSkillFileDetect',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateSkillFileDetect',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnTagResources',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:UnTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'ListServiceCategories',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListServiceCategories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetService',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetService',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#ServiceId}'],
],
],
],
[
'apiName' => 'GetServiceInstance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'ListServiceUsages',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListServiceUsages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckServiceDeployable',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:CheckServiceDeployable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPolicies',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListPolicies',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Policy', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:policy/*'],
],
],
],
[
'apiName' => 'ChangeResourceGroup',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceInstance/{#serviceInstanceId}'],
],
],
],
[
'apiName' => 'DeployServiceInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:DeployServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'DeleteBackup',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'computenest:DeleteBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSkillSpaces',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListSkillSpaces',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateServiceInstanceSpec',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:UpdateServiceInstanceSpec',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:*:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'GetServiceEstimateCost',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetServiceEstimateCost',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#ServiceId}'],
],
],
],
[
'apiName' => 'ListServiceInstanceBill',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceBill',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'CreateBackup',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetNetworkAvailableZones',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetNetworkAvailableZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSkillFiles',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListSkillFiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListServiceInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListServiceInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/*'],
],
],
],
[
'apiName' => 'CreateSkillSpace',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'computenest:CreateSkillSpace',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSkills',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'computenest:ListSkills',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetBackup',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:GetBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RestartServiceInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:RestartServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'StopServiceInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'computenest:StopServiceInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}'],
],
],
],
[
'apiName' => 'ListServiceInstanceResources',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:ListServiceInstanceResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'computenest:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSkillSpace',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'computenest:GetSkillSpace',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ComputeNest', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/*'],
['validationType' => 'always', 'resourceType' => 'SkillSpace', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:skillspace/*'],
['validationType' => 'always', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}'],
['validationType' => 'always', 'resourceType' => 'UserInfo', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:UserInfo'],
['validationType' => 'always', 'resourceType' => 'Service', 'arn' => 'acs:computenestsupplier:{#regionId}:{#accountId}:service/*'],
['validationType' => 'always', 'resourceType' => 'Backup', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:backup/*'],
['validationType' => 'always', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}'],
['validationType' => 'always', 'resourceType' => 'Skill', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:skill/*'],
['validationType' => 'always', 'resourceType' => 'Service', 'arn' => 'acs:computenest:*:{#accountId}:service/{#serviceId}'],
['validationType' => 'always', 'resourceType' => 'Service', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:service/*'],
['validationType' => 'always', 'resourceType' => 'SkillHubConfig', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:skillhubconfig/*'],
['validationType' => 'always', 'resourceType' => 'Policy', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:policy/*'],
['validationType' => 'always', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:serviceInstance/{#serviceInstanceId}'],
['validationType' => 'always', 'resourceType' => 'Backup', 'arn' => 'acs:computenest:{#regionId}:{#accountId}:backup/{#BackupId}'],
['validationType' => 'always', 'resourceType' => 'ServiceInstance', 'arn' => 'acs:computenest:*:{#accountId}:serviceinstance/{#serviceinstanceId}'],
['validationType' => 'always', 'resourceType' => 'Service', 'arn' => 'acs:computenestsupplier:{#regionId}:{#accountId}:service/{#ServiceId}'],
],
],
];