diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/milvus | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/milvus')
| -rw-r--r-- | data/zh_cn/milvus/2023-10-12/api-docs.php | 3498 |
1 files changed, 3498 insertions, 0 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 new file mode 100644 index 0000000..109a377 --- /dev/null +++ b/data/zh_cn/milvus/2023-10-12/api-docs.php @@ -0,0 +1,3498 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'milvus', + 'version' => '2023-10-12', + ], + 'directories' => [ + [ + 'id' => 321590, + 'title' => '实例管理', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'GetInstance', + 'ListInstancesV2', + 'DeleteInstance', + 'UpdateInstanceName', + 'GetInstanceDetail', + 'ListInstances', + 'UpdateInstance', + ], + ], + [ + 'id' => 321599, + 'title' => '实例配置', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceConfig', + 'DescribeInstanceConfigs', + ], + ], + [ + 'id' => 321602, + 'title' => '实例安全', + 'type' => 'directory', + 'children' => [ + 'DescribeAccessControlList', + 'UpdatePublicNetworkStatus', + 'UpdateAccessControlList', + ], + ], + [ + 'id' => 321606, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UnTagResources', + 'ChangeResourceGroup', + 'CreateDefaultRole', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'DBVersionDetail' => [ + 'type' => 'object', + 'properties' => [ + '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', + ], + 'componentSpecs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'paymentType' => [ + 'description' => '付费类型。可选值：PayAsYouGo：按量计费Subscription：包年包月', + 'type' => 'string', + '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', + ], + 'vSwitchIds' => [ + 'description' => '交换机ID。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机ID。', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + 'tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'example' => 'k1', + ], + 'value' => [ + 'description' => '标签`value`值。', + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + 'components' => [ + 'description' => '组件信息。', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + 'MigrationSource' => [ + 'type' => 'object', + 'properties' => [ + 'endpoint' => [ + 'type' => 'object', + 'properties' => [ + 'endpoint' => [ + 'type' => 'string', + ], + 'port' => [ + 'type' => 'string', + ], + ], + ], + 'database' => [ + 'type' => 'string', + ], + 'authInfo' => [ + 'type' => 'object', + 'properties' => [ + 'token' => [ + 'type' => 'string', + ], + 'username' => [ + 'type' => 'string', + ], + 'password' => [ + 'type' => 'string', + ], + 'authType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'PriceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'currency' => [ + 'type' => 'string', + ], + 'originalAmount' => [ + 'type' => 'string', + ], + 'tradeAmount' => [ + 'type' => 'string', + ], + 'discountAmount' => [ + 'type' => 'string', + ], + 'taxAmount' => [ + 'type' => 'string', + ], + 'optionalPromotions' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PromotionInfo', + ], + ], + 'priceModules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'type' => 'string', + ], + 'originalAmount' => [ + 'type' => 'string', + ], + ], + ], + ], + 'rules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ruleId' => [ + 'type' => 'string', + ], + 'amount' => [ + 'type' => 'string', + ], + 'name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PromotionInfo' => [ + 'type' => 'object', + 'properties' => [ + 'promotionOptionCode' => [ + 'type' => 'string', + ], + 'promotionOptionNo' => [ + 'type' => 'string', + ], + 'promotionName' => [ + 'type' => 'string', + ], + 'promotionDesc' => [ + 'type' => 'string', + ], + 'canPromFee' => [ + 'type' => 'string', + ], + 'isSelected' => [ + 'type' => 'boolean', + ], + 'selected' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateInstance' => [ + 'summary' => '创建集群实例', + 'path' => '/webapi/instance/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197636', + 'abilityTreeNodes' => [ + 'FEATUREmilvusGDAFRH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + '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' => '请求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', + ], + 'paymentType' => [ + 'title' => '付费类型', + 'description' => '付费类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PayAsYouGo' => '按量付费', + 'Subscription' => '包年包月', + ], + 'example' => 'PayAsYouGo', + ], + 'paymentDuration' => [ + 'title' => '付费时长', + 'description' => '付费时长', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'paymentDurationUnit' => [ + 'title' => '付费单位', + 'description' => '付费单位', + 'type' => 'string', + 'required' => false, + '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', + ], + 'multiZoneMode' => [ + 'title' => '可用区配置。', + 'description' => '可用区配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Single', + ], + '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' => [ + 'type' => 'string', + 'required' => false, + ], + 'loadReplicas' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + 'isMultiAzStorage' => [ + 'type' => 'boolean', + 'required' => false, + ], + 'vSwitchIds' => [ + 'title' => '交换机', + 'description' => '交换机', + 'type' => 'array', + 'items' => [ + 'title' => '', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '["vsw-123xxx"]', + ], + 'components' => [ + 'title' => '组件信息', + 'description' => '组件信息', + 'type' => 'array', + 'items' => [ + 'description' => '实例相关的规格信息列表。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '组件类型', + 'description' => '组件类型', + 'type' => 'string', + 'required' => true, + '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', + ], + 'diskSizeType' => [ + 'title' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', + 'description' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Normal', + 'enum' => [ + 'Large', + 'Normal', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'tags' => [ + 'description' => '实例标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签唯一标识，标签id', + 'type' => 'object', + 'properties' => [ + '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, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197636', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '获取实例详情', + ], + 'ListInstancesV2' => [ + 'summary' => '根据集群ID或者名称搜索集群', + 'path' => '/webapi/instance/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197636', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => '下一次请求的分页token（暂时没有启用）。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'nextToken' => [ + 'description' => '分页token。（暂时没有启用）', + 'type' => 'string', + 'example' => 'None', + ], + 'maxResults' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197636', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmilvusGDAFRH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '集群名称', + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'milvus-test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群实例id', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c-123xxx', + ], + ], + ], + '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', + ], + '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" }', + ], + ], + ], + ], + ], + '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' => '修改实例名称', + ], + 'GetInstanceDetail' => [ + 'summary' => '获取单个实例的详细信息。', + 'path' => '/webapi/cluster/detail', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197635', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群实例id', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c-123xxx', + ], + ], + ], + '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', + ], + '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', + ], + 'ClusterInfo' => [ + 'title' => '集群详情', + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'MilvusResourceInfoList' => [ + 'title' => '资源详情', + 'description' => '资源详情。', + 'type' => 'array', + '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', + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + 'EnableHa' => [ + 'description' => '是否高可用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeType' => [ + 'description' => '节点类型。取值范围：'."\n" + .'* perf：性能型。'."\n" + .'* cap：容量型。', + 'type' => 'string', + 'example' => 'perf', + ], + 'Tags' => [ + 'description' => 'tag信息', + 'type' => 'array', + 'items' => [ + 'description' => 'tag信息', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'VSwitches' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VswId' => [ + 'type' => 'string', + ], + 'ZoneId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'HighAvailability' => [ + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'type' => 'string', + ], + 'PrimaryZoneId' => [ + 'type' => 'string', + ], + 'SecondaryZoneId' => [ + 'type' => 'string', + ], + 'CurrentActiveAZ' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'title' => '权限校验失败详情', + 'description' => '权限校验失败详情。', + 'type' => 'string', + 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', + ], + ], + ], + ], + ], + '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' => '获取实例详情', + ], + 'ListInstances' => [ + 'summary' => '获取当前账号下Milvus实例列表。', + 'path' => '/webapi/order/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197636', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + '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', + ], + ], + [ + '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' => 'RegionId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'tag信息', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'required' => false, + ], + 'required' => 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', + ], + 'ErrCode' => [ + 'title' => '错误码', + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Instance.NotFound', + ], + 'ErrMessage' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Failed to find instance c-123xxx', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据。', + 'type' => 'array', + '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', + ], + 'ClusterInfo' => [ + 'title' => '集群详情', + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'MilvusResourceInfoList' => [ + 'title' => '资源详情', + 'description' => '资源详情。', + 'type' => 'array', + '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', + ], + ], + ], + ], + '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', + ], + 'Tags' => [ + 'description' => 'tag信息', + 'type' => 'array', + 'items' => [ + 'description' => 'tag信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'tag的key', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => 'tag的value', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'Version' => [ + 'type' => 'string', + ], + ], + ], + ], + '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" }', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + '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' => '请求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, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => '更新实例', + ], + 'ModifyInstanceConfig' => [ + 'summary' => '更新Milvus各个组件的配置参数。', + 'path' => '/webapi/config/modify_milvus_config', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'UserConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '用户自定义配置', + 'description' => '用户自定义配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', + ], + ], + ], + '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', + ], + '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"}]', + 'title' => '更新实例配置', + ], + 'DescribeInstanceConfigs' => [ + 'summary' => '获取Milvus各个组件自定义配置的信息。', + 'path' => '/webapi/config/describe_milvus_user_config', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群实例id', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c-123xxx', + ], + ], + ], + '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', + '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 \\"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' => '获取实例配置信息', + ], + 'DescribeAccessControlList' => [ + 'summary' => '获取Milvus实例公网访问IP白名单。', + 'path' => '/webapi/milvus/describe_access_control_list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群实例id', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c-123xxx', + ], + ], + ], + '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" }', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmilvus0MDRCH', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '集群id', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c-123xxx', + ], + ], + [ + 'name' => 'ComponentType', + 'in' => 'query', + 'schema' => [ + 'title' => '组件类型', + 'description' => '组件类型。取值范围：'."\n" + ."\n" + .'- Proxy', + 'type' => 'string', + 'required' => true, + 'example' => 'Proxy', + 'enum' => [ + 'Proxy', + ], + ], + ], + [ + 'name' => 'PublicNetworkEnabled', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '开启/关闭公网', + 'description' => '开启/关闭公网。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'Cidr', + 'in' => 'query', + 'schema' => [ + 'title' => 'Cidr块', + 'description' => 'Cidr块', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.**.**/24,172.1.**.**/16', + ], + ], + ], + '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', + ], + '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', + ], + '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' => [ + 'summary' => '设置Milvus公网访问IP白名单。', + 'path' => '/webapi/milvus/update_access_control_list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群id', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c-123xxx', + ], + ], + [ + 'name' => 'Cidr', + 'in' => 'query', + 'schema' => [ + 'title' => 'Cidr块', + 'description' => 'Cidr块。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.**.**/24,172.1.**.**/16', + ], + ], + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'title' => '公网访问控制id', + 'description' => '公网访问控制ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'acl-123xxx', + ], + ], + ], + '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' => '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" }', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236086', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + ], + 'RegionId' => [ + 'title' => '地域', + 'description' => '地域', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-zhangjiakou', + ], + 'ResourceId' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'ABCD-1234-5678-EFGH', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', + 'title' => '给指定资源打标签', + ], + 'UnTagResources' => [ + 'summary' => '删除标签', + 'path' => '/webapi/tags', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236098', + 'abilityTreeNodes' => [ + 'FEATUREmilvusCTW33S', + ], + ], + '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', + '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, + ], + ], + [ + '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', + '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' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ABCD-1234-5678-EFGH', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', + 'title' => '删除资源标签', + ], + 'ChangeResourceGroup' => [ + 'summary' => '资源转组', + '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', + ], + ], + ], + ], + ], + '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', + ], + '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" } ', + ], + ], + ], + ], + ], + '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' => '创建服务角色', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'milvus.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'milvus.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'milvus.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'milvus.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'milvus.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'milvus.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'milvus.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'milvus.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'milvus.eu-central-1.aliyuncs.com', + ], + ], +]; |