diff options
Diffstat (limited to 'data/zh_cn/milvus/2023-10-12')
| -rw-r--r-- | data/zh_cn/milvus/2023-10-12/api-docs.php | 4280 |
1 files changed, 1709 insertions, 2571 deletions
diff --git a/data/zh_cn/milvus/2023-10-12/api-docs.php b/data/zh_cn/milvus/2023-10-12/api-docs.php index 109a377..a7bd55f 100644 --- a/data/zh_cn/milvus/2023-10-12/api-docs.php +++ b/data/zh_cn/milvus/2023-10-12/api-docs.php @@ -1,55 +1,30 @@ <?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' => '实例管理', + 'children' => ['ListInstancesV2', 'UpdateInstanceName'], 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'GetInstance', - 'ListInstancesV2', - 'DeleteInstance', - 'UpdateInstanceName', - 'GetInstanceDetail', - 'ListInstances', - 'UpdateInstance', - ], + 'title' => '实例管理', + 'id' => 207254, ], [ - 'id' => 321599, - 'title' => '实例配置', + 'children' => ['DescribeInstanceConfigs'], 'type' => 'directory', - 'children' => [ - 'ModifyInstanceConfig', - 'DescribeInstanceConfigs', - ], + 'title' => '实例配置', + 'id' => 207258, ], [ - 'id' => 321602, - 'title' => '实例安全', + 'children' => ['DescribeAccessControlList', 'UpdatePublicNetworkStatus', 'UpdateAccessControlList', 'CreateAclGroup', 'UpdateAclGroupCidrs', 'ListAclGroups'], 'type' => 'directory', - 'children' => [ - 'DescribeAccessControlList', - 'UpdatePublicNetworkStatus', - 'UpdateAccessControlList', - ], + 'title' => '实例安全', + 'id' => 207261, ], [ - 'id' => 321606, - 'title' => '其他', + 'children' => ['CreateDefaultRole', 'GetInstanceDetail', 'ChangeResourceGroup', 'CreateInstance', 'DeleteInstance', 'GetInstance', 'ListInstances', 'ModifyInstanceConfig', 'TagResources', 'UnTagResources', 'UpdateInstance'], 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UnTagResources', - 'ChangeResourceGroup', - 'CreateDefaultRole', - ], + 'title' => '其他', + 'id' => 207265, ], ], 'components' => [ @@ -57,62 +32,32 @@ 'DBVersionDetail' => [ 'type' => 'object', 'properties' => [ - 'version' => [ - 'type' => 'string', - ], - 'status' => [ - 'type' => 'string', - ], + 'version' => ['type' => 'string'], + 'status' => ['type' => 'string'], 'specs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'zoneMode' => [ - 'type' => 'string', - ], - 'isStandalone' => [ - 'type' => 'boolean', - ], - 'isStandalonePro' => [ - 'type' => 'boolean', - ], - 'isHA' => [ - 'type' => 'boolean', - ], + 'zoneMode' => ['type' => 'string'], + 'isStandalone' => ['type' => 'boolean'], + 'isStandalonePro' => ['type' => 'boolean'], + 'isHA' => ['type' => 'boolean'], 'componentSpecs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'name' => [ - 'type' => 'string', - ], - 'type' => [ - 'type' => 'string', - ], + 'name' => ['type' => 'string'], + 'type' => ['type' => 'string'], 'specs' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'minReplicas' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'maxReplicas' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'step' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'defaultReplicas' => [ - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['type' => 'string'], ], + 'minReplicas' => ['type' => 'integer', 'format' => 'int32'], + 'maxReplicas' => ['type' => 'integer', 'format' => 'int32'], + 'step' => ['type' => 'integer', 'format' => 'int32'], + 'defaultReplicas' => ['type' => 'integer', 'format' => 'int32'], ], ], ], @@ -121,128 +66,91 @@ ], ], ], + 'DlfDatabase' => [ + 'type' => 'object', + 'properties' => [ + 'databaseName' => ['title' => '数据库名称', 'type' => 'string', 'example' => 'my_database'], + 'description' => ['title' => '数据库描述', 'type' => 'string', 'example' => 'Test database'], + 'tableCount' => ['title' => '表数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + 'DlfFieldSchema' => [ + 'type' => 'object', + 'properties' => [ + 'fieldName' => ['title' => '字段名称', 'type' => 'string', 'example' => 'id'], + 'dlfFieldType' => ['title' => 'DLF字段类型', 'type' => 'string', 'example' => 'BIGINT'], + 'milvusFieldType' => ['title' => 'Milvus字段类型', 'type' => 'string', 'example' => 'Int64'], + 'isPrimaryKey' => ['title' => '是否主键', 'type' => 'boolean', 'example' => 'true'], + 'isVectorField' => ['title' => '是否向量字段', 'type' => 'boolean', 'example' => 'false'], + 'dimension' => ['title' => '向量维度', 'type' => 'integer', 'format' => 'int32', 'example' => '128'], + 'nullable' => ['title' => '是否可为空', 'type' => 'boolean', 'example' => 'true'], + 'comment' => ['title' => '字段注释', 'type' => 'string', 'example' => 'Primary key field'], + 'isSupported' => ['title' => '是否支持映射', 'type' => 'boolean', 'example' => 'true'], + 'unsupportedReason' => ['title' => '不支持原因', 'type' => 'string', 'example' => 'Unsupported type'], + ], + ], + 'DlfInstance' => [ + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['title' => 'DLF实例ID', 'type' => 'string', 'example' => 'dlf-cn-xxx'], + 'instanceName' => ['title' => 'DLF实例名称', 'type' => 'string', 'example' => 'my-dlf-instance'], + 'status' => ['title' => '实例状态', 'type' => 'string', 'example' => 'RUNNING'], + 'regionId' => ['title' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceType' => ['title' => '实例类型', 'type' => 'string', 'example' => 'DLF_2_0'], + ], + ], + 'DlfTable' => [ + 'type' => 'object', + 'properties' => [ + 'tableName' => ['title' => '表名称', 'type' => 'string', 'example' => 'my_table'], + 'tableType' => ['title' => '表类型', 'type' => 'string', 'example' => 'MANAGED'], + 'description' => ['title' => '表描述', 'type' => 'string', 'example' => 'Test table'], + 'tableFormat' => ['title' => '表格式', 'type' => 'string', 'example' => 'PAIMON'], + 'location' => ['title' => '表存储位置', 'type' => 'string', 'example' => 'oss://bucket/path'], + ], + ], 'InstanceDetail' => [ 'description' => '实例详情。', 'type' => 'object', 'properties' => [ - 'instanceName' => [ - 'title' => '实例名称', - 'description' => '实例名称', - 'type' => 'string', - 'example' => 'milvus-test', - ], - 'instanceId' => [ - 'description' => '实例id。', - 'type' => 'string', - 'example' => 'c-xxx', - ], - 'regionId' => [ - 'description' => '区域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'zoneId' => [ - 'description' => '实例所在的可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'status' => [ - 'description' => '实例状态。取值范围：'."\n" - ."\n" - .'creating：创建中。'."\n" - ."\n" - .'running：运行中。'."\n" - ."\n" - .'updating：升级中。集群升降配、配置变更和开关公网等。'."\n" - ."\n" - .'disable：不可用。集群已经过期，需要续费激活。'."\n" - ."\n" - .'deleting：删除中。'."\n" - ."\n" - .'deleted：已删除。', - 'type' => 'string', - 'example' => 'running', - ], + 'instanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'milvus-test'], + 'instanceId' => ['description' => '实例id。', 'type' => 'string', 'example' => 'c-xxx'], + 'regionId' => ['description' => '区域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'zoneId' => ['description' => '实例所在的可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'status' => ['description' => '实例状态。取值范围：'."\n" + ."\n" + .'creating：创建中。'."\n" + ."\n" + .'running：运行中。'."\n" + ."\n" + .'updating：升级中。集群升降配、配置变更和开关公网等。'."\n" + ."\n" + .'disable：不可用。集群已经过期，需要续费激活。'."\n" + ."\n" + .'deleting：删除中。'."\n" + ."\n" + .'deleted：已删除。', 'type' => 'string', 'example' => 'running'], 'paymentType' => [ 'description' => '付费类型。可选值：PayAsYouGo：按量计费Subscription：包年包月', 'type' => 'string', - 'enumValueTitles' => [ - 'PayAsYouGo' => 'PayAsYouGo', - 'Subscription' => 'Subscription', - ], + 'enumValueTitles' => ['PayAsYouGo' => 'PayAsYouGo', 'Subscription' => 'Subscription'], 'example' => 'PayAsYouGo', ], - 'resourceGroupId' => [ - 'description' => '资源组ID', - 'type' => 'string', - 'example' => 'rg-aek3dcgyq7pnqwa', - ], - 'vpcId' => [ - 'description' => 'VPC网络ID。', - 'type' => 'string', - 'example' => 'vpc-xxx', - ], - 'createTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-04-27T02:04:25Z', - ], - 'runningTime' => [ - 'description' => '运行时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'expireTime' => [ - 'description' => '过期时间。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-04-27T02:04:25Z'."\n", - ], - 'dbVersion' => [ - 'description' => '实例版本。', - 'type' => 'string', - 'example' => '2.5', - ], - 'orderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '4751', - ], - 'autoBackup' => [ - 'description' => '自动备份。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'configuration' => [ - 'description' => '配置。', - 'type' => 'string', - 'example' => 'rootCoord:'."\n" - .' maxDatabaseNum: 64 # Maximum number of database'."\n" - .' maxPartitionNum: 4096 ', - ], - 'ha' => [ - 'description' => '是否开启高可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'multiZoneMode' => [ - 'title' => '', - 'description' => '多可用区。', - 'type' => 'string', - 'example' => 'Single', - ], - 'encrypted' => [ - 'description' => '是否对数据加密。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'kmsKeyId' => [ - 'description' => 'kms key Id。', - 'type' => 'string', - 'example' => 'key-xxx', - ], + 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rg-aek3dcgyq7pnqwa'], + 'vpcId' => ['description' => 'VPC网络ID。', 'type' => 'string', 'example' => 'vpc-xxx'], + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-04-27T02:04:25Z'], + 'runningTime' => ['description' => '运行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'expireTime' => ['description' => '过期时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-04-27T02:04:25Z'."\n"], + 'dbVersion' => ['description' => '实例版本。', 'type' => 'string', 'example' => '2.5'], + 'orderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '4751'], + 'autoBackup' => ['description' => '自动备份。', 'type' => 'boolean', 'example' => 'true'], + 'configuration' => ['description' => '配置。', 'type' => 'string', 'example' => 'rootCoord:'."\n" + .' maxDatabaseNum: 64 # Maximum number of database'."\n" + .' maxPartitionNum: 4096 '], + 'ha' => ['description' => '是否开启高可用。', 'type' => 'boolean', 'example' => 'true'], + 'multiZoneMode' => ['title' => '', 'description' => '多可用区。', 'type' => 'string', 'example' => 'Single'], + 'encrypted' => ['description' => '是否对数据加密。', 'type' => 'boolean', 'example' => 'false'], + 'kmsKeyId' => ['description' => 'kms key Id。', 'type' => 'string', 'example' => 'key-xxx'], 'vSwitchIds' => [ 'description' => '交换机ID。', 'type' => 'array', @@ -250,27 +158,15 @@ 'description' => '交换机ID。', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'vswId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-xxx', - ], + 'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'vswId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-xxx'], ], ], ], 'securityGroupIds' => [ 'description' => '安全组ID。', 'type' => 'array', - 'items' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-xxx', - ], + 'items' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-xxx'], ], 'tags' => [ 'description' => '标签。', @@ -279,16 +175,8 @@ 'description' => '标签。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '标签`key`值。', - 'type' => 'string', - 'example' => 'k1', - ], - 'value' => [ - 'description' => '标签`value`值。', - 'type' => 'string', - 'example' => 'v1', - ], + 'key' => ['description' => '标签`key`值。', 'type' => 'string', 'example' => 'k1'], + 'value' => ['description' => '标签`value`值。', 'type' => 'string', 'example' => 'v1'], ], ], ], @@ -299,33 +187,12 @@ 'description' => '组件信息。', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '组件类型。', - 'type' => 'string', - 'example' => 'data', - ], - 'replica' => [ - 'description' => '副本数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'cuNum' => [ - 'description' => 'CU数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'cuType' => [ - 'description' => 'CU类型。', - 'type' => 'string', - 'example' => 'general', - ], - 'diskSizeType' => [ - 'description' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', - 'type' => 'string', - 'example' => 'Normal', - ], + 'type' => ['description' => '组件类型。', 'type' => 'string', 'example' => 'data'], + 'replica' => ['description' => '副本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'cuNum' => ['description' => 'CU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'cuType' => ['description' => 'CU类型。', 'type' => 'string', 'example' => 'general'], + 'diskSizeType' => ['description' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', 'type' => 'string', 'example' => 'Normal'], + 'payType' => ['type' => 'string'], ], ], ], @@ -337,71 +204,62 @@ 'endpoint' => [ 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'type' => 'string', - ], - 'port' => [ - 'type' => 'string', - ], + 'endpoint' => ['type' => 'string'], + 'port' => ['type' => 'string'], ], ], - 'database' => [ - 'type' => 'string', - ], + 'database' => ['type' => 'string'], 'authInfo' => [ 'type' => 'object', 'properties' => [ - 'token' => [ - 'type' => 'string', - ], - 'username' => [ - 'type' => 'string', - ], - 'password' => [ - 'type' => 'string', - ], - 'authType' => [ - 'type' => 'string', - ], + 'token' => ['type' => 'string'], + 'username' => ['type' => 'string'], + 'password' => ['type' => 'string'], + 'authType' => ['type' => 'string'], ], ], ], ], + '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' => [ - 'type' => 'string', - ], - 'originalAmount' => [ - 'type' => 'string', - ], - 'tradeAmount' => [ - 'type' => 'string', - ], - 'discountAmount' => [ - 'type' => 'string', - ], - 'taxAmount' => [ - 'type' => 'string', - ], + 'currency' => ['type' => 'string'], + 'originalAmount' => ['type' => 'string'], + 'tradeAmount' => ['type' => 'string'], + 'discountAmount' => ['type' => 'string'], + 'taxAmount' => ['type' => 'string'], 'optionalPromotions' => [ 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/PromotionInfo', - ], + 'items' => ['$ref' => '#/components/schemas/PromotionInfo'], ], 'priceModules' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'originalAmount' => [ - 'type' => 'string', - ], + 'type' => ['type' => 'string'], + 'originalAmount' => ['type' => 'string'], ], ], ], @@ -410,15 +268,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ruleId' => [ - 'type' => 'string', - ], - 'amount' => [ - 'type' => 'string', - ], - 'name' => [ - 'type' => 'string', - ], + 'ruleId' => ['type' => 'string'], + 'amount' => ['type' => 'string'], + 'name' => ['type' => 'string'], ], ], ], @@ -427,52 +279,289 @@ 'PromotionInfo' => [ 'type' => 'object', 'properties' => [ - 'promotionOptionCode' => [ - 'type' => 'string', - ], - 'promotionOptionNo' => [ - 'type' => 'string', - ], - 'promotionName' => [ - 'type' => 'string', + 'promotionOptionCode' => ['type' => 'string'], + 'promotionOptionNo' => ['type' => 'string'], + 'promotionName' => ['type' => 'string'], + 'promotionDesc' => ['type' => 'string'], + 'canPromFee' => ['type' => 'string'], + 'isSelected' => ['type' => 'boolean'], + 'selected' => ['type' => 'boolean'], + ], + ], + 'RamAccount' => [ + 'type' => 'object', + 'properties' => [ + 'uid' => ['title' => '阿里云 UID', 'type' => 'string', 'example' => '1234567890123456'], + 'userName' => ['title' => 'RAM 用户名', 'type' => 'string', 'example' => 'test-user'], + 'displayName' => ['title' => '显示名称', 'type' => 'string', 'example' => 'Test User'], + 'bindable' => ['title' => '是否可绑定', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'RamBindingEntry' => [ + 'type' => 'object', + 'properties' => [ + 'milvusUsername' => ['title' => 'Milvus数据库用户名', 'type' => 'string', 'example' => 'root'], + 'boundUid' => ['title' => '绑定的阿里云UID', 'type' => 'string', 'example' => '1234567890123456'], + 'boundUserName' => ['title' => '绑定的RAM用户名', 'type' => 'string', 'example' => 'test-user'], + ], + ], + 'ScalingActivity' => [ + 'type' => 'object', + 'properties' => [ + 'scalingActivityId' => ['type' => 'string'], + 'scalingRuleName' => ['type' => 'string'], + 'scalingPolicyId' => ['type' => 'string'], + 'instanceId' => ['type' => 'string'], + 'componentTypes' => ['type' => 'string'], + 'scalingActivityState' => ['type' => 'string'], + 'startTime' => ['type' => 'string'], + 'endTime' => ['type' => 'string'], + 'policyType' => ['type' => 'string'], + 'scalingRuleDetail' => ['type' => 'string'], + 'scalingRuleId' => ['type' => 'string'], + 'timeZone' => ['type' => 'string'], + 'description' => ['type' => 'string'], + ], + ], + 'ScalingRule' => [ + 'type' => 'object', + 'properties' => [ + 'ruleId' => ['type' => 'string'], + 'scalingRuleName' => ['type' => 'string'], + 'timeZone' => ['type' => 'string'], + 'cronStr' => ['type' => 'string'], + 'startTime' => ['type' => 'integer', 'format' => 'int64'], + 'endTime' => ['type' => 'integer', 'format' => 'int64'], + 'disabled' => ['type' => 'boolean'], + 'adjustInfos' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'componentType' => ['title' => 'index query data proxy streaming mix_coordinator', 'type' => 'string'], + 'targetValue' => ['type' => 'string'], + ], + ], ], - 'promotionDesc' => [ - 'type' => 'string', + ], + ], + ], + ], + 'apis' => [ + 'ChangeResourceGroup' => [ + 'path' => '/webapi/resourceGroup/change', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234796', + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], + ], + 'parameters' => [ + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '目标资源组', 'description' => '目标资源组', 'type' => 'string', 'required' => true, 'example' => 'rg-acfnsjj5tgai4wi'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域Id', 'description' => '地域Id', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => '资源类型定义。', 'type' => 'string', 'required' => false, 'example' => 'instance'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'c-xxx'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'rg-123xxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', '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'], + ], ], - 'canPromFee' => [ - 'type' => 'string', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改资源组', + 'summary' => '资源转组', + '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'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREmilvus0MDRCH'], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'c-xxxx'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => '区域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'groupName', + 'in' => 'query', + 'schema' => ['description' => '组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'cidrs', + 'in' => 'query', + 'schema' => ['description' => '网段地址。', 'type' => 'string', 'required' => false, 'example' => '140.205.11.0/24,140.205.11.2'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'httpStatusCode' => ['description' => 'http响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BE7E95C4-10DE-5EA7-9D10-2D3E0FCCE68C'], + 'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], + 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'], + 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '[%60wget Nds0v6lx.popscan.xaliyun.com%60]'], + 'data' => ['description' => '返回结果', 'type' => 'boolean', 'example' => '{\'instanceId\': \'c-fa521a2393de4623\', \'orderId\': \'271129670950939\'}'], + 'accessDeniedDetail' => ['description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'type' => 'string', 'example' => 'None'], + ], + 'description' => '', ], - 'isSelected' => [ - 'type' => 'boolean', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建分组白名单', + 'summary' => '创建白名单分组', + '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' => ['title' => 'http请求状态码', 'description' => 'http请求状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求唯一号', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], + 'ErrCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx'], + 'Data' => ['title' => '返回数据', 'description' => '返回数据', 'type' => 'boolean', 'example' => 'true'], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情 ', 'description' => '权限校验失败详情 ', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" } '], + ], ], - 'selected' => [ - 'type' => 'boolean', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建服务角色', + 'summary' => '创建Milvus访问其它云产品所需要的服务角色', + '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' => '全部资源', '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"}]', ], - ], - 'apis' => [ 'CreateInstance' => [ 'summary' => '创建集群实例', 'path' => '/webapi/instance/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ @@ -480,9 +569,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusGDAFRH', - ], + 'abilityTreeNodes' => ['FEATUREmilvusGDAFRH'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -490,13 +577,7 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'body', @@ -507,133 +588,65 @@ 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'title' => '主可用区。', - 'description' => '主可用区。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing-g', - ], - 'instanceName' => [ - 'title' => '实例名称', - 'description' => '实例名称', - 'type' => 'string', - 'required' => false, - 'example' => 'milvus-test', - ], - 'dbVersion' => [ - 'title' => '内核版本', - 'description' => '内核版本', - 'type' => 'string', - 'required' => true, - 'example' => '2.4', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxx', - ], - 'vpcId' => [ - 'title' => '专有网络id', - 'description' => '专有网络id', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-123xxx', - ], + 'zoneId' => ['title' => '主可用区。', 'description' => '主可用区。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing-g'], + 'instanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => false, 'example' => 'milvus-test'], + 'dbVersion' => ['title' => '内核版本', 'description' => '内核版本', 'type' => 'string', 'required' => true, 'example' => '2.4'], + 'resourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'rg-xxx'], + 'vpcId' => ['title' => '专有网络id', 'description' => '专有网络id', 'type' => 'string', 'required' => true, 'example' => 'vpc-123xxx'], 'paymentType' => [ 'title' => '付费类型', 'description' => '付费类型', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'PayAsYouGo' => '按量付费', - 'Subscription' => '包年包月', - ], + 'enumValueTitles' => ['PayAsYouGo' => '按量付费', 'Subscription' => '包年包月'], 'example' => 'PayAsYouGo', ], - 'paymentDuration' => [ - 'title' => '付费时长', - 'description' => '付费时长', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'paymentDuration' => ['title' => '付费时长', 'description' => '付费时长', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], 'paymentDurationUnit' => [ 'title' => '付费单位', 'description' => '付费单位', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Month' => '月', - 'Year' => '年', - ], + 'enumValueTitles' => ['Month' => '月', 'Year' => '年'], 'example' => 'month', ], - 'ha' => [ - 'title' => '是否开启高可用', - 'description' => '是否开启高可用', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'dbAdminPassword' => [ - 'title' => 'db密码', - 'description' => 'db密码', - 'type' => 'string', - 'required' => false, - 'example' => 'test12', - ], - 'autoBackup' => [ - 'title' => '是否开启自动备份', - 'description' => '是否开启自动备份', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'ha' => ['title' => '是否开启高可用', 'description' => '是否开启高可用', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'dbAdminPassword' => ['title' => 'db密码', 'description' => 'db密码', 'type' => 'string', 'required' => false, 'example' => 'test12'], + 'autoBackup' => ['title' => '是否开启自动备份', 'description' => '是否开启自动备份', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'multiZoneMode' => [ 'title' => '可用区配置。', 'description' => '可用区配置。', 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['Single' => '单可用区', 'Two_ha' => '双可用区高可用版', 'Two' => '双可用区'], 'example' => 'Single', ], - 'encrypted' => [ - 'title' => '是否开启oss加密', - 'description' => '是否开启oss加密', + 'encrypted' => ['title' => '是否开启oss加密', 'description' => '是否开启oss加密', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'kmsKeyId' => ['title' => '用来加密的Kms key 的id。', 'description' => '用来加密的Kms key 的id。', 'type' => 'string', 'required' => false, 'example' => 'key-xxx'], + 'configuration' => ['title' => '配置项。', 'description' => '配置项。', 'type' => 'string', 'required' => false, 'example' => 'rootCoord:'."\n" + .' maxDatabaseNum: 64 # Maximum number of database'."\n" + .' maxPartitionNum: 4096 '], + 'promotionNo' => ['description' => '优惠券号', 'type' => 'string', 'required' => false, 'example' => '22120151****'], + 'loadReplicas' => ['description' => '加载副本数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + 'isMultiAzStorage' => ['description' => '是否多可用区存储', 'type' => 'boolean', 'required' => false], + 'autoPay' => [ + 'description' => '是否自动支付，默认为true。取值：'."\n" + .'- true：自动支付。'."\n" + .'- false：只生成订单，不支付。', 'type' => 'boolean', 'required' => false, - 'example' => 'false', - ], - 'kmsKeyId' => [ - 'title' => '用来加密的Kms key 的id。', - 'description' => '用来加密的Kms key 的id。', - 'type' => 'string', - 'required' => false, - 'example' => 'key-xxx', - ], - 'configuration' => [ - 'title' => '配置项。', - 'description' => '配置项。', - 'type' => 'string', - 'required' => false, - 'example' => 'rootCoord:'."\n" - .' maxDatabaseNum: 64 # Maximum number of database'."\n" - .' maxPartitionNum: 4096 ', - ], - 'promotionNo' => [ - 'type' => 'string', - 'required' => false, - ], - 'loadReplicas' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, + 'enumValueTitles' => [], + 'example' => 'true', ], - 'isMultiAzStorage' => [ - 'type' => 'boolean', + 'autoRenew' => ['description' => '是否自动续费。仅当实例付费类型为Subscription（包年包月）时，该参数生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'backupRestoreInfo' => [ + 'description' => '备份恢复信息', + 'type' => 'object', + 'properties' => [ + 'sourceClusterId' => ['description' => '备份集群ID', 'type' => 'string', 'required' => false, 'example' => 'c-xxxxxxx'], + 'backupName' => ['description' => '备份名称', 'type' => 'string', 'required' => false, 'example' => '备份1'], + 'backupId' => ['description' => '备份id', 'type' => 'string', 'required' => false, 'example' => 'bt-xxxxx'], + ], 'required' => false, ], 'vSwitchIds' => [ @@ -645,20 +658,8 @@ 'description' => '交换机ID。', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'title' => '可用区。', - 'description' => '可用区。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-a', - ], - 'vswId' => [ - 'title' => '可用区下vswitch id配置。', - 'description' => '可用区下vswitch id配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-xxx', - ], + 'zoneId' => ['title' => '可用区。', 'description' => '可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-a'], + 'vswId' => ['title' => '可用区下vswitch id配置。', 'description' => '可用区下vswitch id配置。', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxx'], ], 'required' => false, ], @@ -678,39 +679,12 @@ 'description' => '组件类型', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'proxy' => 'proxy', - 'mix_coordinator' => 'mix_coordinator', - 'data' => 'data', - 'query' => 'query', - 'standalone' => 'standalone', - 'index' => 'index', - ], + 'enumValueTitles' => ['proxy' => 'proxy', 'mix_coordinator' => 'mix_coordinator', 'data' => 'data', 'query' => 'query', 'standalone' => 'standalone', 'index' => 'index'], 'example' => 'standalone', ], - 'replica' => [ - 'title' => '副本数量', - 'description' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'cuNum' => [ - 'title' => 'CU数量', - 'description' => 'CU数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8', - ], - 'cuType' => [ - 'title' => 'CU类型。', - 'description' => 'CU类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'general', - ], + 'replica' => ['title' => '副本数量', 'description' => '副本数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'cuNum' => ['title' => 'CU数量', 'description' => 'CU数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8'], + 'cuType' => ['title' => 'CU类型。', 'description' => 'CU类型。', 'type' => 'string', 'required' => false, 'example' => 'general'], 'diskSizeType' => [ 'title' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', 'description' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', @@ -718,10 +692,7 @@ 'required' => false, 'docRequired' => false, 'example' => 'Normal', - 'enum' => [ - 'Large', - 'Normal', - ], + 'enum' => ['Large', 'Normal'], ], ], 'required' => false, @@ -735,27 +706,14 @@ 'description' => '标签唯一标识，标签id', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '资源标签key值。', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'value' => [ - 'description' => '资源标签value值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'key' => ['description' => '资源标签key值。', 'type' => 'string', 'required' => false, 'example' => 'key'], + 'value' => ['description' => '资源标签value值。', 'type' => 'string', 'required' => false, 'example' => 'value'], ], 'required' => false, ], 'required' => false, ], - 'autoRenew' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'aiFunction' => ['description' => '是否开启ai function', 'type' => 'boolean', 'required' => false], ], 'required' => false, ], @@ -763,12 +721,7 @@ [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], ], 'responses' => [ @@ -776,74 +729,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求唯一号', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求唯一号', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'c-xxx', - ], - 'orderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => 'xxx', - ], + 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'c-xxx'], + 'orderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => 'xxx'], ], ], ], + 'description' => '', ], ], ], - '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"}]', 'title' => '创建集群实例', - ], - 'GetInstance' => [ - 'summary' => '获取实例详情', - 'path' => '/webapi/instance/get', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + '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' => '删除实例', + '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', ], @@ -851,24 +792,12 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'c-xxxx', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'c-xxxx'], ], ], 'responses' => [ @@ -876,190 +805,46 @@ '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' => ['title' => '请求唯一号', 'description' => '请求唯一号', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'c-xxxx'], + 'orderId' => ['title' => '订单ID', 'description' => '订单ID', 'type' => 'string', 'example' => '123456'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除实例', + '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"}]', - 'title' => '获取实例详情', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"instanceId\\": \\"c-xxxx\\",\\n \\"orderId\\": \\"123456\\"\\n}","type":"json"}]', ], - 'ListInstancesV2' => [ - 'summary' => '根据集群ID或者名称搜索集群', - 'path' => '/webapi/instance/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeAccessControlList' => [ + 'summary' => '获取Milvus实例公网访问IP白名单。', + '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' => '集群id', - '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' => '资源组id', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-123xxx', - ], - ], - [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '标签列表，JSON格式。', - 'type' => 'array', - 'items' => [ - 'description' => '标签列表，JSON格式。', - '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' => '下一次请求的分页token（暂时没有启用）。', - 'type' => 'string', - 'required' => false, - 'example' => 'None', - ], + 'schema' => ['title' => '集群实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx'], ], ], 'responses' => [ @@ -1067,110 +852,75 @@ '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' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx'], + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AclId' => ['title' => '公网访问控制的AclId', 'description' => '公网访问控制的AclId。', 'type' => 'string', 'example' => 'acl-xxxx'], + 'Cidr' => [ + 'title' => 'Cidr块', + 'description' => 'Cidr块。', + 'type' => 'array', + 'items' => ['title' => 'ip段', 'description' => 'IP段。', 'type' => 'string', 'example' => '192.168.**.**'], + ], ], ], - 'nextToken' => [ - 'description' => '分页token。（暂时没有启用）', - 'type' => 'string', - 'example' => 'None', - ], - 'maxResults' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], ], ], ], ], - '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"}]', - 'title' => '获取实例列表', - ], - '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' => '获取公网访问白名单', + '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' => '获取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' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'c-xxxx', - ], + 'schema' => ['title' => '集群实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx'], ], ], 'responses' => [ @@ -1178,87 +928,72 @@ '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' => '实例ID', - 'type' => 'string', - 'example' => 'c-xxxx', - ], - 'orderId' => [ - 'title' => '订单ID', - 'description' => '订单ID', - 'type' => 'string', - 'example' => '123456', - ], + 'HttpStatusCode' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'], + 'ErrCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx.'], + 'Data' => ['title' => '返回数据', 'description' => '返回数据。', 'type' => 'string', 'format' => 'byte', 'example' => 'dataCoord:\\n enableCompaction: true'], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], ], ], ], ], - '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"}]', - 'title' => '删除实例', - ], - 'UpdateInstanceName' => [ - 'summary' => '修改实例名称。', - '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' => '获取实例配置信息', + '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' => '实例名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'milvus-test', - ], + 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'InstanceId', + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群实例id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'c-xxxx'], ], ], 'responses' => [ @@ -1266,66 +1001,40 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求唯一号', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], + 'instance' => ['title' => '实例详情', 'description' => '实例详情', '$ref' => '#/components/schemas/InstanceDetail'], ], + 'description' => '', ], ], ], - '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' => '修改实例名称', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实例详情', + 'summary' => '获取实例详情', + '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 }\\n ]\\n }\\n}","type":"json"}]', ], 'GetInstanceDetail' => [ - 'summary' => '获取单个实例的详细信息。', 'path' => '/webapi/cluster/detail', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1338,21 +1047,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197635', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群实例id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-123xxx', - ], + 'schema' => ['title' => '集群实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx'], ], ], 'responses' => [ @@ -1360,102 +1061,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], + 'HttpStatusCode' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx'], 'Data' => [ 'title' => '返回数据', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '集群id', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'c-123xxx', - ], - 'BeginTime' => [ - 'title' => '开始时间', - 'description' => '开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1716863508000', - ], - 'RunningTime' => [ - 'title' => '运行时间', - 'description' => '运行时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743679', - ], - 'ExpireTime' => [ - 'title' => '过期时间', - 'description' => '过期时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1721664000000', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ZoneId' => [ - 'title' => '可用区', - 'description' => '可用区。', - 'type' => 'string', - 'example' => 'cn-beijing-g', - ], - 'InstanceStatus' => [ - 'title' => '状态', - 'description' => '实例状态。取值范围：'."\n" - .'- creating：创建中。'."\n" - .'- running：运行中。'."\n" - .'- updating：升级中。集群升降配、配置变更和开关公网等。'."\n" - .'- disable：不可用。集群已经过期，需要续费激活。'."\n" - .'- deleting：删除中。'."\n" - .'- deleted：已删除。', - 'type' => 'string', - 'example' => 'running', - ], - 'PackageType' => [ - 'title' => '规格', - 'description' => '规格详情。取值范围：'."\n" - ."\n" - .'- trial：入门版。'."\n" - .'- standard：标准版。', - 'type' => 'string', - 'example' => 'standard', - ], + 'InstanceId' => ['title' => '集群id', 'description' => '实例ID。', 'type' => 'string', 'example' => 'c-123xxx'], + 'BeginTime' => ['title' => '开始时间', 'description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1716863508000'], + 'RunningTime' => ['title' => '运行时间', 'description' => '运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1743679'], + 'ExpireTime' => ['title' => '过期时间', 'description' => '过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1721664000000'], + 'RegionId' => ['title' => '地域', 'description' => '地域。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ZoneId' => ['title' => '可用区', 'description' => '可用区。', 'type' => 'string', 'example' => 'cn-beijing-g'], + 'InstanceStatus' => ['title' => '状态', 'description' => '实例状态。取值范围：'."\n" + .'- creating：创建中。'."\n" + .'- running：运行中。'."\n" + .'- updating：升级中。集群升降配、配置变更和开关公网等。'."\n" + .'- disable：不可用。集群已经过期，需要续费激活。'."\n" + .'- deleting：删除中。'."\n" + .'- deleted：已删除。', 'type' => 'string', 'example' => 'running'], + 'PackageType' => ['title' => '规格', 'description' => '规格详情。取值范围：'."\n" + ."\n" + .'- trial：入门版。'."\n" + .'- standard：标准版。', 'type' => 'string', 'example' => 'standard'], 'ClusterInfo' => [ 'title' => '集群详情', 'description' => '实例详情。', @@ -1468,279 +1100,72 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ComponentType' => [ - 'title' => '组件类型', - 'description' => '组件类型。取值范围：'."\n" - .'- standalone'."\n" - .'- proxy'."\n" - .'- mix_coordinator'."\n" - .'- query'."\n" - .'- index'."\n" - .'- data', - 'type' => 'string', - 'example' => 'standalone', - ], - 'CuNum' => [ - 'title' => 'CU数量', - 'description' => 'CU数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'CuRatio' => [ - 'description' => 'CU规格。取值范围：'."\n" - .'* 4：1core对应4GB。'."\n" - .'* 8：1core对应8GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Replica' => [ - 'title' => '副本数量', - 'description' => '副本数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DiskSize' => [ - 'title' => '磁盘大小', - 'description' => '磁盘大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'DiskType' => [ - 'title' => '磁盘类型', - 'description' => '磁盘类型。', - 'type' => 'string', - 'example' => 'essd', - ], - 'ZoneId' => [ - 'type' => 'string', - ], + 'ComponentType' => ['title' => '组件类型', 'description' => '组件类型。取值范围：'."\n" + .'- standalone'."\n" + .'- proxy'."\n" + .'- mix_coordinator'."\n" + .'- query'."\n" + .'- index'."\n" + .'- data', 'type' => 'string', 'example' => 'standalone'], + 'CuNum' => ['title' => 'CU数量', 'description' => 'CU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'CuRatio' => ['description' => 'CU规格。取值范围：'."\n" + .'* 4：1core对应4GB。'."\n" + .'* 8：1core对应8GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'Replica' => ['title' => '副本数量', 'description' => '副本数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'DiskSize' => ['title' => '磁盘大小', 'description' => '磁盘大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'DiskType' => ['title' => '磁盘类型', 'description' => '磁盘类型。', 'type' => 'string', 'example' => 'essd'], + 'ZoneId' => ['type' => 'string'], + 'PayType' => ['type' => 'string'], ], + 'description' => '', ], ], - 'IntranetUrl' => [ - 'title' => '内网地址', - 'description' => '内网地址。', - 'type' => 'string', - 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', - ], - 'InternetUrl' => [ - 'title' => '公网地址', - 'description' => '公网地址。', - 'type' => 'string', - 'example' => 'c-123xxx-.milvus.aliyuncs.com', - ], - 'TotalCuNum' => [ - 'title' => '总CU数量', - 'description' => '总CU数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'TotalDiskSize' => [ - 'title' => '总磁盘数量', - 'description' => '总磁盘数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'ProxyPort' => [ - 'title' => 'Proxy端口', - 'description' => 'Proxy端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '19530', - ], - 'AttuPort' => [ - 'title' => 'Attu组件端口', - 'description' => 'Attu组件端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], - 'OssStorageTimestamp' => [ - 'title' => 'OSS存储指标时间', - 'description' => 'OSS存储指标时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718604000000', - ], - 'OssStorageSize' => [ - 'title' => 'OSS存储数据大小', - 'description' => 'OSS存储数据大小。', - 'type' => 'string', - 'example' => '125.15 GB', - ], + 'IntranetUrl' => ['title' => '内网地址', 'description' => '内网地址。', 'type' => 'string', 'example' => 'c-123xxx-internal.milvus.aliyuncs.com'], + 'InternetUrl' => ['title' => '公网地址', 'description' => '公网地址。', 'type' => 'string', 'example' => 'c-123xxx-.milvus.aliyuncs.com'], + 'TotalCuNum' => ['title' => '总CU数量', 'description' => '总CU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '24'], + 'TotalDiskSize' => ['title' => '总磁盘数量', 'description' => '总磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'ProxyPort' => ['title' => 'Proxy端口', 'description' => 'Proxy端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '19530'], + 'AttuPort' => ['title' => 'Attu组件端口', 'description' => 'Attu组件端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'], + 'OssStorageTimestamp' => ['title' => 'OSS存储指标时间', 'description' => 'OSS存储指标时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1718604000000'], + 'OssStorageSize' => ['title' => 'OSS存储数据大小', 'description' => 'OSS存储数据大小。', 'type' => 'string', 'example' => '125.15 GB'], ], ], - 'VpcId' => [ - 'title' => '专有网络id', - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-123xxx', - ], - 'VswId' => [ - 'title' => '交换机id', - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-123xxx', - ], - 'SgId' => [ - 'title' => '安全组id', - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-123xxx', - ], - 'OpenPublicNet' => [ - 'title' => '是否开启公网', - 'description' => '是否开启公网。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ClusterName' => [ - 'title' => '集群名称', - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'aliyun-test', - ], - 'PayType' => [ - 'title' => '付费类型', - 'description' => '付费类型。取值范围：'."\n" - .'- 0：按量付费。'."\n" - .'- 1：包年包月。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BucketName' => [ - 'title' => 'bucket名称', - 'description' => 'Bucket名称。', - 'type' => 'string', - 'example' => 'milvus-test', - ], - 'BucketPath' => [ - 'title' => 'bucket地址', - 'description' => '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', - ], - 'Version' => [ - 'title' => '内核版本', - 'description' => '内核版本。', - 'type' => 'string', - 'example' => '2.4', - ], - 'AclId' => [ - 'title' => '公网访问控制aclId', - 'description' => '公网访问控制AclId。', - 'type' => 'string', - 'example' => 'acl-123xxx', - ], - 'UserConfig' => [ - 'title' => '用户自定义配置', - 'description' => '用户自定义配置。', - 'type' => 'string', - 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', - ], - 'TemplateVersion' => [ - 'title' => '软件栈版本', - 'description' => '软件栈版本。', - 'type' => 'string', - 'example' => '2.4.1-1.0-0.0.1', - ], - 'ProductCode' => [ - 'title' => '商品code', - 'description' => '商品Code。', - 'type' => 'string', - 'example' => 'milvus_milvuspre_public_cn', - ], - 'ResourceGroupId' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'example' => 'rg-123xxx', - ], + 'VpcId' => ['title' => '专有网络id', 'description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-123xxx'], + 'VswId' => ['title' => '交换机id', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-123xxx'], + 'SgId' => ['title' => '安全组id', 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-123xxx'], + 'OpenPublicNet' => ['title' => '是否开启公网', 'description' => '是否开启公网。', 'type' => 'boolean', 'example' => 'true'], + 'ClusterName' => ['title' => '集群名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'aliyun-test'], + 'PayType' => ['title' => '付费类型', 'description' => '付费类型。取值范围：'."\n" + .'- 0：按量付费。'."\n" + .'- 1：包年包月。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BucketName' => ['title' => 'bucket名称', 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'milvus-test'], + 'BucketPath' => ['title' => 'bucket地址', 'description' => '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'], + 'Version' => ['title' => '内核版本', 'description' => '内核版本。', 'type' => 'string', 'example' => '2.4'], + 'AclId' => ['title' => '公网访问控制aclId', 'description' => '公网访问控制AclId。', 'type' => 'string', 'example' => 'acl-123xxx'], + 'UserConfig' => ['title' => '用户自定义配置', 'description' => '用户自定义配置。', 'type' => 'string', 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024'], + 'TemplateVersion' => ['title' => '软件栈版本', 'description' => '软件栈版本。', 'type' => 'string', 'example' => '2.4.1-1.0-0.0.1'], + 'ProductCode' => ['title' => '商品code', 'description' => '商品Code。', 'type' => 'string', 'example' => 'milvus_milvuspre_public_cn'], + 'ResourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'example' => 'rg-123xxx'], 'MeasureConfig' => [ 'description' => '配置信息', 'type' => 'object', 'properties' => [ - 'ProxyNodeCuNum' => [ - 'description' => 'Proxy节点Cu数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'IndexNodeCuNum' => [ - 'description' => 'Index节点Cu数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'QueryNodeCuNum' => [ - 'description' => 'Query节点Cu数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'DataNodeCuNum' => [ - 'description' => 'Data节点Cu数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'MixCoodinatorNodeCuNum' => [ - 'description' => 'MixCoordinator节点Cu数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'IndexNodeReplica' => [ - 'description' => 'Index节点副本数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'QueryNodeReplica' => [ - 'description' => 'Query节点副本数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DataNodeReplica' => [ - 'description' => 'Data节点副本数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'MixCoodinatorNodeReplica' => [ - 'description' => 'MixCoordinator节点副本数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ProxyNodeReplica' => [ - 'description' => 'Proxy节点副本数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'ProxyNodeCuNum' => ['description' => 'Proxy节点Cu数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'IndexNodeCuNum' => ['description' => 'Index节点Cu数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'QueryNodeCuNum' => ['description' => 'Query节点Cu数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'DataNodeCuNum' => ['description' => 'Data节点Cu数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'MixCoodinatorNodeCuNum' => ['description' => 'MixCoordinator节点Cu数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'IndexNodeReplica' => ['description' => 'Index节点副本数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'QueryNodeReplica' => ['description' => 'Query节点副本数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'DataNodeReplica' => ['description' => 'Data节点副本数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'MixCoodinatorNodeReplica' => ['description' => 'MixCoordinator节点副本数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ProxyNodeReplica' => ['description' => 'Proxy节点副本数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], ], - 'EnableHa' => [ - 'description' => '是否高可用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeType' => [ - 'description' => '节点类型。取值范围：'."\n" - .'* perf：性能型。'."\n" - .'* cap：容量型。', - 'type' => 'string', - 'example' => 'perf', - ], + 'EnableHa' => ['description' => '是否高可用', 'type' => 'boolean', 'example' => 'true'], + 'NodeType' => ['description' => '节点类型。取值范围：'."\n" + .'* perf：性能型。'."\n" + .'* cap：容量型。', 'type' => 'string', 'example' => 'perf'], 'Tags' => [ 'description' => 'tag信息', 'type' => 'array', @@ -1748,86 +1173,149 @@ 'description' => 'tag信息', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'tag的key', - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'tag的value', - 'type' => 'string', - 'example' => 'value1', - ], + 'Key' => ['description' => 'tag的key', 'type' => 'string', 'example' => 'key1'], + 'Value' => ['description' => 'tag的value', 'type' => 'string', 'example' => 'value1'], ], ], ], - 'Encrypted' => [ - 'type' => 'string', - ], - 'KmsKeyId' => [ - 'type' => 'string', - ], - 'MultiZoneMode' => [ - 'title' => 'Single,Two,Three', - 'description' => 'Single,Two,Three', - 'type' => 'string', + 'Encrypted' => ['type' => 'string'], + 'KmsKeyId' => ['type' => 'string'], + 'MultiZoneMode' => ['type' => 'string'], + 'HighAvailability' => [ + 'type' => 'object', + 'properties' => [ + 'Mode' => ['type' => 'string'], + 'PrimaryZoneId' => ['type' => 'string'], + 'SecondaryZoneId' => ['type' => 'string'], + 'CurrentActiveAZ' => ['type' => 'string'], + ], ], 'VSwitches' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'VswId' => [ - 'type' => 'string', - ], - 'ZoneId' => [ - 'type' => 'string', - ], + 'VswId' => ['type' => 'string'], + 'ZoneId' => ['type' => 'string'], ], ], ], - 'HighAvailability' => [ - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'type' => 'string', - ], - 'PrimaryZoneId' => [ - 'type' => 'string', - ], - 'SecondaryZoneId' => [ - 'type' => 'string', - ], - 'CurrentActiveAZ' => [ - 'type' => 'string', - ], + 'MaintainablePeriod' => ['type' => 'string'], + ], + ], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取实例详情', + 'summary' => '获取单个实例的详细信息。', + 'changeSet' => [ + ['createdAt' => '2025-03-19T10:02:04.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-12-24T07:52:38.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-12-02T11:43:30.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-28T06:24:31.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-06-25T02:00:10.000Z', 'description' => '响应参数发生变更'], + ], + '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' => '集群id', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => '区域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'accessDeniedDetail' => ['description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'type' => 'string', 'example' => 'None'], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '66A13C31-473A-5B3A-8974-0B07A40649CF'], + 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'data' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'cidrs' => [ + 'description' => '网段地址。', + 'type' => 'array', + 'items' => ['description' => '网段地址。', 'type' => 'string', 'example' => '140.205.11.0/24,140.205.11.2'], ], + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-10-17T13:53:27Z'], + 'groupName' => ['description' => '组名称。', 'type' => 'string', 'example' => 'test'], + 'id' => ['description' => '音频ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '376774'], + 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'c-xxx'], + 'uid' => ['description' => '当前阿里云主账号的ID，只读', 'type' => 'integer', 'format' => 'int64', 'example' => '50832118'], ], ], ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], ], + 'description' => '', ], ], ], - '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' => '获取实例详情', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '展示分组白名单', + 'summary' => '获取当前用户下的分组信息和内容', + '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' => '获取当前账号下Milvus实例列表。', 'path' => '/webapi/order/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1840,85 +1328,39 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '197636', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => '集群名称', - 'description' => '实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'milvus-test', - ], + 'schema' => ['title' => '集群名称', 'description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'milvus-test'], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '集群id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-123xxx', - ], + 'schema' => ['title' => '集群id', 'description' => '实例ID。', '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', - ], + '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', - ], + 'schema' => ['title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '地域', 'description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-123xxx', - ], + 'schema' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'rg-123xxx'], ], [ 'name' => 'Tag', @@ -1931,18 +1373,8 @@ 'description' => 'tag信息', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'tag的key', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'tag的value', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'Key' => ['description' => 'tag的key', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'Value' => ['description' => 'tag的value', 'type' => 'string', 'required' => false, 'example' => 'value1'], ], 'required' => false, ], @@ -1955,37 +1387,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], + 'HttpStatusCode' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx'], 'Data' => [ 'title' => '返回数据', 'description' => '返回数据。', @@ -1993,71 +1399,23 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '集群id', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'c-123xxx', - ], - 'BeginTime' => [ - 'title' => '开始时间', - 'description' => '开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718608505000', - ], - 'RunningTime' => [ - 'title' => '运行时间', - 'description' => '运行时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '536611', - ], - 'ExpireTime' => [ - 'title' => '过期时间', - 'description' => '过期时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1721232000000', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ZoneId' => [ - 'title' => '可用区', - 'description' => '可用区。', - 'type' => 'string', - 'example' => 'cn-beijing-g', - ], - 'InstanceStatus' => [ - 'title' => '状态', - 'description' => '实例状态。取值范围：'."\n" - .'- creating：创建中。'."\n" - .'- running：运行中。'."\n" - .'- updating：升级中。集群升降配、配置变更和开关公网等。'."\n" - .'- disable：不可用。集群已经过期，需要续费激活。'."\n" - .'- deleting：删除中。'."\n" - .'- deleted：已删除。', - 'type' => 'string', - 'example' => 'running', - ], - 'ClusterName' => [ - 'title' => '集群名称', - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'milvus-test', - ], - 'PackageType' => [ - 'title' => '规格', - 'description' => '规格详情。取值范围：'."\n" - .'- trial：入门版。'."\n" - .'- standard：标准版。', - 'type' => 'string', - 'example' => 'trial', - ], + 'InstanceId' => ['title' => '集群id', 'description' => '实例ID。', 'type' => 'string', 'example' => 'c-123xxx'], + 'BeginTime' => ['title' => '开始时间', 'description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1718608505000'], + 'RunningTime' => ['title' => '运行时间', 'description' => '运行时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '536611'], + 'ExpireTime' => ['title' => '过期时间', 'description' => '过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1721232000000'], + 'RegionId' => ['title' => '地域', 'description' => '地域。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ZoneId' => ['title' => '可用区', 'description' => '可用区。', 'type' => 'string', 'example' => 'cn-beijing-g'], + 'InstanceStatus' => ['title' => '状态', 'description' => '实例状态。取值范围：'."\n" + .'- creating：创建中。'."\n" + .'- running：运行中。'."\n" + .'- updating：升级中。集群升降配、配置变更和开关公网等。'."\n" + .'- disable：不可用。集群已经过期，需要续费激活。'."\n" + .'- deleting：删除中。'."\n" + .'- deleted：已删除。', 'type' => 'string', 'example' => 'running'], + 'ClusterName' => ['title' => '集群名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'milvus-test'], + 'PackageType' => ['title' => '规格', 'description' => '规格详情。取值范围：'."\n" + .'- trial：入门版。'."\n" + .'- standard：标准版。', 'type' => 'string', 'example' => 'trial'], 'ClusterInfo' => [ 'title' => '集群详情', 'description' => '实例详情。', @@ -2070,145 +1428,40 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ComponentType' => [ - 'title' => '组件类型', - 'description' => '组件类型。取值范围：'."\n" - .'- standalone'."\n" - .'- proxy'."\n" - .'- mix_coordinator'."\n" - .'- query'."\n" - .'- index'."\n" - .'- data', - 'type' => 'string', - 'example' => 'standalone', - ], - 'CuNum' => [ - 'title' => 'CU数量', - 'description' => 'CU数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'Replica' => [ - 'title' => '副本数量', - 'description' => '副本数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DiskSize' => [ - 'title' => '磁盘大小', - 'description' => '磁盘大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'DiskType' => [ - 'title' => '磁盘类型', - 'description' => '磁盘类型。', - 'type' => 'string', - 'example' => 'essd', - ], + 'ComponentType' => ['title' => '组件类型', 'description' => '组件类型。取值范围：'."\n" + .'- standalone'."\n" + .'- proxy'."\n" + .'- mix_coordinator'."\n" + .'- query'."\n" + .'- index'."\n" + .'- data', 'type' => 'string', 'example' => 'standalone'], + 'CuNum' => ['title' => 'CU数量', 'description' => 'CU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'Replica' => ['title' => '副本数量', 'description' => '副本数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DiskSize' => ['title' => '磁盘大小', 'description' => '磁盘大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'DiskType' => ['title' => '磁盘类型', 'description' => '磁盘类型。', 'type' => 'string', 'example' => 'essd'], ], + 'description' => '', ], ], - 'IntranetUrl' => [ - 'title' => '内网地址', - 'description' => '内网地址。', - 'type' => 'string', - 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', - ], - 'InternetUrl' => [ - 'title' => '公网地址', - 'description' => '公网地址。', - 'type' => 'string', - 'example' => 'c-123xxx.milvus.aliyuncs.com', - ], - 'TotalCuNum' => [ - 'title' => 'CU数量', - 'description' => 'CU数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'TotalDiskSize' => [ - 'title' => '磁盘总量', - 'description' => '磁盘总量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'ProxyPort' => [ - 'title' => 'Proxy端口', - 'description' => 'Proxy端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '19530', - ], - 'AttuPort' => [ - 'title' => 'attu组件端口', - 'description' => 'Attu组件端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], + 'IntranetUrl' => ['title' => '内网地址', 'description' => '内网地址。', 'type' => 'string', 'example' => 'c-123xxx-internal.milvus.aliyuncs.com'], + 'InternetUrl' => ['title' => '公网地址', 'description' => '公网地址。', 'type' => 'string', 'example' => 'c-123xxx.milvus.aliyuncs.com'], + 'TotalCuNum' => ['title' => 'CU数量', 'description' => 'CU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '24'], + 'TotalDiskSize' => ['title' => '磁盘总量', 'description' => '磁盘总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'ProxyPort' => ['title' => 'Proxy端口', 'description' => 'Proxy端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '19530'], + 'AttuPort' => ['title' => 'attu组件端口', 'description' => 'Attu组件端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'], ], ], - 'VpcId' => [ - 'title' => '专有网络id', - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-123xxx', - ], - 'VswId' => [ - 'title' => '交换机id', - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-123xxx', - ], - 'SgId' => [ - 'title' => '安全组id', - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-123xxx', - ], - 'OpenPublicNet' => [ - 'title' => '是否开启公网', - 'description' => '是否开启公网。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PayType' => [ - 'title' => '付费类型', - 'description' => '付费类型。取值范围：'."\n" - .'- 0：按量付费。'."\n" - .'- 1：包年包月。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProductCode' => [ - 'title' => '商品code', - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'milvus_milvuspre_public_cn', - ], - 'ResourceGroupId' => [ - 'title' => '资源组id', - 'description' => '资源组id', - 'type' => 'string', - 'example' => 'rg-123xxx', - ], - 'NodeType' => [ - 'description' => '节点类型', - 'type' => 'string', - 'example' => 'perf', - ], - 'AutoBackup' => [ - 'description' => '是否自动备份', - 'type' => 'boolean', - 'example' => 'true', - ], + 'VpcId' => ['title' => '专有网络id', 'description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-123xxx'], + 'VswId' => ['title' => '交换机id', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-123xxx'], + 'SgId' => ['title' => '安全组id', 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-123xxx'], + 'OpenPublicNet' => ['title' => '是否开启公网', 'description' => '是否开启公网。', 'type' => 'boolean', 'example' => 'true'], + 'PayType' => ['title' => '付费类型', 'description' => '付费类型。取值范围：'."\n" + .'- 0：按量付费。'."\n" + .'- 1：包年包月。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ProductCode' => ['title' => '商品code', 'description' => '商品Code', 'type' => 'string', 'example' => 'milvus_milvuspre_public_cn'], + 'ResourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'example' => 'rg-123xxx'], + 'NodeType' => ['description' => '节点类型', 'type' => 'string', 'example' => 'perf'], + 'AutoBackup' => ['description' => '是否自动备份', 'type' => 'boolean', 'example' => 'true'], 'Tags' => [ 'description' => 'tag信息', 'type' => 'array', @@ -2216,75 +1469,71 @@ 'description' => 'tag信息', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'tag的key', - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'tag的value', - 'type' => 'string', - 'example' => 'value1', - ], + 'Key' => ['description' => 'tag的key', 'type' => 'string', 'example' => 'key1'], + 'Value' => ['description' => 'tag的value', 'type' => 'string', 'example' => 'value1'], ], ], ], - 'Version' => [ - 'type' => 'string', - ], + 'Version' => ['type' => 'string'], + 'TemplateVersion' => ['type' => 'string'], ], + 'description' => '', ], ], - 'Total' => [ - 'title' => '总数', - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'Total' => ['title' => '总数', 'description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], ], + 'description' => '', ], ], ], - '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' => '获取实例列表', - ], - 'UpdateInstance' => [ - 'summary' => '更新实例', - 'path' => '/webapi/instance/update', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-19T10:02:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2025-02-26T07:01:03.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-12-24T07:52:38.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-28T06:24:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-06-25T02:00:10.000Z', 'description' => '响应参数发生变更'], + ], + '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' => '全部资源', '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', ], @@ -2292,107 +1541,61 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, + 'name' => 'instanceName', + 'in' => 'query', + 'schema' => ['title' => '集群名称', 'description' => '集群名称', 'type' => 'string', 'required' => false, 'example' => 'milvus-test'], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['title' => '集群id', 'description' => '集群id', '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' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'rg-123xxx'], + ], + [ + 'name' => 'tag', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - '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' => 'CU数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8', - ], - ], - 'required' => false, - ], - 'required' => false, + 'description' => '标签列表，JSON格式。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表，JSON格式。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'k1'], + 'value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'v1'], ], + 'required' => false, ], 'required' => false, ], ], [ - 'name' => 'clientToken', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '下一次请求的分页token（暂时没有启用）。', 'type' => 'string', 'required' => false, 'example' => 'None'], ], ], 'responses' => [ @@ -2400,44 +1603,49 @@ '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' => ['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'], ], + 'nextToken' => ['description' => '分页token。（暂时没有启用）', 'type' => 'string', 'example' => 'None'], + 'maxResults' => ['description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实例列表', + 'summary' => '根据集群ID或者名称搜索集群', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + '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 \\"data\\": true\\n}","type":"json"}]', - 'title' => '更新实例', + '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 }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"None\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', ], 'ModifyInstanceConfig' => [ 'summary' => '更新Milvus各个组件的配置参数。', 'path' => '/webapi/config/modify_milvus_config', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2449,43 +1657,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvusCTW33S', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', - ], + 'schema' => ['title' => '集群id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx'], ], [ 'name' => 'Reason', 'in' => 'query', - 'schema' => [ - 'title' => '更新原因', - 'description' => '更新原因。', - 'type' => 'string', - 'required' => true, - 'example' => 'for test', - ], + 'schema' => ['title' => '更新原因', 'description' => '更新原因。', 'type' => 'string', 'required' => true, 'example' => 'for test'], ], [ 'name' => 'UserConfig', 'in' => 'query', - 'schema' => [ - 'title' => '用户自定义配置', - 'description' => '用户自定义配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', - ], + 'schema' => ['title' => '用户自定义配置', 'description' => '用户自定义配置。', 'type' => 'string', 'required' => false, 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024'], ], ], 'responses' => [ @@ -2493,69 +1681,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'HttpStatusCode' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx'], + 'Data' => ['title' => '返回数据', 'description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], ], ], ], ], - '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' => '更新实例配置', - ], - 'DescribeInstanceConfigs' => [ - 'summary' => '获取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' => '打标', + 'path' => '/webapi/tags', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2564,23 +1728,47 @@ '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', + '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' => '资源ID,最多 50个子项', + 'type' => 'array', + 'items' => ['description' => '资源 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-xx'], + 'required' => true, + ], + 'Tag' => [ + 'title' => '对应新增标签列表，最多包含20个子项', + 'description' => '对应新增标签列表，最多包含20个子项', + 'type' => 'array', + 'items' => [ + 'description' => 'tag信息', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'k1'], + 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, ], ], ], @@ -2589,71 +1777,25 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx.', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据。', - 'type' => 'string', - 'format' => 'byte', - 'example' => 'dataCoord:\\n enableCompaction: true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '给指定资源打标签', + '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' => '获取实例配置信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', ], - 'DescribeAccessControlList' => [ - 'summary' => '获取Milvus实例公网访问IP白名单。', - 'path' => '/webapi/milvus/describe_access_control_list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UnTagResources' => [ + 'summary' => '删除标签', + 'path' => '/webapi/tags', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2662,109 +1804,76 @@ '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' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'instance'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '集群实例id', - 'description' => '实例ID。', - 'type' => 'string', + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID,最多 50个子项', + 'type' => 'array', + 'items' => ['description' => '实例ID列表。', 'type' => 'string', 'required' => false, 'example' => 'c-xx'], + 'required' => true, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '对应标签键列表，最多包含20个子项', + 'description' => '对应标签键列表，最多包含20个子项', + 'type' => 'array', + 'items' => ['description' => '资源的标签键列表。可输入最多20个标签键。', 'type' => 'string', 'required' => false, 'example' => 'tk4'], 'required' => false, - 'example' => 'c-123xxx', ], ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'description' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'AclId' => [ - 'title' => '公网访问控制的AclId', - 'description' => '公网访问控制的AclId。', - 'type' => 'string', - 'example' => 'acl-xxxx', - ], - 'Cidr' => [ - 'title' => 'Cidr块', - 'description' => 'Cidr块。', - 'type' => 'array', - 'items' => [ - 'title' => 'ip段', - 'description' => 'IP段。', - 'type' => 'string', - 'example' => '192.168.**.**', - ], - ], - ], - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], ], ], ], ], - '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' => '获取公网访问白名单', - ], - 'UpdatePublicNetworkStatus' => [ - 'summary' => '开启/关闭Milvus公网访问能力。', - 'path' => '/webapi/network/updatePublicNetworkStatus', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除资源标签', + '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' => [], @@ -2776,61 +1885,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmilvus0MDRCH', - ], + 'abilityTreeNodes' => ['FEATUREmilvusCTW33S'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '集群id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c-123xxx', - ], + 'schema' => ['title' => '集群id', 'description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx'], ], [ - 'name' => 'ComponentType', - 'in' => 'query', - 'schema' => [ - 'title' => '组件类型', - 'description' => '组件类型。取值范围：'."\n" - ."\n" - .'- Proxy', - 'type' => 'string', - 'required' => true, - 'example' => 'Proxy', - 'enum' => [ - 'Proxy', - ], - ], - ], - [ - 'name' => 'PublicNetworkEnabled', + 'name' => 'Cidr', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '开启/关闭公网', - 'description' => '开启/关闭公网。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['title' => 'Cidr块', 'description' => 'Cidr块。', 'type' => 'string', 'required' => false, 'example' => '192.168.**.**/24,172.1.**.**/16'], ], [ - 'name' => 'Cidr', + 'name' => 'AclId', 'in' => 'query', - 'schema' => [ - 'title' => 'Cidr块', - 'description' => 'Cidr块', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.**.**/24,172.1.**.**/16', - ], + 'schema' => ['title' => '公网访问控制id', 'description' => '公网访问控制ID。', 'type' => 'string', 'required' => false, 'example' => 'acl-123xxx'], ], ], 'responses' => [ @@ -2838,117 +1909,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Failed to find instance', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'HttpStatusCode' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'ILLEGAL.MilvusCidrFormat'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'The format of cidr is illegal.'], + 'Data' => ['title' => '返回数据', 'description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => '开启/关闭公网访问', - ], - 'UpdateAccessControlList' => [ + 'title' => '设置公网访问白名单', 'summary' => '设置Milvus公网访问IP白名单。', - 'path' => '/webapi/milvus/update_access_control_list', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccessControlList'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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 \\"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"}]', + ], + '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' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-123xxx', - ], + 'schema' => ['description' => '白名单分组名', 'type' => 'string', 'required' => false], ], [ - 'name' => 'Cidr', + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'Cidr块', - 'description' => 'Cidr块。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.**.**/24,172.1.**.**/16', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'c-xxxx'], ], [ - 'name' => 'AclId', + 'name' => 'newCidrs', 'in' => 'query', - 'schema' => [ - 'title' => '公网访问控制id', - 'description' => '公网访问控制ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'acl-123xxx', - ], + 'schema' => ['description' => '所有网段', 'type' => 'string', 'required' => false, 'example' => '140.205.11.0/24,140.205.11.2'], ], ], 'responses' => [ @@ -2956,180 +1983,140 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http请求状态码', - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'ILLEGAL.MilvusCidrFormat', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The format of cidr is illegal.', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情', - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', - ], + 'accessDeniedDetail' => ['description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'type' => 'string', 'example' => 'None'], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CB356AEE-6B3F-5FC8-9C2C-7B2D881EA9E2'], + 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'data' => ['description' => '操作结果', 'type' => 'boolean', 'example' => 'true'], + 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '[RDS%22]'], + 'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], + 'errCode' => ['description' => '错误信息编码', 'type' => 'string', 'example' => '0'], ], + 'description' => '', ], ], ], - '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' => '设置公网访问白名单', - ], - 'TagResources' => [ - 'summary' => '打标', - 'path' => '/webapi/tags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改分组内的白名单', + 'summary' => '修改分组内的白名单', + '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' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'description' => '请求Body。', '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' => '资源ID,最多 50个子项', - 'type' => 'array', - 'items' => [ - 'description' => '资源 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-xx', - ], - 'required' => true, - ], - 'Tag' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '对应新增标签列表，最多包含20个子项', + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', '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'], + 'autoPay' => ['type' => 'boolean'], + 'components' => [ + 'title' => '组件信息', + 'description' => '组件信息', 'type' => 'array', 'items' => [ - 'description' => 'tag信息', + 'description' => '实例相关的规格信息列表。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键', - 'type' => 'string', - 'required' => false, - 'example' => 'k1', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], + 'type' => ['title' => '组件类型', 'description' => '组件类型', 'type' => 'string', 'required' => true, 'example' => 'standalone'], + 'replica' => ['title' => '副本数量', 'description' => '副本数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'cuNum' => ['title' => 'CU数量', 'description' => 'CU数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8'], + 'payType' => ['type' => 'string'], + 'cuType' => ['type' => 'string'], ], 'required' => false, ], - 'required' => true, + 'required' => false, ], ], 'required' => false, ], ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求id', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求唯一号', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '操作结果', 'description' => '操作结果', 'type' => 'boolean', 'example' => 'true'], + 'orderId' => ['type' => 'string'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新实例', + 'summary' => '更新实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', - 'title' => '给指定资源打标签', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"orderId\\": \\"\\"\\n}","type":"json"}]', ], - 'UnTagResources' => [ - 'summary' => '删除标签', - 'path' => '/webapi/tags', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateInstanceName' => [ + 'summary' => '修改实例名称。', + 'path' => '/webapi/cluster/update_name', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3138,82 +2125,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' => '资源ID,最多 50个子项', - 'type' => 'array', - 'items' => [ - 'description' => '实例ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-xx', - ], - 'required' => true, - ], + 'schema' => ['title' => '集群名称', 'description' => '实例名称。', 'type' => 'string', 'required' => true, 'example' => 'milvus-test'], ], [ - 'name' => 'TagKey', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '对应标签键列表，最多包含20个子项', - 'description' => '对应标签键列表，最多包含20个子项', - 'type' => 'array', - 'items' => [ - 'description' => '资源的标签键列表。可输入最多20个标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'tk4', - ], - 'required' => false, - ], - ], - [ - 'name' => 'All', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'description' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['title' => '集群实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx'], ], ], 'responses' => [ @@ -3221,30 +2147,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], + 'HttpStatusCode' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx'], + 'Data' => ['title' => '返回数据', 'description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', - 'title' => '删除资源标签', - ], - 'ChangeResourceGroup' => [ - 'summary' => '资源转组', - 'path' => '/webapi/resourceGroup/change', - 'methods' => [ - 'post', + 'title' => '修改实例名称', + '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' => [], @@ -3256,63 +2195,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' => '地域Id', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '集群id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-123xxx'], ], [ - 'name' => 'ResourceType', + 'name' => 'ComponentType', 'in' => 'query', 'schema' => [ - 'description' => '资源类型定义。', + 'title' => '组件类型', + 'description' => '组件类型。取值范围：'."\n" + ."\n" + .'- Proxy', 'type' => 'string', - 'required' => false, - 'example' => 'instance', + 'required' => true, + 'example' => 'Proxy', + 'enum' => ['Proxy'], ], ], [ - 'name' => 'ResourceId', + 'name' => 'PublicNetworkEnabled', 'in' => 'query', - 'schema' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c-xxx', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '开启/关闭公网', 'description' => '开启/关闭公网。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Cidr', 'in' => 'query', - 'schema' => [ - 'description' => '资源组id', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-123xxx', - ], + 'schema' => ['title' => 'Cidr块', 'description' => 'Cidr块', 'type' => 'string', 'required' => false, 'example' => '192.168.**.**/24,172.1.**.**/16'], ], ], 'responses' => [ @@ -3320,179 +2235,402 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP请求状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - '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' => ['title' => 'http请求状态码', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求唯一号', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Failed to find instance'], + 'ErrMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx'], + 'Data' => ['title' => '返回数据', 'description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'], + 'AccessDeniedDetail' => ['title' => '权限校验失败详情', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }'], ], ], ], ], - '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"}]', - 'title' => '修改资源组', - ], - 'CreateDefaultRole' => [ - 'summary' => '创建Milvus访问其它云产品所需要的服务角色', - 'path' => '/webapi/user/create_default_role', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开启/关闭公网访问', + 'summary' => '开启/关闭Milvus公网访问能力。', + 'changeSet' => [ + ['createdAt' => '2024-08-03T07:43:50.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-07-30T10:24:47.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-07-12T10:05:06.000Z', 'description' => '请求参数发生变更'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePublicNetworkStatus'], ], ], - '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' => 'http请求状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求唯一号', - 'description' => '请求唯一号', - 'type' => 'string', - 'example' => 'ABCD-1234-5678-EFGH', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'ErrMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Failed to find instance c-123xxx', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'title' => '权限校验失败详情 ', - 'description' => '权限校验失败详情 ', - 'type' => 'string', - 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" } ', - ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'milvus:UpdatePublicNetworkStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Milvus', 'resourceType' => 'Instance', 'arn' => 'acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], - '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' => '创建服务角色', + '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' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'milvus.cn-beijing.aliyuncs.com', 'endpoint' => 'milvus.cn-beijing.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'milvus.cn-hangzhou.aliyuncs.com', 'endpoint' => 'milvus.cn-hangzhou.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'milvus.cn-hongkong.aliyuncs.com', 'endpoint' => 'milvus.cn-hongkong.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'milvus.cn-shanghai.aliyuncs.com', 'endpoint' => 'milvus.cn-shanghai.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'milvus.cn-shenzhen.aliyuncs.com', 'endpoint' => 'milvus.cn-shenzhen.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'milvus.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'milvus.cn-wulanchabu.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'milvus.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'milvus.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'milvus-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '响应参数发生变更', 'api' => 'GetInstanceDetail'], + ['description' => '响应参数发生变更', 'api' => 'ListInstances'], + ], + 'createdAt' => '2024-12-24T07:52:46.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'milvus.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetInstanceDetail'], + ], + 'createdAt' => '2024-12-02T11:43:37.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'milvus.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetInstanceDetail'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListInstances'], + ], + 'createdAt' => '2024-08-28T06:24:39.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'milvus.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpdatePublicNetworkStatus'], + ], + 'createdAt' => '2024-08-03T07:43:56.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'milvus.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpdatePublicNetworkStatus'], + ], + 'createdAt' => '2024-07-30T10:24:52.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'milvus.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpdatePublicNetworkStatus'], + ], + 'createdAt' => '2024-07-12T10:05:11.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'milvus.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetInstanceDetail'], + ['description' => '响应参数发生变更', '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' => '向量检索服务 Milvus 版', + 'ramCodes' => ['milvus'], + 'ramLevel' => '资源级', + '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' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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/*'], ], ], ]; |