diff options
Diffstat (limited to 'data/en_us/milvus')
| -rw-r--r-- | data/en_us/milvus/2023-10-12/api-docs.php | 4592 |
1 files changed, 2106 insertions, 2486 deletions
diff --git a/data/en_us/milvus/2023-10-12/api-docs.php b/data/en_us/milvus/2023-10-12/api-docs.php index 9046775..6e58fbf 100644 --- a/data/en_us/milvus/2023-10-12/api-docs.php +++ b/data/en_us/milvus/2023-10-12/api-docs.php @@ -1,353 +1,666 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'milvus', - 'version' => '2023-10-12', - ], + 'info' => ['style' => 'ROA', 'product' => 'milvus', 'version' => '2023-10-12'], 'directories' => [ [ - 'id' => 321590, - 'title' => null, + 'children' => ['ListInstancesV2', 'UpdateInstanceName'], 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'GetInstance', - 'ListInstancesV2', - 'DeleteInstance', - 'UpdateInstanceName', - 'GetInstanceDetail', - 'ListInstances', - 'UpdateInstance', - ], + 'title' => 'Instance management', ], [ - 'id' => 321599, - 'title' => null, + 'children' => ['DescribeInstanceConfigs'], 'type' => 'directory', - 'children' => [ - 'ModifyInstanceConfig', - 'DescribeInstanceConfigs', - ], + 'title' => 'Instance configuration', ], [ - 'id' => 321602, - 'title' => null, + 'children' => ['DescribeAccessControlList', 'UpdatePublicNetworkStatus', 'UpdateAccessControlList', 'CreateAclGroup', 'UpdateAclGroupCidrs', 'ListAclGroups'], 'type' => 'directory', - 'children' => [ - 'DescribeAccessControlList', - 'UpdatePublicNetworkStatus', - 'UpdateAccessControlList', - ], + 'title' => 'Instance security', ], [ - 'id' => 321606, - 'title' => null, + 'children' => ['CreateDefaultRole', 'GetInstanceDetail', 'ChangeResourceGroup', 'CreateInstance', 'DeleteInstance', 'GetInstance', 'ListInstances', 'ModifyInstanceConfig', 'TagResources', 'UnTagResources', 'UpdateInstance'], 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UnTagResources', - 'ChangeResourceGroup', - 'CreateDefaultRole', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ - 'InstanceDetail' => [ - 'description' => '', - 'visibility' => 'Public', + 'DBVersionDetail' => [ 'type' => 'object', 'properties' => [ - 'instanceName' => [ + 'version' => ['description' => 'The version number.', 'type' => 'string', 'title' => '', 'example' => ''], + 'status' => ['description' => 'The status of the version.', 'type' => 'string', 'title' => '', 'example' => ''], + 'specs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'zoneMode' => ['description' => 'The zone mode of the specification.', 'type' => 'string', 'title' => '', 'example' => ''], + 'isStandalone' => ['description' => 'Indicates whether the Standalone edition is supported.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'isStandalonePro' => ['description' => 'Indicates whether the Standalone Pro edition is supported.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'isHA' => ['description' => 'Indicates whether the high availability (HA) edition is supported.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'componentSpecs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the component.', 'type' => 'string', 'title' => '', 'example' => ''], + 'type' => ['description' => 'The type of the component.', 'type' => 'string', 'title' => '', 'example' => ''], + 'specs' => [ + 'type' => 'array', + 'items' => ['description' => 'The specification value.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The available specifications for the component.', + 'title' => '', + 'example' => '', + ], + 'minReplicas' => ['description' => 'The minimum number of replicas for the component.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'maxReplicas' => ['description' => 'The maximum number of replicas for the component.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'step' => ['description' => 'The step size for scaling the number of replicas.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'defaultReplicas' => ['description' => 'The default number of replicas for the component.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'description' => 'The component specification details.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The component specifications.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The specification details.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The specifications supported by the version.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'milvus-test', - 'backendName' => 'instanceName', - ], - 'instanceId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c-xxx', - 'backendName' => 'instanceId', - ], - 'regionId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-beijing', - 'backendName' => 'regionId', - ], - 'zoneId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - 'backendName' => 'zoneId', - ], - 'status' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'running', - 'backendName' => 'status', + 'example' => '', ], + ], + 'description' => 'The details of the database version.', + 'title' => '', + 'example' => '', + ], + 'DlfDatabase' => [ + 'type' => 'object', + 'properties' => [ + 'databaseName' => ['title' => '数据库名称', 'description' => 'The name of the database.', 'type' => 'string', 'example' => 'my_database'], + 'description' => ['title' => '数据库描述', 'description' => 'The description of the database.', 'type' => 'string', 'example' => 'Test database'], + 'tableCount' => ['title' => '表数量', 'description' => 'The number of tables in the database. Read-only.', 'type' => 'integer', 'example' => '10', 'format' => 'int32'], + ], + 'description' => 'Represents a database in Data Lake Formation.', + 'title' => '', + 'example' => '', + ], + 'DlfFieldSchema' => [ + 'type' => 'object', + 'properties' => [ + 'fieldName' => ['title' => '字段名称', 'description' => 'The field name.', 'type' => 'string', 'example' => 'id'], + 'dlfFieldType' => ['title' => 'DLF字段类型', 'description' => 'The DLF field type.', 'type' => 'string', 'example' => 'BIGINT'], + 'milvusFieldType' => ['title' => 'Milvus字段类型', 'description' => 'The corresponding Milvus field type.', 'type' => 'string', 'example' => 'Int64'], + 'isPrimaryKey' => ['title' => '是否主键', 'description' => 'Indicates whether the field is a primary key.', 'type' => 'boolean', 'example' => 'true'], + 'isVectorField' => ['title' => '是否向量字段', 'description' => 'Indicates whether the field is a vector field.', 'type' => 'boolean', 'example' => 'false'], + 'dimension' => ['title' => '向量维度', 'description' => 'The dimension of the vector field. This parameter applies only when `isVectorField` is `true`.', 'type' => 'integer', 'example' => '128', 'format' => 'int32'], + 'nullable' => ['title' => '是否可为空', 'description' => 'Indicates whether the field can be null.', 'type' => 'boolean', 'example' => 'true'], + 'comment' => ['title' => '字段注释', 'description' => 'A comment for the field.', 'type' => 'string', 'example' => 'Primary key field'], + 'isSupported' => ['title' => '是否支持映射', 'description' => 'Indicates whether the DLF field type can be mapped to a Milvus field type.', 'type' => 'boolean', 'example' => 'true'], + 'unsupportedReason' => ['title' => '不支持原因', 'description' => 'The reason the DLF field type is unsupported. This field is present only when `isSupported` is `false`.', 'type' => 'string', 'example' => 'Unsupported type'], + ], + 'description' => 'Defines a DLF field\'s properties and its mapping to a Milvus field.', + 'title' => '', + 'example' => '', + ], + 'DlfInstance' => [ + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['title' => 'DLF实例ID', 'description' => 'The unique ID of the DLF instance.', 'type' => 'string', 'example' => 'dlf-cn-xxx'], + 'instanceName' => ['title' => 'DLF实例名称', 'description' => 'The name of the DLF instance.', 'type' => 'string', 'example' => 'my-dlf-instance'], + 'status' => ['title' => '实例状态', 'description' => 'The current status of the DLF instance.', 'type' => 'string', 'example' => 'RUNNING'], + 'regionId' => ['title' => '地域ID', 'description' => 'The ID of the region where the DLF instance is located.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceType' => ['title' => '实例类型', 'description' => 'The type of the DLF instance.', 'type' => 'string', 'example' => 'DLF_2_0'], + ], + 'description' => 'Represents a DLF instance.', + 'title' => '', + 'example' => '', + ], + 'DlfTable' => [ + 'type' => 'object', + 'properties' => [ + 'tableName' => ['title' => '表名称', 'description' => 'The table name.', 'type' => 'string', 'example' => 'my_table'], + 'tableType' => ['title' => '表类型', 'description' => 'The table type. For example, `MANAGED` indicates that DLF manages the data and metadata lifecycle.', 'type' => 'string', 'example' => 'MANAGED'], + 'description' => ['title' => '表描述', 'description' => 'A description of the table.', 'type' => 'string', 'example' => 'Test table'], + 'tableFormat' => ['title' => '表格式', 'description' => 'The table format, such as `PAIMON`.', 'type' => 'string', 'example' => 'PAIMON'], + 'location' => ['title' => '表存储位置', 'description' => 'The location of the table data, specified as an Object Storage Service (OSS) URI.', 'type' => 'string', 'example' => 'oss://bucket/path'], + ], + 'description' => 'The metadata for a table in Data Lake Formation (DLF).', + 'title' => '', + 'example' => '', + ], + 'InstanceDetail' => [ + 'type' => 'object', + 'properties' => [ + 'instanceName' => ['title' => '', 'description' => 'Instance name.', 'type' => 'string', 'example' => 'milvus-test'], + 'instanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'title' => '', 'example' => 'c-xxx'], + 'regionId' => ['description' => 'Region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-beijing'], + 'zoneId' => ['description' => 'Zone ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-i'], + 'status' => ['description' => 'Instance status. Valid values:'."\n" + ."\n" + .'`creating`: The instance is being created.'."\n" + ."\n" + .'`running`: The instance is running.'."\n" + ."\n" + .'`updating`: The instance is being updated. This includes scaling the cluster in or out, changing configurations, and enabling or disabling public network access.'."\n" + ."\n" + .'`disable`: The instance is unavailable. The cluster has expired and must be renewed to be reactivated.'."\n" + ."\n" + .'`deleting`: The instance is being deleted.'."\n" + ."\n" + .'`deleted`: The instance has been deleted.', 'type' => 'string', 'title' => '', 'example' => 'running'], 'paymentType' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Billing method. Valid values: `PayAsYouGo` for pay-as-you-go and `Subscription` for subscription.', + 'enumValueTitles' => ['PayAsYouGo' => 'PayAsYouGo', 'Subscription' => 'Subscription'], 'type' => 'string', - 'enumValueTitles' => [ - 'PayAsYouGo' => 'PayAsYouGo', - 'Subscription' => 'Subscription', - ], + 'title' => '', 'example' => 'PayAsYouGo', - 'backendName' => 'paymentType', - ], - 'resourceGroupId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rg-aek3dcgyq7pnqwa', - 'backendName' => 'resourceGroupId', - ], - 'vpcId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc-xxx', - 'backendName' => 'vpcId', - ], - 'createTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-04-27T02:04:25Z', - 'backendName' => 'createTime', - ], - 'runningTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'runningTime', ], - 'expireTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-04-27T02:04:25Z'."\n", - 'backendName' => 'expireTime', - ], - 'dbVersion' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2.5', - 'backendName' => 'dbVersion', + 'resourceGroupId' => ['description' => 'Resource group ID.', 'type' => 'string', 'title' => '', 'example' => 'rg-aek3dcgyq7pnqwa'], + 'vpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'title' => '', 'example' => 'vpc-xxx'], + 'createTime' => ['description' => 'Instance creation time.', 'type' => 'string', 'format' => 'iso8601', 'title' => '', 'example' => '2025-04-27T02:04:25Z'], + 'runningTime' => ['description' => 'Instance runtime in days.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'expireTime' => ['description' => 'Instance expiration time. This parameter applies only to subscription instances.', 'type' => 'string', 'format' => 'iso8601', 'title' => '', 'example' => '2025-04-27T02:04:25Z'."\n"], + 'dbVersion' => ['description' => 'Instance version.', 'type' => 'string', 'title' => '', 'example' => '2.5'], + 'orderId' => ['description' => 'Order ID.', 'type' => 'string', 'title' => '', 'example' => '4751'], + 'autoBackup' => ['description' => 'Whether automatic backup is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'configuration' => ['description' => 'Instance configuration parameters.', 'type' => 'string', 'title' => '', 'example' => 'rootCoord:'."\n" + .' maxDatabaseNum: 64 # Maximum number of database'."\n" + .' maxPartitionNum: 4096 '], + 'ha' => ['description' => 'Whether high availability (HA) is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'multiZoneMode' => ['description' => 'Multi-zone deployment mode of the instance.', 'type' => 'string', 'title' => '', 'example' => 'Single'], + 'encrypted' => ['description' => 'Whether data encryption is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'kmsKeyId' => ['description' => 'KMS key ID. This parameter is available only when data encryption is enabled.', 'type' => 'string', 'title' => '', 'example' => 'key-xxx'], + 'vSwitchIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['description' => 'Zone ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-i'], + 'vswId' => ['description' => 'vSwitch ID.', 'type' => 'string', 'title' => '', 'example' => 'vsw-xxx'], + ], + 'description' => 'vSwitch information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of vSwitch IDs.', + 'title' => '', + 'example' => '', ], - 'orderId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '4751', - 'backendName' => 'orderId', + 'securityGroupIds' => [ + 'type' => 'array', + 'items' => ['description' => 'Security group ID.', 'type' => 'string', 'title' => '', 'example' => 'sg-xxx'], + 'description' => 'A list of security group IDs.', + 'title' => '', + 'example' => '', ], - 'autoBackup' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'autoBackup', + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'Tag `key`.', 'type' => 'string', 'title' => '', 'example' => 'k1'], + 'value' => ['description' => 'Tag `value`.', 'type' => 'string', 'title' => '', 'example' => 'v1'], + ], + 'description' => 'A key-value pair for a tag.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Tags attached to the instance.', + 'title' => '', + 'example' => '', ], - 'configuration' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rootCoord:'."\n" - .' maxDatabaseNum: 64 # Maximum number of database'."\n" - .' maxPartitionNum: 4096 ', - 'backendName' => 'configuration', + 'components' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'Component type.', 'type' => 'string', 'title' => '', 'example' => 'data'], + 'replica' => ['description' => 'Number of component replicas.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'cuNum' => ['description' => 'Number of CUs.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], + 'cuType' => ['description' => 'CU type.', 'type' => 'string', 'title' => '', 'example' => 'general'], + 'diskSizeType' => ['description' => 'Disk size type for the Query Node. `Large` indicates a storage-optimized configuration, and `Normal` indicates other types, such as compute-optimized.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'payType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => 'Component information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Instance component information.', + 'title' => '', + 'example' => '', ], - 'ha' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ha', + ], + 'description' => 'Instance details.', + 'title' => '', + 'example' => '', + ], + 'MigrationSource' => [ + 'type' => 'object', + 'properties' => [ + 'endpoint' => [ + 'type' => 'object', + 'properties' => [ + 'endpoint' => ['description' => 'The endpoint address of the migration source.', 'type' => 'string', 'title' => '', 'example' => ''], + 'port' => ['description' => 'The port number of the migration source.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The endpoint information of the migration source.', + 'title' => '', + 'example' => '', ], - 'multiZoneMode' => [ + 'database' => ['description' => 'The name of the database to migrate.', 'type' => 'string', 'title' => '', 'example' => ''], + 'authInfo' => [ + 'type' => 'object', + 'properties' => [ + 'token' => ['description' => 'The token used for authentication.', 'type' => 'string', 'title' => '', 'example' => ''], + 'username' => ['description' => 'The username used for authentication.', 'type' => 'string', 'title' => '', 'example' => ''], + 'password' => ['description' => 'The password used for authentication.', 'type' => 'string', 'title' => '', 'example' => ''], + 'authType' => ['description' => 'The authentication type.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The authentication information of the migration source.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Single', - 'backendName' => 'multiZoneMode', + 'example' => '', ], - 'encrypted' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'encrypted', - ], - 'kmsKeyId' => [ - 'description' => 'kms key Id。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'key-xxx', - 'backendName' => 'kmsKeyId', + ], + 'description' => 'The information about the migration source.', + 'title' => '', + 'example' => '', + ], + 'open_struct_DlfSnapshotDto' => [ + 'type' => 'object', + 'properties' => [ + 'snapshotId' => ['title' => '快照ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'], + 'timeMillis' => ['title' => '快照时间戳(毫秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1711334400000'], + 'schemaId' => ['title' => 'Schema ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'totalRecordCount' => ['title' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], + 'deltaRecordCount' => ['title' => '增量记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'changelogRecordCount' => ['title' => 'Changelog记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '500'], + 'commitKind' => ['title' => '提交类型', 'type' => 'string', 'example' => 'APPEND'], + ], + ], + 'open_struct_DlfTagDto' => [ + 'type' => 'object', + 'properties' => [ + 'tagName' => ['title' => 'Tag名称', 'type' => 'string', 'example' => 'milvus-auto-20260101'], + 'snapshotId' => ['title' => '关联的快照ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'], + 'timeMillis' => ['title' => '快照时间戳(毫秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1711334400000'], + 'totalRecordCount' => ['title' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], + ], + ], + 'PriceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'currency' => ['description' => 'The currency of the price.', 'type' => 'string', 'title' => '', 'example' => ''], + 'originalAmount' => ['description' => 'The original price.', 'type' => 'string', 'title' => '', 'example' => ''], + 'tradeAmount' => ['description' => 'The actual trade price.', 'type' => 'string', 'title' => '', 'example' => ''], + 'discountAmount' => ['description' => 'The discount amount.', 'type' => 'string', 'title' => '', 'example' => ''], + 'taxAmount' => ['description' => 'The tax amount.', 'type' => 'string', 'title' => '', 'example' => ''], + 'optionalPromotions' => [ + 'type' => 'array', + 'items' => ['description' => 'The promotion details.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/PromotionInfo'], + 'description' => 'The optional promotions.', + 'title' => '', + 'example' => '', ], - 'vSwitchIds' => [ - 'description' => '', - 'visibility' => 'Public', + 'priceModules' => [ 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - 'backendName' => 'zoneId', - ], - 'vswId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vsw-xxx', - 'backendName' => 'vswId', - ], + 'type' => ['description' => 'The type of the price module.', 'type' => 'string', 'title' => '', 'example' => ''], + 'originalAmount' => ['description' => 'The original amount of the price module.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'extendType' => 'true', - ], - 'backendName' => 'vswitchIds', - ], - 'securityGroupIds' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sg-xxx', - 'extendType' => 'true', + 'description' => 'The price module details.', + 'title' => '', + 'example' => '', ], - 'backendName' => 'securityGroupIds', + 'description' => 'The price modules.', + 'title' => '', + 'example' => '', ], - 'tags' => [ - 'description' => '', - 'visibility' => 'Public', + 'rules' => [ 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'k1', - 'backendName' => 'key', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'v1', - 'backendName' => 'value', - ], + 'ruleId' => ['description' => 'The ID of the pricing rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'amount' => ['description' => 'The amount associated with the pricing rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The name of the pricing rule.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'extendType' => 'true', + 'description' => 'The pricing rule details.', + 'title' => '', + 'example' => '', ], - 'backendName' => 'tags', + 'description' => 'The pricing rules.', + 'title' => '', + 'example' => '', ], - 'components' => [ - 'description' => '', - 'visibility' => 'Public', + ], + 'description' => 'The pricing information.', + 'title' => '', + 'example' => '', + ], + 'PromotionInfo' => [ + 'type' => 'object', + 'properties' => [ + 'promotionOptionCode' => ['description' => 'The code of the promotion option.', 'type' => 'string', 'title' => '', 'example' => ''], + 'promotionOptionNo' => ['description' => 'The number of the promotion option.', 'type' => 'string', 'title' => '', 'example' => ''], + 'promotionName' => ['description' => 'The name of the promotion.', 'type' => 'string', 'title' => '', 'example' => ''], + 'promotionDesc' => ['description' => 'The description of the promotion.', 'type' => 'string', 'title' => '', 'example' => ''], + 'canPromFee' => ['description' => 'The fee that can be covered by the promotion.', 'type' => 'string', 'title' => '', 'example' => ''], + 'isSelected' => ['description' => 'Indicates whether the promotion is selected.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'selected' => ['description' => 'Indicates whether the promotion is selected.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => 'The promotion information.', + 'title' => '', + 'example' => '', + ], + 'RamAccount' => [ + 'type' => 'object', + 'properties' => [ + 'uid' => ['title' => '阿里云 UID', 'description' => 'The unique identifier for the RamAccount.', 'type' => 'string', 'example' => '1234567890123456'], + 'userName' => ['title' => 'RAM 用户名', 'description' => 'The user name for the RamAccount.', 'type' => 'string', 'example' => 'test-user'], + 'displayName' => ['title' => '显示名称', 'description' => 'The display name for the RamAccount, which appears in the console.', 'type' => 'string', 'example' => 'Test User'], + 'bindable' => ['title' => '是否可绑定', 'description' => 'Specifies whether the RamAccount can be bound to other resources.', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => 'Details of the RamAccount object.', + 'title' => '', + 'example' => '', + ], + 'RamBindingEntry' => [ + 'type' => 'object', + 'properties' => [ + 'milvusUsername' => ['title' => 'Milvus数据库用户名', 'description' => 'The Milvus username.', 'type' => 'string', 'example' => 'root'], + 'boundUid' => ['title' => '绑定的阿里云UID', 'description' => 'The unique identifier (UID) of the bound RAM user.', 'type' => 'string', 'example' => '1234567890123456'], + 'boundUserName' => ['title' => '绑定的RAM用户名', 'description' => 'The bound RAM username.', 'type' => 'string', 'example' => 'test-user'], + ], + 'description' => 'Describes a RAM binding entry.', + 'title' => '', + 'example' => '', + ], + 'ScalingActivity' => [ + 'type' => 'object', + 'properties' => [ + 'scalingActivityId' => ['description' => 'The ID of the scaling activity.', 'type' => 'string', 'title' => '', 'example' => ''], + 'scalingRuleName' => ['description' => 'The name of the scaling rule that triggered the activity.', 'type' => 'string', 'title' => '', 'example' => ''], + 'scalingPolicyId' => ['description' => 'The ID of the scaling policy.', 'type' => 'string', 'title' => '', 'example' => ''], + 'instanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => ''], + 'componentTypes' => ['description' => 'The types of components involved in the scaling activity.', 'type' => 'string', 'title' => '', 'example' => ''], + 'scalingActivityState' => ['description' => 'The state of the scaling activity.', 'type' => 'string', 'title' => '', 'example' => ''], + 'startTime' => ['description' => 'The start time of the scaling activity.', 'type' => 'string', 'title' => '', 'example' => ''], + 'endTime' => ['description' => 'The end time of the scaling activity.', 'type' => 'string', 'title' => '', 'example' => ''], + 'policyType' => ['description' => 'The type of the scaling policy.', 'type' => 'string', 'title' => '', 'example' => ''], + 'scalingRuleDetail' => ['description' => 'The details of the scaling rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'scalingRuleId' => ['description' => 'The ID of the scaling rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'timeZone' => ['description' => 'The time zone of the scaling activity.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description of the scaling activity.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The details of the scaling activity.', + 'title' => '', + 'example' => '', + ], + 'ScalingRule' => [ + 'type' => 'object', + 'properties' => [ + 'ruleId' => ['description' => 'The ID of the scaling rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'scalingRuleName' => ['description' => 'The name of the scaling rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'timeZone' => ['description' => 'The time zone of the scaling rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'cronStr' => ['description' => 'The cron expression for the scaling schedule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'startTime' => ['description' => 'The start time of the scaling rule. Unit: milliseconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'endTime' => ['description' => 'The end time of the scaling rule. Unit: milliseconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'disabled' => ['description' => 'Indicates whether the scaling rule is disabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'adjustInfos' => [ 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'data', - 'backendName' => 'type', - ], - 'replica' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'replica', - ], - 'cuNum' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - 'backendName' => 'cuNum', - ], - 'cuType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'general', - 'backendName' => 'cuType', - ], - 'diskSizeType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normal', - 'backendName' => 'diskSizeType', - ], + 'componentType' => ['title' => 'index query data proxy streaming mix_coordinator', 'description' => 'The type of the component to be adjusted.', 'type' => 'string', 'example' => ''], + 'targetValue' => ['description' => 'The target value for the adjustment.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'extendType' => 'true', + 'description' => 'The adjustment details.', + 'title' => '', + 'example' => '', ], - 'backendName' => 'components', + 'description' => 'The adjustment information of the scaling rule.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The details of the scaling rule.', + 'title' => '', + 'example' => '', ], ], ], 'apis' => [ - 'CreateInstance' => [ - 'summary' => '创建实例', - 'path' => '/webapi/instance/create', - 'methods' => [ - 'post', + 'ChangeResourceGroup' => [ + 'path' => '/webapi/resourceGroup/change', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234796', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], + 'parameters' => [ + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The new resource group ID.', 'example' => 'rg-acfnsjj5tgai4wi'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The region ID.', 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The resource type.', 'required' => false, 'title' => '', 'example' => 'instance'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The resource ID.', 'required' => false, 'title' => '', 'example' => 'c-xxx'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The resource group ID.', 'required' => false, 'title' => '', 'example' => 'rg-123xxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The HTTP status code.', 'title' => '', 'example' => '200'], + 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful.', 'title' => '', 'example' => 'true'], + 'ErrCode' => ['type' => 'string', 'description' => 'The error code.', 'title' => '', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['type' => 'string', 'description' => 'The error message.', 'title' => '', 'example' => 'Failed to find instance c-123xxx'], + 'Data' => ['type' => 'boolean', 'description' => 'The data returned.', 'title' => '', 'example' => 'true'], + 'AccessDeniedDetail' => ['type' => 'string', 'title' => '', 'description' => 'The details about the access denial.', 'example' => 'None'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ChangeResourceGroup', + 'summary' => 'Changes the resource group of a resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', + ], + 'CreateAclGroup' => [ + 'path' => '/webapi/milvus/createAclGroup', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREmilvus0MDRCH'], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-xxxx', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'groupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the ACL group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'cidrs', + 'in' => 'query', + 'schema' => ['description' => 'Specify one or more CIDR blocks, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '140.205.11.0/24,140.205.11.2', 'title' => ''], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'requestId' => ['description' => 'The unique ID generated for the request. Use this ID for troubleshooting.', 'type' => 'string', 'example' => 'BE7E95C4-10DE-5EA7-9D10-2D3E0FCCE68C', 'title' => ''], + 'success' => ['description' => 'Indicates if the request succeeded, where a value of `true` means success.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'errMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '[%60wget Nds0v6lx.popscan.xaliyun.com%60]', 'title' => ''], + 'data' => ['description' => 'The data returned for the request.', 'type' => 'boolean', 'example' => '{\'instanceId\': \'c-fa521a2393de4623\', \'orderId\': \'271129670950939\'}', 'title' => ''], + 'accessDeniedDetail' => ['description' => 'Details about the access denial. This parameter is returned only if a request is denied due to insufficient RAM permissions.', 'type' => 'string', 'example' => 'None', 'title' => ''], + ], + 'description' => 'The response body.', + 'title' => '', + 'example' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateAclGroup', + 'summary' => 'Creates an ACL group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"httpStatusCode\\": 200,\\n \\"requestId\\": \\"BE7E95C4-10DE-5EA7-9D10-2D3E0FCCE68C\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"[%60wget Nds0v6lx.popscan.xaliyun.com%60]\\",\\n \\"data\\": true,\\n \\"accessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', + ], + 'CreateDefaultRole' => [ + 'path' => '/webapi/user/create_default_role', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREmilvusGDAFRH'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" } ', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDefaultRole', + 'summary' => 'Creates the server role required by Milvus to access other cloud products.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDefaultRole'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'milvus:CreateDefaultRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\\\t\\"\\n}","type":"json"}]', + ], + 'CreateInstance' => [ + 'summary' => 'Creates a cluster instance.', + 'path' => '/webapi/instance/create', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ @@ -355,9 +668,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusGDAFRH', - ], + 'abilityTreeNodes' => ['FEATUREmilvusGDAFRH'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -365,11 +676,7 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'type' => 'string', - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'required' => false], ], [ 'name' => 'body', @@ -377,181 +684,156 @@ 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'title' => '主可用区。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing-g', - ], - 'instanceName' => [ - 'title' => '实例名称', - 'type' => 'string', - 'example' => 'milvus-test', - ], - 'dbVersion' => [ - 'title' => '内核版本', - 'type' => 'string', - 'required' => true, - 'example' => '2.4', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-xxx', - ], - 'vpcId' => [ - 'title' => '专有网络id', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-123xxx', - ], + 'zoneId' => ['title' => '', 'description' => 'The primary zone.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing-g'], + 'instanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'milvus-test', 'required' => false], + 'dbVersion' => ['title' => '', 'description' => 'The Milvus version.', 'type' => 'string', 'required' => true, 'example' => '2.4'], + 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxx', 'required' => false], + 'vpcId' => ['title' => '', 'description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-123xxx'], 'paymentType' => [ - 'title' => '付费类型', + 'title' => '', + 'description' => 'The payment type.', + 'enumValueTitles' => ['PayAsYouGo' => 'pay-as-you-go.', 'Subscription' => 'subscription.'], 'type' => 'string', 'required' => true, 'example' => 'PayAsYouGo', ], - 'paymentDuration' => [ - 'title' => '付费时长', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'paymentDuration' => ['title' => '', 'description' => 'The payment duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], 'paymentDurationUnit' => [ - 'title' => '付费单位', + 'title' => '', + 'description' => 'The payment duration unit.', + 'enumValueTitles' => ['Month' => 'month.', 'Year' => 'year.'], 'type' => 'string', 'example' => 'month', + 'required' => false, ], - 'ha' => [ - 'title' => '是否开启高可用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'dbAdminPassword' => [ - 'title' => 'db密码', - 'type' => 'string', - 'example' => 'test12', - ], - 'autoBackup' => [ - 'title' => '是否开启自动备份', - 'type' => 'boolean', - ], + 'ha' => ['title' => '', 'description' => 'Specifies whether to enable high availability (HA).', 'type' => 'boolean', 'example' => 'true', 'required' => false], + 'dbAdminPassword' => ['title' => '', 'description' => 'The database administrator password.', 'type' => 'string', 'example' => 'test12', 'required' => false], + 'autoBackup' => ['title' => '', 'description' => 'Specifies whether to enable automatic backup.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'multiZoneMode' => [ - 'title' => '可用区配置。', + 'title' => '', + 'description' => 'The zone configuration.', + 'enumValueTitles' => ['Single' => 'single zone.', 'Two_ha' => 'Dual-zone deployment with high availability active.', 'Two' => 'Dual-zone deployment active.'], 'type' => 'string', - ], - 'encrypted' => [ - 'title' => '是否开启oss加密', + 'required' => false, + 'example' => 'Single', + ], + 'encrypted' => ['title' => '', 'description' => 'Specifies whether to enable OSS encryption.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'kmsKeyId' => ['title' => '', 'description' => 'The ID of the KMS key used for encryption.', 'type' => 'string', 'required' => false, 'example' => 'key-xxx'], + 'configuration' => ['title' => '', 'description' => 'The configuration items.', 'type' => 'string', 'required' => false, 'example' => 'rootCoord:'."\n" + .' maxDatabaseNum: 64 # Maximum number of database'."\n" + .' maxPartitionNum: 4096 '], + 'promotionNo' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => '22120151****', 'title' => ''], + 'loadReplicas' => ['description' => 'The number of load replicas.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'isMultiAzStorage' => ['description' => 'Specifies whether to enable multi-zone storage.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + 'autoPay' => [ + 'description' => 'Specifies whether to enable automatic payment. Default value: true. Valid values:'."\n" + .'- true: Automatic payment is enabled.'."\n" + .'- false: Only an order is generated. No payment is made.', + 'enumValueTitles' => [], 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', ], - 'kmsKeyId' => [ - 'title' => '用来加密的Kms key 的id。', - 'type' => 'string', - ], - 'configuration' => [ - 'title' => '配置项。', - 'type' => 'string', - ], - 'promotionNo' => [ - 'type' => 'string', - ], - 'loadReplicas' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'isMultiAzStorage' => [ - 'type' => 'boolean', + 'autoRenew' => ['description' => 'Specifies whether to enable auto-renewal. This parameter takes effect only when the payment type is set to Subscription.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'backupRestoreInfo' => [ + 'description' => 'The backup and restoration information.', + 'type' => 'object', + 'properties' => [ + 'sourceClusterId' => ['description' => 'The ID of the source backup cluster.', 'type' => 'string', 'required' => false, 'example' => 'c-xxxxxxx', 'title' => ''], + 'backupName' => ['description' => 'The backup name.', 'type' => 'string', 'required' => false, 'example' => '备份1', 'title' => ''], + 'backupId' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => false, 'example' => 'bt-xxxxx', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'vSwitchIds' => [ - 'title' => '交换机', + 'title' => '', + 'description' => 'The vSwitches.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => 'The vSwitch ID.', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'title' => '可用区。', - 'type' => 'string', - ], - 'vswId' => [ - 'title' => '可用区下vswitch id配置。', - 'type' => 'string', - ], + 'zoneId' => ['title' => '', 'description' => 'The zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-a'], + 'vswId' => ['title' => '', 'description' => 'The vSwitch ID in the zone.', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxx'], ], + 'required' => false, + 'example' => '', ], + 'required' => false, 'example' => '["vsw-123xxx"]', ], 'components' => [ - 'title' => '组件信息', + 'title' => '', + 'description' => 'The component information.', 'type' => 'array', 'items' => [ + 'description' => 'The list of instance specification information.', 'type' => 'object', 'properties' => [ 'type' => [ - 'title' => '组件类型', + 'title' => '', + 'description' => 'The component type.', + 'enumValueTitles' => ['proxy' => 'proxy', 'mix_coordinator' => 'mix_coordinator', 'data' => 'data', 'query' => 'query', 'standalone' => 'standalone', 'index' => 'index'], 'type' => 'string', 'required' => true, 'example' => 'standalone', ], - 'replica' => [ - 'title' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'cuNum' => [ - 'title' => 'CU数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8', - ], - 'cuType' => [ - 'title' => 'CU类型。', - 'type' => 'string', - 'example' => 'general', - ], + 'replica' => ['title' => '', 'description' => 'The number of replicas.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'cuNum' => ['title' => '', 'description' => 'The number of compute units (CUs).', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8'], + 'cuType' => ['title' => '', 'description' => 'The CU type.', 'type' => 'string', 'example' => 'general', 'required' => false], 'diskSizeType' => [ - 'title' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', + 'title' => '', + 'description' => 'The disk size type for Query Node. Set this parameter to Large for storage-optimized instances. Set this parameter to Normal for compute-optimized and other instances.', 'type' => 'string', 'docRequired' => false, - 'enum' => [ - 'Large', - 'Normal', - ], + 'enum' => ['Large', 'Normal'], + 'required' => false, + 'example' => 'Normal', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], 'tags' => [ + 'description' => 'The instance tags.', 'type' => 'array', 'items' => [ + 'description' => 'The unique identifier of the tag.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'autoRenew' => [ - 'type' => 'boolean', - ], + 'aiFunction' => ['description' => 'Specifies whether to enable the AI function.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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 token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], ], 'responses' => [ @@ -559,67 +841,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'success' => [ - 'title' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'data' => [ + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'type' => 'string', - ], - 'orderId' => [ - 'type' => 'string', - ], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c-xxx', 'title' => ''], + 'orderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"instanceId\\": \\"c-xxx\\",\\n \\"orderId\\": \\"xxx\\"\\n }\\n}","type":"json"}]', - ], - 'GetInstance' => [ - 'summary' => '获取实例详情', - 'path' => '/webapi/instance/get', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'Create a cluster instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'milvus:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], ], + ], + 'DeleteInstance' => [ + 'summary' => 'Deletes an instance.', + 'path' => '/webapi/instance/delete', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -627,24 +908,12 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false], ], [ 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c-xxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'c-xxxx', 'title' => ''], ], ], 'responses' => [ @@ -652,189 +921,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'instance' => [ - 'title' => '实例详情', - 'description' => '', - '$ref' => '#/components/schemas/InstanceDetail', - ], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c-xxxx', 'title' => ''], + 'orderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"instance\\": {\\n \\"instanceName\\": \\"milvus-test\\",\\n \\"instanceId\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"zoneId\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"paymentType\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"vpcId\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"runningTime\\": 0,\\n \\"expireTime\\": \\"\\",\\n \\"dbVersion\\": \\"\\",\\n \\"orderId\\": \\"\\",\\n \\"autoBackup\\": true,\\n \\"configuration\\": \\"\\",\\n \\"ha\\": true,\\n \\"multiZoneMode\\": \\"\\",\\n \\"encrypted\\": true,\\n \\"kmsKeyId\\": \\"\\",\\n \\"vSwitchIds\\": [\\n {\\n \\"zoneId\\": \\"\\",\\n \\"vswId\\": \\"\\"\\n }\\n ],\\n \\"securityGroupIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"components\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"replica\\": 0,\\n \\"cuNum\\": 0,\\n \\"cuType\\": \\"\\",\\n \\"diskSizeType\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'ListInstancesV2' => [ - 'summary' => '根据集群ID或者名称搜索集群', - 'path' => '/webapi/instance/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'milvus:DeleteInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"instanceId\\": \\"c-xxxx\\",\\n \\"orderId\\": \\"123456\\"\\n}","type":"json"}]', + ], + 'DescribeAccessControlList' => [ + 'summary' => 'Get the public IP address whitelist of a Milvus instance.', + 'path' => '/webapi/milvus/describe_access_control_list', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'instanceName', - 'in' => 'query', - 'schema' => [ - 'title' => '集群名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'milvus-test', - ], - ], - [ - 'name' => 'instanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '集群id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c-123xxx', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-123xxx', - ], - ], - [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'k1', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'nextToken', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'None', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', 'title' => ''], ], ], 'responses' => [ @@ -842,109 +983,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'total' => [ - 'title' => '总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'instances' => [ - 'title' => '实例列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/InstanceDetail', + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', 'title' => ''], + 'Data' => [ + 'title' => '', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'AclId' => ['description' => 'AclId for public network access control.', 'type' => 'string', 'example' => 'acl-xxxx', 'title' => ''], + 'Cidr' => [ + 'title' => '', + 'description' => 'The CIDR blocks.', + 'type' => 'array', + 'items' => ['description' => 'The IP address segment.', 'type' => 'string', 'example' => '192.168.**.**', 'title' => ''], + 'example' => '', + ], ], + 'example' => '', ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'maxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed information about the failed permission verification.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"total\\": 15,\\n \\"instances\\": [\\n {\\n \\"instanceName\\": \\"milvus-test\\",\\n \\"instanceId\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"zoneId\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"paymentType\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"vpcId\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"runningTime\\": 0,\\n \\"expireTime\\": \\"\\",\\n \\"dbVersion\\": \\"\\",\\n \\"orderId\\": \\"\\",\\n \\"autoBackup\\": true,\\n \\"configuration\\": \\"\\",\\n \\"ha\\": true,\\n \\"multiZoneMode\\": \\"\\",\\n \\"encrypted\\": true,\\n \\"kmsKeyId\\": \\"\\",\\n \\"vSwitchIds\\": [\\n {\\n \\"zoneId\\": \\"\\",\\n \\"vswId\\": \\"\\"\\n }\\n ],\\n \\"securityGroupIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"components\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"replica\\": 0,\\n \\"cuNum\\": 0,\\n \\"cuType\\": \\"\\",\\n \\"diskSizeType\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"None\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', - ], - 'DeleteInstance' => [ - 'summary' => '删除实例', - 'path' => '/webapi/instance/delete', - 'methods' => [ - 'delete', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": {\\n \\"AclId\\": \\"acl-xxxx\\",\\n \\"Cidr\\": [\\n \\"192.168.**.**\\"\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', + 'title' => 'DescribeAccessControlList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlList'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:DescribeAccessControlList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'DescribeInstanceConfigs' => [ + 'summary' => 'Get information about the custom configuration of each component of Milvus.', + 'path' => '/webapi/config/describe_milvus_user_config', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'instanceId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c-xxxx', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', 'title' => ''], ], ], 'responses' => [ @@ -952,86 +1064,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'c-xxxx', - ], - 'orderId' => [ - 'title' => '订单ID', - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx.', 'title' => ''], + 'Data' => ['description' => 'The returned result.', 'type' => 'string', 'format' => 'byte', 'example' => 'dataCoord:\\n enableCompaction: true', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The detailed information about the failed permission verification.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"instanceId\\": \\"c-xxxx\\",\\n \\"orderId\\": \\"123456\\"\\n}","type":"json"}]', - ], - 'UpdateInstanceName' => [ - 'summary' => 'Modifies the name of an instance.', - 'path' => '/webapi/cluster/update_name', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx.\\",\\n \\"Data\\": \\"dataCoord:\\\\\\\\n enableCompaction: true\\",\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', + 'title' => 'DescribeInstanceConfigs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceConfigs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:DescribeInstanceConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'GetInstance' => [ + 'path' => '/webapi/instance/get', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREmilvusGDAFRH', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197636', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClusterName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '集群名称', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'milvus-test', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false], ], [ - 'name' => 'InstanceId', + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群实例id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'c-xxxx', 'title' => ''], ], ], 'responses' => [ @@ -1039,67 +1140,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'instance' => ['description' => 'The details of the instance.', '$ref' => '#/components/schemas/InstanceDetail', 'title' => '', 'example' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', - 'title' => 'UpdateInstanceName', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetInstance', + 'summary' => 'Retrieves the details of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:GetInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"instance\\": {\\n \\"instanceName\\": \\"milvus-test\\",\\n \\"instanceId\\": \\"c-xxx\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"status\\": \\"running\\",\\n \\"paymentType\\": \\"PayAsYouGo\\",\\n \\"resourceGroupId\\": \\"rg-aek3dcgyq7pnqwa\\",\\n \\"vpcId\\": \\"vpc-xxx\\",\\n \\"createTime\\": \\"2025-04-27T02:04:25Z\\",\\n \\"runningTime\\": 1,\\n \\"expireTime\\": \\"2025-04-27T02:04:25Z\\\\n\\",\\n \\"dbVersion\\": \\"2.5\\",\\n \\"orderId\\": \\"4751\\",\\n \\"autoBackup\\": true,\\n \\"configuration\\": \\"rootCoord:\\\\n maxDatabaseNum: 64 # Maximum number of database\\\\n maxPartitionNum: 4096 \\",\\n \\"ha\\": true,\\n \\"multiZoneMode\\": \\"Single\\",\\n \\"encrypted\\": false,\\n \\"kmsKeyId\\": \\"key-xxx\\",\\n \\"vSwitchIds\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"vswId\\": \\"vsw-xxx\\"\\n }\\n ],\\n \\"securityGroupIds\\": [\\n \\"sg-xxx\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"k1\\",\\n \\"value\\": \\"v1\\"\\n }\\n ],\\n \\"components\\": [\\n {\\n \\"type\\": \\"data\\",\\n \\"replica\\": 1,\\n \\"cuNum\\": 4,\\n \\"cuType\\": \\"general\\",\\n \\"diskSizeType\\": \\"Normal\\",\\n \\"payType\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'GetInstanceDetail' => [ - 'summary' => 'Get the details of an instance.', 'path' => '/webapi/cluster/detail', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1112,21 +1188,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197635', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群实例id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c-123xxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c-123xxx', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -1134,474 +1202,310 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', 'title' => ''], 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '集群id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'c-123xxx', - ], - 'BeginTime' => [ - 'title' => '开始时间', - 'description' => 'The start time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1716863508000', - ], - 'RunningTime' => [ - 'title' => '运行时间', - 'description' => 'The runtime.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743679', - ], - 'ExpireTime' => [ - 'title' => '过期时间', - 'description' => 'The expiration time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1721664000000', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => 'The region code.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ZoneId' => [ - 'title' => '可用区', - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing-g', - ], - 'InstanceStatus' => [ - 'title' => '状态', - 'description' => 'The instance status. Valid values:'."\n" - ."\n" - .'* creating.'."\n" - .'* running.'."\n" - .'* updating. Cluster scaling (up/down), configuration changes, and enabling/disabling public network access.'."\n" - .'* disable. The cluster has expired and needs to be renewed for activation.'."\n" - .'* deleting.'."\n" - .'* deleted.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'PackageType' => [ - 'title' => '规格', - 'description' => 'The specification details. Valid values:'."\n" - ."\n" - .'* trial.'."\n" - .'* standard.'."\n", - 'type' => 'string', - 'example' => 'standard', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c-123xxx', 'title' => ''], + 'BeginTime' => ['description' => 'The creation time of the instance, represented as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716863508000', 'title' => ''], + 'RunningTime' => ['description' => 'The runtime of the instance, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1743679', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the instance, represented as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1721664000000', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'ZoneId' => ['description' => 'The ID of the availability zone where the instance is located.', 'type' => 'string', 'example' => 'cn-beijing-g', 'title' => ''], + 'InstanceStatus' => ['description' => 'The instance status. Possible values:'."\n" + ."\n" + .'- `creating`: The instance is being created.'."\n" + ."\n" + .'- `running`: The instance is running.'."\n" + ."\n" + .'- `updating`: The instance is being updated. This can occur during operations such as cluster scaling, configuration changes, or enabling/disabling the public endpoint.'."\n" + ."\n" + .'- `disable`: The instance is unavailable because it has expired. You must renew the instance to reactivate it.'."\n" + ."\n" + .'- `deleting`: The instance is being deleted.'."\n" + ."\n" + .'- `deleted`: The instance is deleted.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'PackageType' => ['description' => 'The instance edition. Possible values:'."\n" + ."\n" + .'- `trial`: Starter edition.'."\n" + ."\n" + .'- `standard`: Standard edition.', 'type' => 'string', 'example' => 'standard', 'title' => ''], 'ClusterInfo' => [ - 'title' => '集群详情', - 'description' => 'The instance details.'."\n", + 'title' => '', + 'description' => 'The instance details.', 'type' => 'object', 'properties' => [ 'MilvusResourceInfoList' => [ - 'title' => '资源详情', - 'description' => 'The resource details.'."\n", + 'title' => '', + 'description' => 'A list of resource details for each component in the instance.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ComponentType' => [ - 'title' => '组件类型', - 'description' => 'The component type. Valid values:'."\n" - ."\n" - .'* standalone'."\n" - .'* proxy'."\n" - .'* mix_coordinator'."\n" - .'* query'."\n" - .'* index'."\n" - .'* data'."\n", - 'type' => 'string', - 'example' => 'QueryNode', - ], - 'CuNum' => [ - 'title' => 'CU数量', - 'description' => 'The number of CUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'CuRatio' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Replica' => [ - 'title' => '副本数量', - 'description' => 'The number of replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DiskSize' => [ - 'title' => '磁盘大小', - 'description' => 'The disk size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'DiskType' => [ - 'title' => '磁盘类型', - 'description' => 'The disk type.'."\n", - 'type' => 'string', - 'example' => 'essd', - ], - 'ZoneId' => [ - 'type' => 'string', - ], + 'ComponentType' => ['description' => 'The component type. Possible values:'."\n" + ."\n" + .'- `standalone`'."\n" + ."\n" + .'- `proxy`'."\n" + ."\n" + .'- `mix_coordinator`'."\n" + ."\n" + .'- `query`'."\n" + ."\n" + .'- `index`'."\n" + ."\n" + .'- `data`', 'type' => 'string', 'example' => 'standalone', 'title' => ''], + 'CuNum' => ['description' => 'The number of CUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'CuRatio' => ['description' => 'The CU specification, which defines the ratio of CPU cores to memory. Possible values:'."\n" + ."\n" + .'- `4`: 1 core to 4 GB of memory.'."\n" + ."\n" + .'- `8`: 1 core to 8 GB of memory.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'Replica' => ['description' => 'The number of replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DiskSize' => ['description' => 'The disk size, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'DiskType' => ['description' => 'The disk type.', 'type' => 'string', 'example' => 'essd', 'title' => ''], + 'ZoneId' => ['description' => 'The ID of the availability zone for this component.', 'type' => 'string', 'title' => '', 'example' => ''], + 'PayType' => ['description' => 'The billing method for this component.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'description' => '', + 'description' => 'A resource object for a component.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'IntranetUrl' => [ - 'title' => '内网地址', - 'description' => 'The internal IP address.'."\n", - 'type' => 'string', - 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', - ], - 'InternetUrl' => [ - 'title' => '公网地址', - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => 'c-123xxx-.milvus.aliyuncs.com', - ], - 'TotalCuNum' => [ - 'title' => '总CU数量', - 'description' => 'The total number of CUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'TotalDiskSize' => [ - 'title' => '总磁盘数量', - 'description' => 'The total number of disks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'ProxyPort' => [ - 'title' => 'Proxy端口', - 'description' => 'The proxy port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '19530', - ], - 'AttuPort' => [ - 'title' => 'Attu组件端口', - 'description' => 'The port of the Attu component.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], - 'OssStorageTimestamp' => [ - 'title' => 'OSS存储指标时间', - 'description' => 'The timestamp when the OSS metric is stored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718604000000', - ], - 'OssStorageSize' => [ - 'title' => 'OSS存储数据大小', - 'description' => 'The size of the data stored in OSS.'."\n", - 'type' => 'string', - 'example' => '125.15 GB', - ], + 'IntranetUrl' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', 'title' => ''], + 'InternetUrl' => ['description' => 'The public endpoint.', 'type' => 'string', 'example' => 'c-123xxx-.milvus.aliyuncs.com', 'title' => ''], + 'TotalCuNum' => ['description' => 'The total number of CUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''], + 'TotalDiskSize' => ['description' => 'The total disk size, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'ProxyPort' => ['description' => 'The port of the proxy component.', 'type' => 'integer', 'format' => 'int32', 'example' => '19530', 'title' => ''], + 'AttuPort' => ['description' => 'The port of the Attu component.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], + 'OssStorageTimestamp' => ['description' => 'The time the OSS storage metric was recorded, represented as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1718604000000', 'title' => ''], + 'OssStorageSize' => ['description' => 'The size of data stored in Object Storage Service (OSS), in GB.', 'type' => 'string', 'example' => '125.15 GB', 'title' => ''], ], + 'example' => '', ], - 'VpcId' => [ - 'title' => '专有网络id', - 'description' => 'The virtual private cloud (VPC) ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-123xxx', - ], - 'VswId' => [ - 'title' => '交换机id', - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-123xxx', - ], - 'SgId' => [ - 'title' => '安全组id', - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-123xxx', - ], - 'OpenPublicNet' => [ - 'title' => '是否开启公网', - 'description' => 'Indicates whether Internet access is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ClusterName' => [ - 'title' => '集群名称', - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'aliyun-test', - ], - 'PayType' => [ - 'title' => '付费类型', - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* 0: pay-as-you-go'."\n" - .'* 1: subscription'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BucketName' => [ - 'title' => 'bucket名称', - 'description' => 'The name of the bucket.'."\n", - 'type' => 'string', - 'example' => 'milvus-test', - ], - 'BucketPath' => [ - 'title' => 'bucket地址', - 'description' => 'The address of the bucket.'."\n", - 'type' => 'string', - 'example' => 'https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx', - ], - 'Version' => [ - 'title' => '内核版本', - 'description' => 'The kernel version.'."\n", - 'type' => 'string', - 'example' => '2.4', - ], - 'AclId' => [ - 'title' => '公网访问控制aclId', - 'description' => 'AclId for Public Network Access Control.'."\n", - 'type' => 'string', - 'example' => 'acl-123xxx', - ], - 'UserConfig' => [ - 'title' => '用户自定义配置', - 'description' => 'User-defined configuration.'."\n", - 'type' => 'string', - 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', - ], - 'TemplateVersion' => [ - 'title' => '软件栈版本', - 'description' => 'The version of the software stack.'."\n", - 'type' => 'string', - 'example' => '2.4.1-1.0-0.0.1', - ], - 'ProductCode' => [ - 'title' => '商品code', - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'milvus_milvuspre_public_cn', - ], - 'ResourceGroupId' => [ - 'title' => '资源组id', - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-123xxx', - ], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-123xxx', 'title' => ''], + 'VswId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-123xxx', 'title' => ''], + 'SgId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-123xxx', 'title' => ''], + 'OpenPublicNet' => ['description' => 'Indicates whether the public endpoint is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ClusterName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'aliyun-test', 'title' => ''], + 'PayType' => ['description' => 'The billing method. Possible values:'."\n" + ."\n" + .'- `0`: Pay-as-you-go.'."\n" + ."\n" + .'- `1`: Subscription.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BucketName' => ['description' => 'The OSS bucket name.', 'type' => 'string', 'example' => 'milvus-test', 'title' => ''], + 'BucketPath' => ['description' => 'The path to the data within the OSS bucket.', 'type' => 'string', 'example' => 'https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx', 'title' => ''], + 'Version' => ['description' => 'The Milvus version.', 'type' => 'string', 'example' => '2.4', 'title' => ''], + 'AclId' => ['description' => 'The ID of the access control list (ACL) for the public endpoint.', 'type' => 'string', 'example' => 'acl-123xxx', 'title' => ''], + 'UserConfig' => ['description' => 'The custom configurations for the instance.', 'type' => 'string', 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', 'title' => ''], + 'TemplateVersion' => ['description' => 'The software stack version.', 'type' => 'string', 'example' => '2.4.1-1.0-0.0.1', 'title' => ''], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'milvus_milvuspre_public_cn', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-123xxx', 'title' => ''], 'MeasureConfig' => [ - 'description' => '', + 'description' => 'The resource allocation for each node type.', 'type' => 'object', 'properties' => [ - 'ProxyNodeCuNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'IndexNodeCuNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'QueryNodeCuNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'DataNodeCuNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'MixCoodinatorNodeCuNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'IndexNodeReplica' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'QueryNodeReplica' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DataNodeReplica' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'MixCoodinatorNodeReplica' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ProxyNodeReplica' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'ProxyNodeCuNum' => ['description' => 'The number of CUs for each proxy node.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'IndexNodeCuNum' => ['description' => 'The number of CUs for each index node.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'QueryNodeCuNum' => ['description' => 'The number of CUs for each query node.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'DataNodeCuNum' => ['description' => 'The number of CUs for each data node.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MixCoodinatorNodeCuNum' => ['description' => 'The number of CUs for each mix-coordinator node.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'IndexNodeReplica' => ['description' => 'The number of replicas for index nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'QueryNodeReplica' => ['description' => 'The number of replicas for query nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DataNodeReplica' => ['description' => 'The number of replicas for data nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'MixCoodinatorNodeReplica' => ['description' => 'The number of replicas for mix-coordinator nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ProxyNodeReplica' => ['description' => 'The number of replicas for proxy nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'EnableHa' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'perf', - ], + 'EnableHa' => ['description' => 'Indicates whether high availability (HA) is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NodeType' => ['description' => 'The node type. Possible values:'."\n" + ."\n" + .'- `perf`: Compute-optimized.'."\n" + ."\n" + .'- `cap`: Storage-optimized.', 'type' => 'string', 'example' => 'perf', 'title' => ''], 'Tags' => [ - 'description' => '', + 'description' => 'The tags that are attached to the instance.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A tag object.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'value1', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Encrypted' => [ - 'type' => 'string', - ], - 'KmsKeyId' => [ - 'type' => 'string', - ], - 'MultiZoneMode' => [ - 'title' => 'Single,Two,Three', - 'type' => 'string', + 'Encrypted' => ['description' => 'Indicates whether disk encryption with Key Management Service (KMS) is enabled.', 'type' => 'string', 'title' => '', 'example' => ''], + 'KmsKeyId' => ['description' => 'The ID of the key from Key Management Service (KMS) used for disk encryption. This parameter is returned only when disk encryption is enabled.', 'type' => 'string', 'title' => '', 'example' => ''], + 'MultiZoneMode' => ['description' => 'The deployment mode for a multi-zone instance. This parameter is returned only when high availability is enabled across multiple availability zones.', 'type' => 'string', 'title' => '', 'example' => ''], + 'HighAvailability' => [ + 'type' => 'object', + 'properties' => [ + 'Mode' => ['description' => 'The high availability mode. A common value is `Multi-zone`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'PrimaryZoneId' => ['description' => 'The ID of the primary availability zone in an HA setup.', 'type' => 'string', 'title' => '', 'example' => ''], + 'SecondaryZoneId' => ['description' => 'The ID of the secondary availability zone in an HA setup.', 'type' => 'string', 'title' => '', 'example' => ''], + 'CurrentActiveAZ' => ['description' => 'The availability zone that is currently active.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'Details about the high availability (HA) configuration.', + 'title' => '', + 'example' => '', ], 'VSwitches' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'VswId' => [ - 'type' => 'string', - ], - 'ZoneId' => [ - 'type' => 'string', - ], + 'VswId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ZoneId' => ['description' => 'The ID of the availability zone where the vSwitch is located.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'A vSwitch object.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of vSwitches associated with the instance, typically used in a multi-zone deployment.', + 'title' => '', + 'example' => '', ], - 'HighAvailability' => [ - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'type' => 'string', - ], - 'PrimaryZoneId' => [ - 'type' => 'string', - ], - 'SecondaryZoneId' => [ - 'type' => 'string', - ], - 'CurrentActiveAZ' => [ - 'type' => 'string', - ], + 'MaintainablePeriod' => ['description' => 'The maintenance window for the instance. The format is `HH:mmZ-HH:mmZ`.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], + ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'GetInstanceDetail', + 'summary' => 'Retrieves the details of a specific instance.', + 'changeSet' => [ + ['createdAt' => '2025-03-19T10:02:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-24T07:52:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-02T11:43:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-28T06:24:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-25T02:00:10.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceDetail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:GetInstanceDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"c-123xxx\\",\\n \\"BeginTime\\": 1716863508000,\\n \\"RunningTime\\": 1743679,\\n \\"ExpireTime\\": 1721664000000,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-g\\",\\n \\"InstanceStatus\\": \\"running\\",\\n \\"PackageType\\": \\"standard\\",\\n \\"ClusterInfo\\": {\\n \\"MilvusResourceInfoList\\": [\\n {\\n \\"ComponentType\\": \\"standalone\\",\\n \\"CuNum\\": 8,\\n \\"CuRatio\\": 4,\\n \\"Replica\\": 2,\\n \\"DiskSize\\": 100,\\n \\"DiskType\\": \\"essd\\",\\n \\"ZoneId\\": \\"\\",\\n \\"PayType\\": \\"\\"\\n }\\n ],\\n \\"IntranetUrl\\": \\"c-123xxx-internal.milvus.aliyuncs.com\\",\\n \\"InternetUrl\\": \\"c-123xxx-.milvus.aliyuncs.com\\",\\n \\"TotalCuNum\\": 24,\\n \\"TotalDiskSize\\": 500,\\n \\"ProxyPort\\": 19530,\\n \\"AttuPort\\": 3000,\\n \\"OssStorageTimestamp\\": 1718604000000,\\n \\"OssStorageSize\\": \\"125.15 GB\\"\\n },\\n \\"VpcId\\": \\"vpc-123xxx\\",\\n \\"VswId\\": \\"vsw-123xxx\\",\\n \\"SgId\\": \\"sg-123xxx\\",\\n \\"OpenPublicNet\\": true,\\n \\"ClusterName\\": \\"aliyun-test\\",\\n \\"PayType\\": 1,\\n \\"BucketName\\": \\"milvus-test\\",\\n \\"BucketPath\\": \\"https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx\\",\\n \\"Version\\": \\"2.4\\",\\n \\"AclId\\": \\"acl-123xxx\\",\\n \\"UserConfig\\": \\"dataCoord:\\\\\\\\n segment:\\\\\\\\n maxSize: 1024\\",\\n \\"TemplateVersion\\": \\"2.4.1-1.0-0.0.1\\",\\n \\"ProductCode\\": \\"milvus_milvuspre_public_cn\\",\\n \\"ResourceGroupId\\": \\"rg-123xxx\\",\\n \\"MeasureConfig\\": {\\n \\"ProxyNodeCuNum\\": 4,\\n \\"IndexNodeCuNum\\": 4,\\n \\"QueryNodeCuNum\\": 4,\\n \\"DataNodeCuNum\\": 4,\\n \\"MixCoodinatorNodeCuNum\\": 4,\\n \\"IndexNodeReplica\\": 2,\\n \\"QueryNodeReplica\\": 2,\\n \\"DataNodeReplica\\": 2,\\n \\"MixCoodinatorNodeReplica\\": 2,\\n \\"ProxyNodeReplica\\": 2\\n },\\n \\"EnableHa\\": true,\\n \\"NodeType\\": \\"perf\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Encrypted\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"MultiZoneMode\\": \\"\\",\\n \\"HighAvailability\\": {\\n \\"Mode\\": \\"\\",\\n \\"PrimaryZoneId\\": \\"\\",\\n \\"SecondaryZoneId\\": \\"\\",\\n \\"CurrentActiveAZ\\": \\"\\"\\n },\\n \\"VSwitches\\": [\\n {\\n \\"VswId\\": \\"\\",\\n \\"ZoneId\\": \\"\\"\\n }\\n ],\\n \\"MaintainablePeriod\\": \\"\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', + ], + 'ListAclGroups' => [ + 'path' => '/webapi/milvus/listAclGroups', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREmilvus0MDRCH'], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'accessDeniedDetail' => ['description' => 'Details about the access denial. Returned only for requests denied due to insufficient RAM permissions.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66A13C31-473A-5B3A-8974-0B07A40649CF', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cidrs' => [ + 'type' => 'array', + 'items' => ['description' => 'A CIDR block.', 'type' => 'string', 'example' => '140.205.11.0/24,140.205.11.2', 'title' => ''], + 'description' => 'The CIDR blocks in the group.', + 'title' => '', + 'example' => '', ], + 'createTime' => ['description' => 'The timestamp of the group\'s creation.', 'type' => 'string', 'example' => '2022-10-17T13:53:27Z', 'title' => ''], + 'groupName' => ['description' => 'The group name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'id' => ['description' => 'The group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '376774', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c-xxx', 'title' => ''], + 'uid' => ['description' => 'The ID of the Alibaba Cloud account. This parameter is read-only.', 'type' => 'integer', 'format' => 'int64', 'example' => '50832118', 'title' => ''], ], + 'description' => 'An ACL group.', + 'title' => '', + 'example' => '', ], - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"c-123xxx\\",\\n \\"BeginTime\\": 1716863508000,\\n \\"RunningTime\\": 1743679,\\n \\"ExpireTime\\": 1721664000000,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-g\\",\\n \\"InstanceStatus\\": \\"running\\",\\n \\"PackageType\\": \\"standard\\",\\n \\"ClusterInfo\\": {\\n \\"MilvusResourceInfoList\\": [\\n {\\n \\"ComponentType\\": \\"standalone\\",\\n \\"CuNum\\": 8,\\n \\"CuRatio\\": 4,\\n \\"Replica\\": 2,\\n \\"DiskSize\\": 100,\\n \\"DiskType\\": \\"essd\\",\\n \\"ZoneId\\": \\"\\"\\n }\\n ],\\n \\"IntranetUrl\\": \\"c-123xxx-internal.milvus.aliyuncs.com\\",\\n \\"InternetUrl\\": \\"c-123xxx-.milvus.aliyuncs.com\\",\\n \\"TotalCuNum\\": 24,\\n \\"TotalDiskSize\\": 500,\\n \\"ProxyPort\\": 19530,\\n \\"AttuPort\\": 3000,\\n \\"OssStorageTimestamp\\": 1718604000000,\\n \\"OssStorageSize\\": \\"125.15 GB\\"\\n },\\n \\"VpcId\\": \\"vpc-123xxx\\",\\n \\"VswId\\": \\"vsw-123xxx\\",\\n \\"SgId\\": \\"sg-123xxx\\",\\n \\"OpenPublicNet\\": true,\\n \\"ClusterName\\": \\"aliyun-test\\",\\n \\"PayType\\": 1,\\n \\"BucketName\\": \\"milvus-test\\",\\n \\"BucketPath\\": \\"https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx\\",\\n \\"Version\\": \\"2.4\\",\\n \\"AclId\\": \\"acl-123xxx\\",\\n \\"UserConfig\\": \\"dataCoord:\\\\\\\\n segment:\\\\\\\\n maxSize: 1024\\",\\n \\"TemplateVersion\\": \\"2.4.1-1.0-0.0.1\\",\\n \\"ProductCode\\": \\"milvus_milvuspre_public_cn\\",\\n \\"ResourceGroupId\\": \\"rg-123xxx\\",\\n \\"MeasureConfig\\": {\\n \\"ProxyNodeCuNum\\": 4,\\n \\"IndexNodeCuNum\\": 4,\\n \\"QueryNodeCuNum\\": 4,\\n \\"DataNodeCuNum\\": 4,\\n \\"MixCoodinatorNodeCuNum\\": 4,\\n \\"IndexNodeReplica\\": 2,\\n \\"QueryNodeReplica\\": 2,\\n \\"DataNodeReplica\\": 2,\\n \\"MixCoodinatorNodeReplica\\": 2,\\n \\"ProxyNodeReplica\\": 2\\n },\\n \\"EnableHa\\": true,\\n \\"NodeType\\": \\"perf\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Encrypted\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"MultiZoneMode\\": \\"\\",\\n \\"VSwitches\\": [\\n {\\n \\"VswId\\": \\"\\",\\n \\"ZoneId\\": \\"\\"\\n }\\n ],\\n \\"HighAvailability\\": {\\n \\"Mode\\": \\"\\",\\n \\"PrimaryZoneId\\": \\"\\",\\n \\"SecondaryZoneId\\": \\"\\",\\n \\"CurrentActiveAZ\\": \\"\\"\\n }\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', - 'title' => 'GetInstanceDetail', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAclGroups', + 'summary' => 'Retrieves one or more access control list (ACL) groups.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"accessDeniedDetail\\": \\"None\\",\\n \\"requestId\\": \\"66A13C31-473A-5B3A-8974-0B07A40649CF\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"cidrs\\": [\\n \\"140.205.11.0/24,140.205.11.2\\"\\n ],\\n \\"createTime\\": \\"2022-10-17T13:53:27Z\\",\\n \\"groupName\\": \\"test\\",\\n \\"id\\": 376774,\\n \\"instanceId\\": \\"c-xxx\\",\\n \\"uid\\": 50832118\\n }\\n ]\\n}","type":"json"}]', ], 'ListInstances' => [ - 'summary' => 'Get the list of Milvus instances under the current account.', + 'summary' => 'Retrieves a list of Milvus instances in the current account.', 'path' => '/webapi/order/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1614,113 +1518,61 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => '集群名称', - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'milvus-test', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'milvus-test', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c-123xxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => 'The region code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '资源组id', - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-123xxx', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-123xxx', 'title' => '', 'required' => false], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The tags used to filter instances.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A tag object.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + '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, + 'title' => '', + 'example' => '', ], ], ], @@ -1729,343 +1581,182 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', 'title' => ''], 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", + 'title' => '', + 'description' => 'An array of instance objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '集群id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'c-123xxx', - ], - 'BeginTime' => [ - 'title' => '开始时间', - 'description' => 'The start time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718608505000', - ], - 'RunningTime' => [ - 'title' => '运行时间', - 'description' => 'The runtime.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '536611', - ], - 'ExpireTime' => [ - 'title' => '过期时间', - 'description' => 'The expiration time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1721232000000', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => 'The region code.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ZoneId' => [ - 'title' => '可用区', - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing-g', - ], - 'InstanceStatus' => [ - 'title' => '状态', - 'description' => 'The status of the bastion host. Valid values:'."\n" - ."\n" - .'* creating.'."\n" - .'* running.'."\n" - .'* updating. Cluster scaling (up/down), configuration changes, and enabling/disabling public network access.'."\n" - .'* disable. The cluster has expired and needs to be renewed for activation.'."\n" - .'* deleting.'."\n" - .'* deleted.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'ClusterName' => [ - 'title' => '集群名称', - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'milvus-test', - ], - 'PackageType' => [ - 'title' => '规格', - 'description' => 'The specification details. Valid values:'."\n" - ."\n" - .'* trial.'."\n" - .'* standard.'."\n", - 'type' => 'string', - 'example' => 'trial', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c-123xxx', 'title' => ''], + 'BeginTime' => ['description' => 'The creation time of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1718608505000', 'title' => ''], + 'RunningTime' => ['description' => 'The duration the instance has been running.', 'type' => 'integer', 'format' => 'int32', 'example' => '536611', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1721232000000', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-g', 'title' => ''], + 'InstanceStatus' => ['description' => 'The instance status. Valid values:'."\n" + ."\n" + .'- `creating`: The instance is being created.'."\n" + ."\n" + .'- `running`: The instance is running.'."\n" + ."\n" + .'- `updating`: The instance is being updated. This includes scaling the instance, changing configurations, or modifying public network access.'."\n" + ."\n" + .'- `disable`: The instance is unavailable because it has expired and requires renewal.'."\n" + ."\n" + .'- `deleting`: The instance is being deleted.'."\n" + ."\n" + .'- `deleted`: The instance has been deleted.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'ClusterName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'milvus-test', 'title' => ''], + 'PackageType' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- `trial`: Trial Edition.'."\n" + ."\n" + .'- `standard`: Standard Edition.', 'type' => 'string', 'example' => 'trial', 'title' => ''], 'ClusterInfo' => [ - 'title' => '集群详情', - 'description' => 'The instance details.'."\n", + 'title' => '', + 'description' => 'The instance details.', 'type' => 'object', 'properties' => [ 'MilvusResourceInfoList' => [ - 'title' => '资源详情', - 'description' => 'The resource details.'."\n", + 'title' => '', + 'description' => 'A list of resource details for the instance\'s components.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ComponentType' => [ - 'title' => '组件类型', - 'description' => 'The type of the component. Valid values:'."\n" - ."\n" - .'* standalone'."\n" - .'* proxy'."\n" - .'* mix_coordinator'."\n" - .'* query'."\n" - .'* index'."\n" - .'* data'."\n", - 'type' => 'string', - 'example' => 'standalone', - ], - 'CuNum' => [ - 'title' => 'CU数量', - 'description' => 'The number of CUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'Replica' => [ - 'title' => '副本数量', - 'description' => 'The number of replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DiskSize' => [ - 'title' => '磁盘大小', - 'description' => 'The disk size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'DiskType' => [ - 'title' => '磁盘类型', - 'description' => 'The disk type.'."\n", - 'type' => 'string', - 'example' => 'essd', - ], + 'ComponentType' => ['description' => 'The component type. Valid values:'."\n" + ."\n" + .'- `standalone`'."\n" + ."\n" + .'- `proxy`'."\n" + ."\n" + .'- `mix_coordinator`'."\n" + ."\n" + .'- `query`'."\n" + ."\n" + .'- `index`'."\n" + ."\n" + .'- `data`', 'type' => 'string', 'example' => 'standalone', 'title' => ''], + 'CuNum' => ['description' => 'The number of CUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'Replica' => ['description' => 'The number of replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DiskSize' => ['description' => 'The disk size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'DiskType' => ['description' => 'The disk type.', 'type' => 'string', 'example' => 'essd', 'title' => ''], ], - 'description' => '', + 'description' => 'The details of each Milvus resource.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'IntranetUrl' => [ - 'title' => '内网地址', - 'description' => 'The internal endpoint.'."\n", - 'type' => 'string', - 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', - ], - 'InternetUrl' => [ - 'title' => '公网地址', - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => 'c-123xxx.milvus.aliyuncs.com', - ], - 'TotalCuNum' => [ - 'title' => 'CU数量', - 'description' => 'The number of CUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'TotalDiskSize' => [ - 'title' => '磁盘总量', - 'description' => 'The total capacity of the disk.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'ProxyPort' => [ - 'title' => 'Proxy端口', - 'description' => 'The proxy port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '19530', - ], - 'AttuPort' => [ - 'title' => 'attu组件端口', - 'description' => 'The port of the Attu component.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], + 'IntranetUrl' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', 'title' => ''], + 'InternetUrl' => ['description' => 'The public endpoint.', 'type' => 'string', 'example' => 'c-123xxx.milvus.aliyuncs.com', 'title' => ''], + 'TotalCuNum' => ['description' => 'The total number of CUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''], + 'TotalDiskSize' => ['description' => 'The total disk size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'ProxyPort' => ['description' => 'The proxy port.', 'type' => 'integer', 'format' => 'int32', 'example' => '19530', 'title' => ''], + 'AttuPort' => ['description' => 'The Attu port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], ], + 'example' => '', ], - 'VpcId' => [ - 'title' => '专有网络id', - 'description' => 'The virtual private cloud (VPC) ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-123xxx', - ], - 'VswId' => [ - 'title' => '交换机id', - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-123xxx', - ], - 'SgId' => [ - 'title' => '安全组id', - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-123xxx', - ], - 'OpenPublicNet' => [ - 'title' => '是否开启公网', - 'description' => 'Indicates whether Internet access is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PayType' => [ - 'title' => '付费类型', - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* 0: pay-as-you-go'."\n" - .'* 1: subscription'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProductCode' => [ - 'title' => '商品code', - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'milvus_milvuspre_public_cn', - ], - 'ResourceGroupId' => [ - 'title' => '资源组id', - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-123xxx', - ], - 'NodeType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'perf', - ], - 'AutoBackup' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-123xxx', 'title' => ''], + 'VswId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-123xxx', 'title' => ''], + 'SgId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-123xxx', 'title' => ''], + 'OpenPublicNet' => ['description' => 'Indicates whether public network access is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'PayType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- `0`: pay-as-you-go.'."\n" + ."\n" + .'- `1`: subscription.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'milvus_milvuspre_public_cn', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-123xxx', 'title' => ''], + 'NodeType' => ['description' => 'The node type.', 'type' => 'string', 'example' => 'perf', 'title' => ''], + 'AutoBackup' => ['description' => 'Indicates whether automatic backup is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Tags' => [ - 'description' => '', + 'description' => 'The tags attached to the instance.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A key-value pair that represents a tag.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'value1', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Version' => [ - 'type' => 'string', - ], + 'Version' => ['description' => 'The instance version.', 'type' => 'string', 'title' => '', 'example' => ''], + 'TemplateVersion' => ['description' => 'The template version.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'description' => '', + 'description' => 'The details of each instance.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'Total' => ['description' => 'The total number of instances found.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'Details for an access denial error.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"c-123xxx\\",\\n \\"BeginTime\\": 1718608505000,\\n \\"RunningTime\\": 536611,\\n \\"ExpireTime\\": 1721232000000,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-g\\",\\n \\"InstanceStatus\\": \\"running\\",\\n \\"ClusterName\\": \\"milvus-test\\",\\n \\"PackageType\\": \\"trial\\",\\n \\"ClusterInfo\\": {\\n \\"MilvusResourceInfoList\\": [\\n {\\n \\"ComponentType\\": \\"standalone\\",\\n \\"CuNum\\": 16,\\n \\"Replica\\": 1,\\n \\"DiskSize\\": 100,\\n \\"DiskType\\": \\"essd\\"\\n }\\n ],\\n \\"IntranetUrl\\": \\"c-123xxx-internal.milvus.aliyuncs.com\\",\\n \\"InternetUrl\\": \\"c-123xxx.milvus.aliyuncs.com\\",\\n \\"TotalCuNum\\": 24,\\n \\"TotalDiskSize\\": 500,\\n \\"ProxyPort\\": 19530,\\n \\"AttuPort\\": 3000\\n },\\n \\"VpcId\\": \\"vpc-123xxx\\",\\n \\"VswId\\": \\"vsw-123xxx\\",\\n \\"SgId\\": \\"sg-123xxx\\",\\n \\"OpenPublicNet\\": true,\\n \\"PayType\\": 1,\\n \\"ProductCode\\": \\"milvus_milvuspre_public_cn\\",\\n \\"ResourceGroupId\\": \\"rg-123xxx\\",\\n \\"NodeType\\": \\"perf\\",\\n \\"AutoBackup\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Version\\": \\"\\"\\n }\\n ],\\n \\"Total\\": 15,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', 'title' => 'ListInstances', - ], - 'UpdateInstance' => [ - 'summary' => '更新实例', - 'path' => '/webapi/instance/update', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-19T10:02:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-02-26T07:01:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-24T07:52:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-28T06:24:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-06-25T02:00:10.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'milvus:ListInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"c-123xxx\\",\\n \\"BeginTime\\": 1718608505000,\\n \\"RunningTime\\": 536611,\\n \\"ExpireTime\\": 1721232000000,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-g\\",\\n \\"InstanceStatus\\": \\"running\\",\\n \\"ClusterName\\": \\"milvus-test\\",\\n \\"PackageType\\": \\"trial\\",\\n \\"ClusterInfo\\": {\\n \\"MilvusResourceInfoList\\": [\\n {\\n \\"ComponentType\\": \\"standalone\\",\\n \\"CuNum\\": 16,\\n \\"Replica\\": 1,\\n \\"DiskSize\\": 100,\\n \\"DiskType\\": \\"essd\\"\\n }\\n ],\\n \\"IntranetUrl\\": \\"c-123xxx-internal.milvus.aliyuncs.com\\",\\n \\"InternetUrl\\": \\"c-123xxx.milvus.aliyuncs.com\\",\\n \\"TotalCuNum\\": 24,\\n \\"TotalDiskSize\\": 500,\\n \\"ProxyPort\\": 19530,\\n \\"AttuPort\\": 3000\\n },\\n \\"VpcId\\": \\"vpc-123xxx\\",\\n \\"VswId\\": \\"vsw-123xxx\\",\\n \\"SgId\\": \\"sg-123xxx\\",\\n \\"OpenPublicNet\\": true,\\n \\"PayType\\": 1,\\n \\"ProductCode\\": \\"milvus_milvuspre_public_cn\\",\\n \\"ResourceGroupId\\": \\"rg-123xxx\\",\\n \\"NodeType\\": \\"perf\\",\\n \\"AutoBackup\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Version\\": \\"\\",\\n \\"TemplateVersion\\": \\"\\"\\n }\\n ],\\n \\"Total\\": 15,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', + ], + 'ListInstancesV2' => [ + 'path' => '/webapi/instance/list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -2073,107 +1764,65 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false], ], [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, + 'name' => 'instanceName', + 'in' => 'query', + 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'milvus-test', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-123xxx', 'title' => '', 'required' => false], + ], + [ + 'name' => 'tag', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c-xxxx', - ], - 'instanceName' => [ - 'title' => '实例名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'milvus-test', - ], - 'configuration' => [ - 'title' => '配置信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rootCoord:\\n maxDatabaseNum: 64', - ], - 'ha' => [ - 'title' => '是否开启高可用', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'autoBackup' => [ - 'title' => '是否开启自动备份', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'components' => [ - 'title' => '组件信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '组件类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'standalone', - ], - 'replica' => [ - 'title' => '副本数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'cuNum' => [ - 'title' => 'CU数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8', - ], - ], - 'required' => false, - ], - 'required' => false, + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'k1', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], + 'description' => 'A list of tags in JSON format.', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'description' => 'A list of tags in JSON format.', 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'clientToken', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => 'The maximum number of records to return in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The paging token for the next request. This is not yet available.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''], ], ], 'responses' => [ @@ -2181,43 +1830,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'instances' => [ + 'type' => 'array', + 'items' => ['description' => 'The instance information.', '$ref' => '#/components/schemas/InstanceDetail', 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'A list of instances.', + 'example' => '', ], + 'nextToken' => ['description' => 'The paging token. This is not yet available.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListInstancesV2', + 'summary' => 'Searches for clusters by ID or name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"data\\": true\\n}","type":"json"}]', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'milvus:ListInstancesV2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"total\\": 15,\\n \\"instances\\": [\\n {\\n \\"instanceName\\": \\"milvus-test\\",\\n \\"instanceId\\": \\"c-xxx\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"status\\": \\"running\\",\\n \\"paymentType\\": \\"PayAsYouGo\\",\\n \\"resourceGroupId\\": \\"rg-aek3dcgyq7pnqwa\\",\\n \\"vpcId\\": \\"vpc-xxx\\",\\n \\"createTime\\": \\"2025-04-27T02:04:25Z\\",\\n \\"runningTime\\": 1,\\n \\"expireTime\\": \\"2025-04-27T02:04:25Z\\\\n\\",\\n \\"dbVersion\\": \\"2.5\\",\\n \\"orderId\\": \\"4751\\",\\n \\"autoBackup\\": true,\\n \\"configuration\\": \\"rootCoord:\\\\n maxDatabaseNum: 64 # Maximum number of database\\\\n maxPartitionNum: 4096 \\",\\n \\"ha\\": true,\\n \\"multiZoneMode\\": \\"Single\\",\\n \\"encrypted\\": false,\\n \\"kmsKeyId\\": \\"key-xxx\\",\\n \\"vSwitchIds\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"vswId\\": \\"vsw-xxx\\"\\n }\\n ],\\n \\"securityGroupIds\\": [\\n \\"sg-xxx\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"k1\\",\\n \\"value\\": \\"v1\\"\\n }\\n ],\\n \\"components\\": [\\n {\\n \\"type\\": \\"data\\",\\n \\"replica\\": 1,\\n \\"cuNum\\": 4,\\n \\"cuType\\": \\"general\\",\\n \\"diskSizeType\\": \\"Normal\\",\\n \\"payType\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"None\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', ], 'ModifyInstanceConfig' => [ - 'summary' => 'Update the configuration parameters of each component of Milvus.', + 'summary' => 'Modifies the configuration parameters for Milvus components.', 'path' => '/webapi/config/modify_milvus_config', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2229,43 +1887,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', 'title' => ''], ], [ 'name' => 'Reason', 'in' => 'query', - 'schema' => [ - 'title' => '更新原因', - 'description' => 'The reason for the update.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'for test', - ], + 'schema' => ['description' => 'The reason for the modification.', 'type' => 'string', 'required' => true, 'example' => 'for test', 'title' => ''], ], [ 'name' => 'UserConfig', 'in' => 'query', - 'schema' => [ - 'title' => '用户自定义配置', - 'description' => 'User-defined configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', - ], + 'schema' => ['description' => 'The custom user configuration.', 'type' => 'string', 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -2273,70 +1911,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details of the access denied error.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyInstanceConfig', - ], - 'DescribeInstanceConfigs' => [ - 'summary' => 'Get information about the custom configuration of each component of Milvus.', - 'path' => '/webapi/config/describe_milvus_user_config', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceConfig'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:ModifyInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to resources.', + 'path' => '/webapi/tags', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2345,23 +1961,53 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeCode' => '236086', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '集群实例id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The resource type.', 'example' => 'instance'], + 'RegionId' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The region ID.', 'example' => 'cn-zhangjiakou'], + 'ResourceId' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'The ID of a resource.', 'required' => false, 'title' => '', 'example' => 'c-xx'], + 'required' => true, + 'title' => '', + 'description' => 'The IDs of the resources. You can specify up to 50 resource IDs.', + 'example' => '', + ], + 'Tag' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'title' => '', 'description' => 'The tag key.', 'required' => false, 'example' => 'k1'], + 'Value' => ['type' => 'string', 'title' => '', 'description' => 'The tag value.', 'required' => false, 'example' => 'v1'], + ], + 'description' => 'The information about the tag.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'description' => 'The tags to add to the resources. You can add up to 20 tags.', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2370,72 +2016,28 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx.', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", - 'type' => 'string', - 'format' => 'byte', - 'example' => 'dataCoord:\\n enableCompaction: true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => 'ABCD-1234-5678-EFGH'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'TagResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx.\\",\\n \\"Data\\": \\"dataCoord:\\\\\\\\n enableCompaction: true\\",\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', - 'title' => 'DescribeInstanceConfigs', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', ], - 'DescribeAccessControlList' => [ - 'summary' => 'Get the public IP address whitelist of a Milvus instance.', - 'path' => '/webapi/milvus/describe_access_control_list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UnTagResources' => [ + 'summary' => 'Remove resource tags.', + 'path' => '/webapi/tags', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2444,110 +2046,81 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeCode' => '236098', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The region ID.', 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The resource type.', 'example' => 'instance'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '集群实例id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'The resource ID.', 'required' => false, 'title' => '', 'example' => 'c-xx'], + 'required' => true, + 'title' => '', + 'description' => 'The resource IDs. A maximum of 50 resource IDs are supported.', + 'example' => '', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'A list of up to 20 tag keys for the resources.', 'required' => false, 'title' => '', 'example' => 'tk4'], + 'title' => '', + 'description' => 'The tag keys to remove. A maximum of 20 tag keys are supported.', 'required' => false, - 'example' => 'c-123xxx', + 'example' => '', ], ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'description' => 'Specifies whether to remove all tags from the resources. This parameter takes effect only when the TagKey parameter is left empty. Valid values: true and false (default).', 'example' => 'false'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'AclId' => [ - 'title' => '公网访问控制的AclId', - 'description' => 'AclId for public network access control.'."\n", - 'type' => 'string', - 'example' => 'acl-xxxx', - ], - 'Cidr' => [ - 'title' => 'Cidr块', - 'description' => 'The CIDR blocks.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'ip段', - 'description' => 'The IP address segment.'."\n", - 'type' => 'string', - 'example' => '192.168.1.2', - ], - ], - ], - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'ABCD-1234-5678-EFGH'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": {\\n \\"AclId\\": \\"acl-xxxx\\",\\n \\"Cidr\\": [\\n \\"192.168.**.**\\"\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', - 'title' => 'DescribeAccessControlList', - ], - 'UpdatePublicNetworkStatus' => [ - 'summary' => 'Enable or disable Internet access for Milvus.', - 'path' => '/webapi/network/updatePublicNetworkStatus', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UnTagResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', + ], + 'UpdateAccessControlList' => [ + 'path' => '/webapi/milvus/update_access_control_list', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2559,61 +2132,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvus0MDRCH', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', - ], - ], - [ - 'name' => 'ComponentType', - 'in' => 'query', - 'schema' => [ - 'title' => '组件类型', - 'description' => 'The component type. Valid values:'."\n" - ."\n" - .'* Proxy'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Proxy', - 'enum' => [ - 'Proxy', - ], - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c-123xxx', 'title' => '', 'required' => false], ], [ - 'name' => 'PublicNetworkEnabled', + 'name' => 'Cidr', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '开启/关闭公网', - 'description' => 'Enable /disable the Internet.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The CIDR block.', 'type' => 'string', 'example' => '192.168.**.**/24,172.1.**.**/16', 'title' => '', 'required' => false], ], [ - 'name' => 'Cidr', + 'name' => 'AclId', 'in' => 'query', - 'schema' => [ - 'title' => 'Cidr块', - 'description' => 'The CIDR blocks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.**.**/24,172.1.**.**/16', - ], + 'schema' => ['description' => 'The public access control ID.', 'type' => 'string', 'example' => 'acl-123xxx', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -2621,118 +2156,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code of the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ILLEGAL.MilvusCidrFormat', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The format of cidr is illegal.', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'UpdateAccessControlList', + 'summary' => 'Sets the IP address whitelist for public access to a Milvus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccessControlList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdateAccessControlList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Failed to find instance\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', - 'title' => 'UpdatePublicNetworkStatus', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"ILLEGAL.MilvusCidrFormat\\",\\n \\"ErrMessage\\": \\"The format of cidr is illegal.\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', ], - 'UpdateAccessControlList' => [ - 'summary' => 'Configure Public IP Address Whitelist', - 'path' => '/webapi/milvus/update_access_control_list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateAclGroupCidrs' => [ + 'path' => '/webapi/milvus/updateAclGroupCidrs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvus0MDRCH'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'groupName', 'in' => 'query', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c-123xxx', - ], + 'schema' => ['description' => 'The name of the allow list group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Cidr', + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'Cidr块', - 'description' => 'The CIDR blocks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.0/24,172.16.0.0/16', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'c-xxxx', 'title' => ''], ], [ - 'name' => 'AclId', + 'name' => 'newCidrs', 'in' => 'query', - 'schema' => [ - 'title' => '公网访问控制id', - 'description' => 'The ID of public network access control'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acl-123xxx', - ], + 'schema' => ['description' => 'The new CIDR blocks for the allow list group. To specify multiple CIDR blocks, separate them with a comma.', 'type' => 'string', 'required' => false, 'example' => '140.205.11.0/24,140.205.11.2', 'title' => ''], ], ], 'responses' => [ @@ -2740,180 +2233,149 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'ILLEGAL.MilvusCidrFormat', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The format of cidr is illegal.', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => 'The detailed information about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'accessDeniedDetail' => ['description' => 'Details about why access was denied. Returned only when RAM denies access due to insufficient permissions.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CB356AEE-6B3F-5FC8-9C2C-7B2D881EA9E2', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'data' => ['description' => 'A value of `true` indicates that the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '[RDS%22]', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"ILLEGAL.MilvusCidrFormat\\",\\n \\"ErrMessage\\": \\"The format of cidr is illegal.\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', - 'title' => 'UpdateAccessControlList', - ], - 'TagResources' => [ - 'summary' => '打标', - 'path' => '/webapi/tags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateAclGroupCidrs', + 'summary' => 'Modifies the CIDR blocks in a specified allow list group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"accessDeniedDetail\\": \\"None\\",\\n \\"requestId\\": \\"CB356AEE-6B3F-5FC8-9C2C-7B2D881EA9E2\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true,\\n \\"errMessage\\": \\"[RDS%22]\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\"\\n}","type":"json"}]', + ], + 'UpdateInstance' => [ + 'path' => '/webapi/instance/update', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236086', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeCode' => '197636', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false], + ], + [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-zhangjiakou', - ], - 'ResourceId' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c-xx', - ], - 'required' => true, - ], - 'Tag' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'c-xxxx', 'title' => ''], + 'instanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'milvus-test', 'title' => '', 'required' => false], + 'configuration' => ['description' => 'The instance configuration settings.', 'type' => 'string', 'example' => 'rootCoord:\\n maxDatabaseNum: 64', 'title' => '', 'required' => false], + 'ha' => ['description' => 'Specifies whether to enable high availability (HA).', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], + 'autoBackup' => ['description' => 'Specifies whether to enable automatic backup.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], + 'autoPay' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'components' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'k1', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], + 'type' => ['description' => 'The component type.', 'type' => 'string', 'required' => true, 'example' => 'standalone', 'title' => ''], + 'replica' => ['description' => 'The number of replicas.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + 'cuNum' => ['description' => 'The number of CUs.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8', 'title' => ''], + 'payType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'cuType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => 'Specifications for each component.', 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, + 'title' => '', + 'description' => 'The component settings for the instance.', + 'required' => false, + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The value must be unique across requests and can be up to 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'data' => ['description' => 'Indicates if the update operation succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'orderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', - ], - 'UnTagResources' => [ - 'summary' => '删除标签', - 'path' => '/webapi/tags', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateInstance', + 'summary' => 'Updates a specified instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"orderId\\": \\"\\"\\n}","type":"json"}]', + ], + 'UpdateInstanceName' => [ + 'summary' => 'Changes the name of an instance.', + 'path' => '/webapi/cluster/update_name', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2922,82 +2384,21 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236098', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREmilvusGDAFRH'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], - ], - [ - 'name' => 'ResourceId', + 'name' => 'ClusterName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c-xx', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'milvus-test', 'title' => ''], ], [ - 'name' => 'TagKey', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '对应标签键列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tk4', - ], - 'required' => false, - ], - ], - [ - 'name' => 'All', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', 'title' => ''], ], ], 'responses' => [ @@ -3005,29 +2406,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'Details about the access denied error.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', - ], - 'ChangeResourceGroup' => [ - 'summary' => '资源转组', - 'path' => '/webapi/resourceGroup/change', - 'methods' => [ - 'post', + 'title' => 'UpdateInstanceName', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceName'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdateInstanceName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', + ], + 'UpdatePublicNetworkStatus' => [ + 'path' => '/webapi/network/updatePublicNetworkStatus', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3039,63 +2457,39 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '234796', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvus0MDRCH'], ], 'parameters' => [ [ - 'name' => 'NewResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '目标资源组', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acfnsjj5tgai4wi', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '地域Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'ComponentType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The component type. Valid value:'."\n" + ."\n" + .'- Proxy', 'type' => 'string', - 'required' => false, - 'example' => 'instance', + 'required' => true, + 'example' => 'Proxy', + 'enum' => ['Proxy'], + 'title' => '', ], ], [ - 'name' => 'ResourceId', + 'name' => 'PublicNetworkEnabled', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c-xxx', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'Specifies whether to enable public network access.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Cidr', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-123xxx', - ], + 'schema' => ['description' => 'The CIDR block.', 'type' => 'string', 'required' => false, 'example' => '192.168.**.**/24,172.1.**.**/16', 'title' => ''], ], ], 'responses' => [ @@ -3103,179 +2497,405 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => 'AccessDeniedDetail', - 'description' => 'AccessDeniedDetail', - 'type' => 'string', - 'example' => 'None', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Failed to find instance', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'Details about the access denied error.', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', - ], - 'CreateDefaultRole' => [ - 'summary' => 'Create a service role for Milvus to access other cloud products', - 'path' => '/webapi/user/create_default_role', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvusGDAFRH', - ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => 'The error code'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情 ', - 'description' => 'The details about the failed permission verification.'."\n", - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" } ', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdatePublicNetworkStatus', + 'summary' => 'Enables or disables public network access for a Milvus instance.', + 'changeSet' => [ + ['createdAt' => '2024-08-03T07:43:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-30T10:24:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-12T10:05:06.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePublicNetworkStatus'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdatePublicNetworkStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\\\t\\"\\n}","type":"json"}]', - 'title' => 'CreateDefaultRole', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Failed to find instance\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.ap-southeast-1.aliyuncs.com', 'endpoint' => 'milvus.ap-southeast-1.aliyuncs.com', 'vpc' => 'milvus-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.cn-beijing.aliyuncs.com', 'endpoint' => 'milvus.cn-beijing.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.cn-hangzhou.aliyuncs.com', 'endpoint' => 'milvus.cn-hangzhou.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.cn-hongkong.aliyuncs.com', 'endpoint' => 'milvus.cn-hongkong.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.cn-shanghai.aliyuncs.com', 'endpoint' => 'milvus.cn-shanghai.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.cn-shenzhen.aliyuncs.com', 'endpoint' => 'milvus.cn-shenzhen.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'milvus.cn-wulanchabu.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'milvus.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'milvus.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'milvus.eu-central-1.aliyuncs.com', 'endpoint' => 'milvus.eu-central-1.aliyuncs.com', 'vpc' => 'milvus-vpc.eu-central-1.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'milvus.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetInstanceDetail'], + ['description' => 'Response parameters changed', 'api' => 'ListInstances'], + ], + 'createdAt' => '2024-12-24T07:52:46.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'milvus.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetInstanceDetail'], + ], + 'createdAt' => '2024-12-02T11:43:37.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'milvus.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetInstanceDetail'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListInstances'], + ], + 'createdAt' => '2024-08-28T06:24:39.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'milvus.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdatePublicNetworkStatus'], + ], + 'createdAt' => '2024-08-03T07:43:56.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'milvus.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdatePublicNetworkStatus'], + ], + 'createdAt' => '2024-07-30T10:24:52.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'milvus.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdatePublicNetworkStatus'], + ], + 'createdAt' => '2024-07-12T10:05:11.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'milvus.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetInstanceDetail'], + ['description' => 'Response parameters changed', 'api' => 'ListInstances'], + ], + 'createdAt' => '2024-06-25T02:00:16.000Z', + 'description' => '', ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'milvus.ap-southeast-1.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceName'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceConfigs'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccessControlList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDefaultRole'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceDetail'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePublicNetworkStatus'], ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'milvus.eu-central-1.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'Milvus', + 'productName' => 'Vector Retrieval Service for Milvus', + 'ramCodes' => ['milvus'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [ + [ + 'name' => 'oss:BucketTag/Product', + 'schema' => ['type' => 'String', 'description' => 'ServerlessMilvus'], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'milvus:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAccessControlList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:DescribeAccessControlList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UnTagResources', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'milvus:UnTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAclGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'milvus:CreateAclGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateDefaultRole', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'milvus:CreateDefaultRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:ModifyInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstanceName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdateInstanceName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceConfigs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:DescribeInstanceConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdatePublicNetworkStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdatePublicNetworkStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'milvus:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], + [ + 'apiName' => 'ListAclGroups', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'milvus:ListAclGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'milvus:DeleteInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:GetInstanceDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateAclGroupCidrs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'milvus:UpdateAclGroupCidrs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateAccessControlList', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdateAccessControlList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'milvus:GetInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListInstancesV2', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'milvus:ListInstancesV2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'milvus:ListInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'UserResource', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/*'], ], ], ]; |