'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'milvus', 'version' => '2023-10-12', ], 'directories' => [ [ 'id' => 321590, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateInstance', 'GetInstance', 'ListInstancesV2', 'DeleteInstance', 'UpdateInstanceName', 'GetInstanceDetail', 'ListInstances', 'UpdateInstance', ], ], [ 'id' => 321599, 'title' => null, 'type' => 'directory', 'children' => [ 'ModifyInstanceConfig', 'DescribeInstanceConfigs', ], ], [ 'id' => 321602, 'title' => null, 'type' => 'directory', 'children' => [ 'DescribeAccessControlList', 'UpdatePublicNetworkStatus', 'UpdateAccessControlList', ], ], [ 'id' => 321606, 'title' => null, 'type' => 'directory', 'children' => [ 'TagResources', 'UnTagResources', 'ChangeResourceGroup', 'CreateDefaultRole', ], ], ], 'components' => [ 'schemas' => [ 'InstanceDetail' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'instanceName' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'milvus-test', 'backendName' => 'instanceName', ], 'instanceId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'c-xxx', 'backendName' => 'instanceId', ], 'regionId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-beijing', 'backendName' => 'regionId', ], 'zoneId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'backendName' => 'zoneId', ], 'status' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'running', 'backendName' => 'status', ], 'paymentType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [ 'PayAsYouGo' => 'PayAsYouGo', 'Subscription' => 'Subscription', ], 'example' => 'PayAsYouGo', 'backendName' => 'paymentType', ], 'resourceGroupId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rg-aek3dcgyq7pnqwa', 'backendName' => 'resourceGroupId', ], 'vpcId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'vpc-xxx', 'backendName' => 'vpcId', ], 'createTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-04-27T02:04:25Z', 'backendName' => 'createTime', ], 'runningTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'runningTime', ], 'expireTime' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-04-27T02:04:25Z'."\n", 'backendName' => 'expireTime', ], 'dbVersion' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '2.5', 'backendName' => 'dbVersion', ], 'orderId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => '4751', 'backendName' => 'orderId', ], 'autoBackup' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'autoBackup', ], 'configuration' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'rootCoord:'."\n" .' maxDatabaseNum: 64 # Maximum number of database'."\n" .' maxPartitionNum: 4096 ', 'backendName' => 'configuration', ], 'ha' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'ha', ], 'multiZoneMode' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Single', 'backendName' => 'multiZoneMode', ], 'encrypted' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'encrypted', ], 'kmsKeyId' => [ 'description' => 'kms key Id。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'key-xxx', 'backendName' => 'kmsKeyId', ], 'vSwitchIds' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'zoneId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'backendName' => 'zoneId', ], 'vswId' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'vsw-xxx', 'backendName' => 'vswId', ], ], 'extendType' => 'true', ], 'backendName' => 'vswitchIds', ], 'securityGroupIds' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'sg-xxx', 'extendType' => 'true', ], 'backendName' => 'securityGroupIds', ], 'tags' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'k1', 'backendName' => 'key', ], 'value' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'v1', 'backendName' => 'value', ], ], 'extendType' => 'true', ], 'backendName' => 'tags', ], 'components' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'data', 'backendName' => 'type', ], 'replica' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'replica', ], 'cuNum' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'backendName' => 'cuNum', ], 'cuType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'general', 'backendName' => 'cuType', ], 'diskSizeType' => [ 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Normal', 'backendName' => 'diskSizeType', ], ], 'extendType' => 'true', ], 'backendName' => 'components', ], ], ], ], ], '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' => '地域', 'type' => 'string', 'example' => 'cn-beijing', ], ], [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'zoneId' => [ 'title' => '主可用区。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing-g', ], 'instanceName' => [ 'title' => '实例名称', 'type' => 'string', 'example' => 'milvus-test', ], 'dbVersion' => [ 'title' => '内核版本', 'type' => 'string', 'required' => true, 'example' => '2.4', ], 'resourceGroupId' => [ 'title' => '资源组id', 'type' => 'string', 'example' => 'rg-xxx', ], 'vpcId' => [ 'title' => '专有网络id', 'type' => 'string', 'required' => true, 'example' => 'vpc-123xxx', ], 'paymentType' => [ 'title' => '付费类型', 'type' => 'string', 'required' => true, 'example' => 'PayAsYouGo', ], 'paymentDuration' => [ 'title' => '付费时长', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'paymentDurationUnit' => [ 'title' => '付费单位', 'type' => 'string', 'example' => 'month', ], 'ha' => [ 'title' => '是否开启高可用', 'type' => 'boolean', 'example' => 'true', ], 'dbAdminPassword' => [ 'title' => 'db密码', 'type' => 'string', 'example' => 'test12', ], 'autoBackup' => [ 'title' => '是否开启自动备份', 'type' => 'boolean', ], 'multiZoneMode' => [ 'title' => '可用区配置。', 'type' => 'string', ], 'encrypted' => [ 'title' => '是否开启oss加密', 'type' => 'boolean', ], 'kmsKeyId' => [ 'title' => '用来加密的Kms key 的id。', 'type' => 'string', ], 'configuration' => [ 'title' => '配置项。', 'type' => 'string', ], 'promotionNo' => [ 'type' => 'string', ], 'loadReplicas' => [ 'type' => 'integer', 'format' => 'int32', ], 'isMultiAzStorage' => [ 'type' => 'boolean', ], 'vSwitchIds' => [ 'title' => '交换机', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'zoneId' => [ 'title' => '可用区。', 'type' => 'string', ], 'vswId' => [ 'title' => '可用区下vswitch id配置。', 'type' => 'string', ], ], ], 'example' => '["vsw-123xxx"]', ], 'components' => [ 'title' => '组件信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '组件类型', 'type' => 'string', 'required' => true, 'example' => 'standalone', ], 'replica' => [ 'title' => '副本数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'cuNum' => [ 'title' => 'CU数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8', ], 'cuType' => [ 'title' => 'CU类型。', 'type' => 'string', 'example' => 'general', ], 'diskSizeType' => [ 'title' => 'Query Node配置容量型，性能型，容量型配置Large，其余配置Normal。', 'type' => 'string', 'docRequired' => false, 'enum' => [ 'Large', 'Normal', ], ], ], ], ], 'tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => [ 'type' => 'string', ], 'value' => [ 'type' => 'string', ], ], ], ], 'autoRenew' => [ 'type' => 'boolean', ], ], ], ], [ 'name' => 'clientToken', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求唯一号', 'description' => '', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'success' => [ 'title' => '请求是否成功', 'type' => 'boolean', 'example' => 'true', ], 'data' => [ 'type' => 'object', 'properties' => [ 'instanceId' => [ 'type' => 'string', ], 'orderId' => [ 'type' => 'string', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"instanceId\\": \\"c-xxx\\",\\n \\"orderId\\": \\"xxx\\"\\n }\\n}","type":"json"}]', ], 'GetInstance' => [ 'summary' => '获取实例详情', 'path' => '/webapi/instance/get', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], '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' => '', '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"}]', ], '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' => '', 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'title' => '分页大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'title' => '资源组id', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rg-123xxx', ], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'k1', ], 'value' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'v1', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => '', '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' => '', '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"}]', ], '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' => '', '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' => '', 'type' => 'string', 'example' => 'c-xxxx', ], 'orderId' => [ 'title' => '订单ID', 'description' => '', '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"}]', ], 'UpdateInstanceName' => [ 'summary' => 'Modifies the name of an instance.', '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' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'milvus-test', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '集群实例id', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情', 'description' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], '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' => 'UpdateInstanceName', ], 'GetInstanceDetail' => [ 'summary' => 'Get the details of an instance.', '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' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'title' => '集群id', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'c-123xxx', ], 'BeginTime' => [ 'title' => '开始时间', 'description' => 'The start time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1716863508000', ], 'RunningTime' => [ 'title' => '运行时间', 'description' => 'The runtime.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1743679', ], 'ExpireTime' => [ 'title' => '过期时间', 'description' => 'The expiration time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1721664000000', ], 'RegionId' => [ 'title' => '地域', 'description' => 'The region code.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'ZoneId' => [ 'title' => '可用区', 'description' => 'The zone.'."\n", 'type' => 'string', 'example' => 'cn-beijing-g', ], 'InstanceStatus' => [ 'title' => '状态', 'description' => 'The instance status. Valid values:'."\n" ."\n" .'* creating.'."\n" .'* running.'."\n" .'* updating. Cluster scaling (up/down), configuration changes, and enabling/disabling public network access.'."\n" .'* disable. The cluster has expired and needs to be renewed for activation.'."\n" .'* deleting.'."\n" .'* deleted.'."\n", 'type' => 'string', 'example' => 'running', ], 'PackageType' => [ 'title' => '规格', 'description' => 'The specification details. Valid values:'."\n" ."\n" .'* trial.'."\n" .'* standard.'."\n", 'type' => 'string', 'example' => 'standard', ], 'ClusterInfo' => [ 'title' => '集群详情', 'description' => 'The instance details.'."\n", 'type' => 'object', 'properties' => [ 'MilvusResourceInfoList' => [ 'title' => '资源详情', 'description' => 'The resource details.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '组件类型', 'description' => 'The component type. Valid values:'."\n" ."\n" .'* standalone'."\n" .'* proxy'."\n" .'* mix_coordinator'."\n" .'* query'."\n" .'* index'."\n" .'* data'."\n", 'type' => 'string', 'example' => 'QueryNode', ], 'CuNum' => [ 'title' => 'CU数量', 'description' => 'The number of CUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'CuRatio' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'Replica' => [ 'title' => '副本数量', 'description' => 'The number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'DiskSize' => [ 'title' => '磁盘大小', 'description' => 'The disk size.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'DiskType' => [ 'title' => '磁盘类型', 'description' => 'The disk type.'."\n", 'type' => 'string', 'example' => 'essd', ], 'ZoneId' => [ 'type' => 'string', ], ], 'description' => '', ], ], 'IntranetUrl' => [ 'title' => '内网地址', 'description' => 'The internal IP address.'."\n", 'type' => 'string', 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', ], 'InternetUrl' => [ 'title' => '公网地址', 'description' => 'The public IP address.'."\n", 'type' => 'string', 'example' => 'c-123xxx-.milvus.aliyuncs.com', ], 'TotalCuNum' => [ 'title' => '总CU数量', 'description' => 'The total number of CUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '24', ], 'TotalDiskSize' => [ 'title' => '总磁盘数量', 'description' => 'The total number of disks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '500', ], 'ProxyPort' => [ 'title' => 'Proxy端口', 'description' => 'The proxy port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '19530', ], 'AttuPort' => [ 'title' => 'Attu组件端口', 'description' => 'The port of the Attu component.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3000', ], 'OssStorageTimestamp' => [ 'title' => 'OSS存储指标时间', 'description' => 'The timestamp when the OSS metric is stored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1718604000000', ], 'OssStorageSize' => [ 'title' => 'OSS存储数据大小', 'description' => 'The size of the data stored in OSS.'."\n", 'type' => 'string', 'example' => '125.15 GB', ], ], ], 'VpcId' => [ 'title' => '专有网络id', 'description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'example' => 'vpc-123xxx', ], 'VswId' => [ 'title' => '交换机id', 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-123xxx', ], 'SgId' => [ 'title' => '安全组id', 'description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-123xxx', ], 'OpenPublicNet' => [ 'title' => '是否开启公网', 'description' => 'Indicates whether Internet access is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ClusterName' => [ 'title' => '集群名称', 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'aliyun-test', ], 'PayType' => [ 'title' => '付费类型', 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* 0: pay-as-you-go'."\n" .'* 1: subscription'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BucketName' => [ 'title' => 'bucket名称', 'description' => 'The name of the bucket.'."\n", 'type' => 'string', 'example' => 'milvus-test', ], 'BucketPath' => [ 'title' => 'bucket地址', 'description' => 'The address of the bucket.'."\n", 'type' => 'string', 'example' => 'https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx', ], 'Version' => [ 'title' => '内核版本', 'description' => 'The kernel version.'."\n", 'type' => 'string', 'example' => '2.4', ], 'AclId' => [ 'title' => '公网访问控制aclId', 'description' => 'AclId for Public Network Access Control.'."\n", 'type' => 'string', 'example' => 'acl-123xxx', ], 'UserConfig' => [ 'title' => '用户自定义配置', 'description' => 'User-defined configuration.'."\n", 'type' => 'string', 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', ], 'TemplateVersion' => [ 'title' => '软件栈版本', 'description' => 'The version of the software stack.'."\n", 'type' => 'string', 'example' => '2.4.1-1.0-0.0.1', ], 'ProductCode' => [ 'title' => '商品code', 'description' => 'The commodity code.'."\n", 'type' => 'string', 'example' => 'milvus_milvuspre_public_cn', ], 'ResourceGroupId' => [ 'title' => '资源组id', 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-123xxx', ], 'MeasureConfig' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ProxyNodeCuNum' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'IndexNodeCuNum' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'QueryNodeCuNum' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'DataNodeCuNum' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'MixCoodinatorNodeCuNum' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'IndexNodeReplica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'QueryNodeReplica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'DataNodeReplica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'MixCoodinatorNodeReplica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ProxyNodeReplica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'EnableHa' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'NodeType' => [ 'description' => '', 'type' => 'string', 'example' => 'perf', ], 'Tags' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '', 'type' => 'string', 'example' => 'key1', ], 'Value' => [ 'description' => '', 'type' => 'string', 'example' => 'value1', ], ], ], ], 'Encrypted' => [ 'type' => 'string', ], 'KmsKeyId' => [ 'type' => 'string', ], 'MultiZoneMode' => [ 'title' => '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' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"c-123xxx\\",\\n \\"BeginTime\\": 1716863508000,\\n \\"RunningTime\\": 1743679,\\n \\"ExpireTime\\": 1721664000000,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-g\\",\\n \\"InstanceStatus\\": \\"running\\",\\n \\"PackageType\\": \\"standard\\",\\n \\"ClusterInfo\\": {\\n \\"MilvusResourceInfoList\\": [\\n {\\n \\"ComponentType\\": \\"standalone\\",\\n \\"CuNum\\": 8,\\n \\"CuRatio\\": 4,\\n \\"Replica\\": 2,\\n \\"DiskSize\\": 100,\\n \\"DiskType\\": \\"essd\\",\\n \\"ZoneId\\": \\"\\"\\n }\\n ],\\n \\"IntranetUrl\\": \\"c-123xxx-internal.milvus.aliyuncs.com\\",\\n \\"InternetUrl\\": \\"c-123xxx-.milvus.aliyuncs.com\\",\\n \\"TotalCuNum\\": 24,\\n \\"TotalDiskSize\\": 500,\\n \\"ProxyPort\\": 19530,\\n \\"AttuPort\\": 3000,\\n \\"OssStorageTimestamp\\": 1718604000000,\\n \\"OssStorageSize\\": \\"125.15 GB\\"\\n },\\n \\"VpcId\\": \\"vpc-123xxx\\",\\n \\"VswId\\": \\"vsw-123xxx\\",\\n \\"SgId\\": \\"sg-123xxx\\",\\n \\"OpenPublicNet\\": true,\\n \\"ClusterName\\": \\"aliyun-test\\",\\n \\"PayType\\": 1,\\n \\"BucketName\\": \\"milvus-test\\",\\n \\"BucketPath\\": \\"https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx\\",\\n \\"Version\\": \\"2.4\\",\\n \\"AclId\\": \\"acl-123xxx\\",\\n \\"UserConfig\\": \\"dataCoord:\\\\\\\\n segment:\\\\\\\\n maxSize: 1024\\",\\n \\"TemplateVersion\\": \\"2.4.1-1.0-0.0.1\\",\\n \\"ProductCode\\": \\"milvus_milvuspre_public_cn\\",\\n \\"ResourceGroupId\\": \\"rg-123xxx\\",\\n \\"MeasureConfig\\": {\\n \\"ProxyNodeCuNum\\": 4,\\n \\"IndexNodeCuNum\\": 4,\\n \\"QueryNodeCuNum\\": 4,\\n \\"DataNodeCuNum\\": 4,\\n \\"MixCoodinatorNodeCuNum\\": 4,\\n \\"IndexNodeReplica\\": 2,\\n \\"QueryNodeReplica\\": 2,\\n \\"DataNodeReplica\\": 2,\\n \\"MixCoodinatorNodeReplica\\": 2,\\n \\"ProxyNodeReplica\\": 2\\n },\\n \\"EnableHa\\": true,\\n \\"NodeType\\": \\"perf\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Encrypted\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"MultiZoneMode\\": \\"\\",\\n \\"VSwitches\\": [\\n {\\n \\"VswId\\": \\"\\",\\n \\"ZoneId\\": \\"\\"\\n }\\n ],\\n \\"HighAvailability\\": {\\n \\"Mode\\": \\"\\",\\n \\"PrimaryZoneId\\": \\"\\",\\n \\"SecondaryZoneId\\": \\"\\",\\n \\"CurrentActiveAZ\\": \\"\\"\\n }\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', 'title' => 'GetInstanceDetail', ], 'ListInstances' => [ 'summary' => 'Get the list of Milvus instances under the current account.', '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' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'milvus-test', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'title' => '集群id', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页大小', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => '地域', 'description' => 'The region code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'title' => '资源组id', 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-123xxx', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'Value' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'title' => '集群id', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'c-123xxx', ], 'BeginTime' => [ 'title' => '开始时间', 'description' => 'The start time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1718608505000', ], 'RunningTime' => [ 'title' => '运行时间', 'description' => 'The runtime.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '536611', ], 'ExpireTime' => [ 'title' => '过期时间', 'description' => 'The expiration time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1721232000000', ], 'RegionId' => [ 'title' => '地域', 'description' => 'The region code.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'ZoneId' => [ 'title' => '可用区', 'description' => 'The zone.'."\n", 'type' => 'string', 'example' => 'cn-beijing-g', ], 'InstanceStatus' => [ 'title' => '状态', 'description' => 'The status of the bastion host. Valid values:'."\n" ."\n" .'* creating.'."\n" .'* running.'."\n" .'* updating. Cluster scaling (up/down), configuration changes, and enabling/disabling public network access.'."\n" .'* disable. The cluster has expired and needs to be renewed for activation.'."\n" .'* deleting.'."\n" .'* deleted.'."\n", 'type' => 'string', 'example' => 'running', ], 'ClusterName' => [ 'title' => '集群名称', 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'milvus-test', ], 'PackageType' => [ 'title' => '规格', 'description' => 'The specification details. Valid values:'."\n" ."\n" .'* trial.'."\n" .'* standard.'."\n", 'type' => 'string', 'example' => 'trial', ], 'ClusterInfo' => [ 'title' => '集群详情', 'description' => 'The instance details.'."\n", 'type' => 'object', 'properties' => [ 'MilvusResourceInfoList' => [ 'title' => '资源详情', 'description' => 'The resource details.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentType' => [ 'title' => '组件类型', 'description' => 'The type of the component. Valid values:'."\n" ."\n" .'* standalone'."\n" .'* proxy'."\n" .'* mix_coordinator'."\n" .'* query'."\n" .'* index'."\n" .'* data'."\n", 'type' => 'string', 'example' => 'standalone', ], 'CuNum' => [ 'title' => 'CU数量', 'description' => 'The number of CUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'Replica' => [ 'title' => '副本数量', 'description' => 'The number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DiskSize' => [ 'title' => '磁盘大小', 'description' => 'The disk size.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'DiskType' => [ 'title' => '磁盘类型', 'description' => 'The disk type.'."\n", 'type' => 'string', 'example' => 'essd', ], ], 'description' => '', ], ], 'IntranetUrl' => [ 'title' => '内网地址', 'description' => 'The internal endpoint.'."\n", 'type' => 'string', 'example' => 'c-123xxx-internal.milvus.aliyuncs.com', ], 'InternetUrl' => [ 'title' => '公网地址', 'description' => 'The public IP address.'."\n", 'type' => 'string', 'example' => 'c-123xxx.milvus.aliyuncs.com', ], 'TotalCuNum' => [ 'title' => 'CU数量', 'description' => 'The number of CUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '24', ], 'TotalDiskSize' => [ 'title' => '磁盘总量', 'description' => 'The total capacity of the disk.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '500', ], 'ProxyPort' => [ 'title' => 'Proxy端口', 'description' => 'The proxy port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '19530', ], 'AttuPort' => [ 'title' => 'attu组件端口', 'description' => 'The port of the Attu component.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3000', ], ], ], 'VpcId' => [ 'title' => '专有网络id', 'description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'example' => 'vpc-123xxx', ], 'VswId' => [ 'title' => '交换机id', 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-123xxx', ], 'SgId' => [ 'title' => '安全组id', 'description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-123xxx', ], 'OpenPublicNet' => [ 'title' => '是否开启公网', 'description' => 'Indicates whether Internet access is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'PayType' => [ 'title' => '付费类型', 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* 0: pay-as-you-go'."\n" .'* 1: subscription'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ProductCode' => [ 'title' => '商品code', 'description' => 'The commodity code.'."\n", 'type' => 'string', 'example' => 'milvus_milvuspre_public_cn', ], 'ResourceGroupId' => [ 'title' => '资源组id', 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-123xxx', ], 'NodeType' => [ 'description' => '', 'type' => 'string', 'example' => 'perf', ], 'AutoBackup' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Tags' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '', 'type' => 'string', 'example' => 'key1', ], 'Value' => [ 'description' => '', 'type' => 'string', 'example' => 'value1', ], ], ], ], 'Version' => [ 'type' => 'string', ], ], 'description' => '', ], ], 'Total' => [ 'title' => '总数', 'description' => 'The total number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情', 'description' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], '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' => 'ListInstances', ], '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' => '', 'type' => 'object', 'properties' => [ 'instanceId' => [ 'title' => '实例ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'c-xxxx', ], 'instanceName' => [ 'title' => '实例名称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'milvus-test', ], 'configuration' => [ 'title' => '配置信息', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rootCoord:\\n maxDatabaseNum: 64', ], 'ha' => [ 'title' => '是否开启高可用', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'autoBackup' => [ 'title' => '是否开启自动备份', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'components' => [ 'title' => '组件信息', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '组件类型', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'standalone', ], 'replica' => [ 'title' => '副本数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'cuNum' => [ 'title' => 'CU数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'clientToken', 'in' => 'query', 'schema' => [ 'description' => '', '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"}]', ], 'ModifyInstanceConfig' => [ 'summary' => 'Update the configuration parameters of each component of 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' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', ], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => [ 'title' => '更新原因', 'description' => 'The reason for the update.'."\n", 'type' => 'string', 'required' => true, 'example' => 'for test', ], ], [ 'name' => 'UserConfig', 'in' => 'query', 'schema' => [ 'title' => '用户自定义配置', 'description' => 'User-defined configuration.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dataCoord:\\n segment:\\n maxSize: 1024', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情', 'description' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', 'title' => 'ModifyInstanceConfig', ], 'DescribeInstanceConfigs' => [ 'summary' => 'Get information about the custom configuration of each component of Milvus.', 'path' => '/webapi/config/describe_milvus_user_config', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREmilvusCTW33S', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '集群实例id', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'default' => 'true', ], 'ErrCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx.', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'string', 'format' => 'byte', 'example' => 'dataCoord:\\n enableCompaction: true', ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情', 'description' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx.\\",\\n \\"Data\\": \\"dataCoord:\\\\\\\\n enableCompaction: true\\",\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', 'title' => 'DescribeInstanceConfigs', ], 'DescribeAccessControlList' => [ 'summary' => 'Get the public IP address whitelist of a Milvus instance.', 'path' => '/webapi/milvus/describe_access_control_list', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREmilvusCTW33S', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '集群实例id', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrorCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ 'AclId' => [ 'title' => '公网访问控制的AclId', 'description' => 'AclId for public network access control.'."\n", 'type' => 'string', 'example' => 'acl-xxxx', ], 'Cidr' => [ 'title' => 'Cidr块', 'description' => 'The CIDR blocks.'."\n", 'type' => 'array', 'items' => [ 'title' => 'ip段', 'description' => 'The IP address segment.'."\n", 'type' => 'string', 'example' => '192.168.1.2', ], ], ], ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情', 'description' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": {\\n \\"AclId\\": \\"acl-xxxx\\",\\n \\"Cidr\\": [\\n \\"192.168.**.**\\"\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\"\\n}","type":"json"}]', 'title' => 'DescribeAccessControlList', ], 'UpdatePublicNetworkStatus' => [ 'summary' => 'Enable or disable Internet access for Milvus.', 'path' => '/webapi/network/updatePublicNetworkStatus', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], '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' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-123xxx', ], ], [ 'name' => 'ComponentType', 'in' => 'query', 'schema' => [ 'title' => '组件类型', 'description' => 'The component type. Valid values:'."\n" ."\n" .'* Proxy'."\n", 'type' => 'string', 'required' => true, 'example' => 'Proxy', 'enum' => [ 'Proxy', ], ], ], [ 'name' => 'PublicNetworkEnabled', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '开启/关闭公网', 'description' => 'Enable /disable the Internet.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'Cidr', 'in' => 'query', 'schema' => [ 'title' => 'Cidr块', 'description' => 'The CIDR blocks.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.**.**/24,172.1.**.**/16', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Failed to find instance', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情', 'description' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], 'description' => '', ], ], ], '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' => 'UpdatePublicNetworkStatus', ], 'UpdateAccessControlList' => [ 'summary' => 'Configure Public IP Address Whitelist', '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' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-123xxx', ], ], [ 'name' => 'Cidr', 'in' => 'query', 'schema' => [ 'title' => 'Cidr块', 'description' => 'The CIDR blocks.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.1.0/24,172.16.0.0/16', ], ], [ 'name' => 'AclId', 'in' => 'query', 'schema' => [ 'title' => '公网访问控制id', 'description' => 'The ID of public network access control'."\n", 'type' => 'string', 'required' => false, 'example' => 'acl-123xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrorCode' => [ 'title' => '错误码', 'description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'ILLEGAL.MilvusCidrFormat', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The format of cidr is illegal.', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情', 'description' => 'The detailed information about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }', ], ], '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' => 'UpdateAccessControlList', ], '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' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'c-xx', ], 'required' => true, ], 'Tag' => [ 'title' => '对应新增标签列表，最多包含20个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'k1', ], 'Value' => [ 'title' => '标签值', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'v1', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', ], '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' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'c-xx', ], 'required' => true, ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '对应标签键列表，最多包含20个子项', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'tk4', ], 'required' => false, ], ], [ 'name' => 'All', 'in' => 'query', 'schema' => [ 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\"\\n}","type":"json"}]', ], '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' => '', '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' => '', 'type' => 'string', 'required' => false, 'example' => 'c-xxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rg-123xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'ErrCode' => [ 'description' => '', 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'description' => '', 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => 'None', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', ], 'CreateDefaultRole' => [ 'summary' => 'Create a service role for Milvus to access other cloud products', 'path' => '/webapi/user/create_default_role', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREmilvusGDAFRH', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HttpStatusCode' => [ 'title' => 'http请求状态码', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'RequestId' => [ 'title' => '请求唯一号', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABCD-1234-5678-EFGH', ], 'Success' => [ 'title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ErrCode' => [ 'title' => '错误码', 'description' => 'The error code'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', ], 'ErrMessage' => [ 'title' => '错误信息', 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'Failed to find instance c-123xxx', ], 'Data' => [ 'title' => '返回数据', 'description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AccessDeniedDetail' => [ 'title' => '权限校验失败详情 ', 'description' => 'The details about the failed permission verification.'."\n", 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" } ', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCD-1234-5678-EFGH\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Instance.NotFound\\",\\n \\"ErrMessage\\": \\"Failed to find instance c-123xxx\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"milvus:xxxx\\\\\\" }\\\\t\\"\\n}","type":"json"}]', 'title' => 'CreateDefaultRole', ], ], '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', ], ], ];