Gunakan GetInstanceDetail API untuk mengambil detail instans Milvus - Vector Retrieval Service for Milvus

Mengambil detail instans.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

milvus:GetInstanceDetail

get

*Instance

acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Sintaks permintaan

POST /webapi/cluster/detail HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	No	ID instans.	c-123xxx

Elemen respons

Element	Type	Description	Example
	object
HttpStatusCode	integer	Kode status HTTP.	200
RequestId	string	ID permintaan.	ABCD-1234-5678-EFGH
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
ErrCode	string	Kode kesalahan.	Instance.NotFound
ErrMessage	string	Pesan kesalahan.	Failed to find instance c-123xxx
Data	object	Data yang dikembalikan.
InstanceId	string	ID instans.	c-123xxx
BeginTime	integer	Waktu mulai.	1716863508000
RunningTime	integer	Waktu proses.	1743679
ExpireTime	integer	Waktu kedaluwarsa.	1721664000000
RegionId	string	Wilayah.	cn-beijing
ZoneId	string	Zona.	cn-beijing-g
InstanceStatus	string	Status instans. Nilai yang valid: creating: Instans sedang dibuat. running: Instans sedang berjalan. updating: Instans sedang ditingkatkan. Ini mencakup peningkatan atau penurunan kluster, perubahan konfigurasi, serta mengaktifkan atau menonaktifkan akses Internet. disable: Instans tidak tersedia. Kluster telah kedaluwarsa dan harus diperpanjang agar diaktifkan kembali. deleting: Instans sedang dihapus. deleted: Instans telah dihapus.	running
PackageType	string	Edisi instans. Nilai yang valid: trial: Edisi Starter. standard: Edisi Standar.	standard
ClusterInfo	object	Detail instans.
MilvusResourceInfoList	array<object>	Detail resource.
	object
ComponentType	string	Tipe komponen. Nilai yang valid: standalone proxy mix_coordinator query index data	standalone
CuNum	integer	Jumlah CU.	8
CuRatio	integer	Spesifikasi CU. Nilai yang valid: 4: 1 core hingga 4 GB memori. 8: 1 core hingga 8 GB memori.	4
Replica	integer	Jumlah replika.	2
DiskSize	integer	Ukuran disk.	100
DiskType	string	Tipe disk.	essd
ZoneId	string
IntranetUrl	string	Titik akhir internal.	c-123xxx-internal.milvus.aliyuncs.com
InternetUrl	string	Titik akhir publik.	c-123xxx-.milvus.aliyuncs.com
TotalCuNum	integer	Total jumlah CU.	24
TotalDiskSize	integer	Total ukuran disk.	500
ProxyPort	integer	Port proxy.	19530
AttuPort	integer	Port komponen Attu.	3000
OssStorageTimestamp	integer	Timestamp metrik penyimpanan OSS.	1718604000000
OssStorageSize	string	Ukuran data yang disimpan di OSS.	125.15 GB
VpcId	string	ID virtual private cloud (VPC).	vpc-123xxx
VswId	string	ID vSwitch.	vsw-123xxx
SgId	string	ID security group.	sg-123xxx
OpenPublicNet	boolean	Menunjukkan apakah akses Internet diaktifkan.	true
ClusterName	string	Nama instans.	aliyun-test
PayType	integer	Metode penagihan. Nilai yang valid: 0: Pay-as-you-go. 1: Subscription.	1
BucketName	string	Nama bucket.	milvus-test
BucketPath	string	Jalur bucket.	https://oss.console.alibabacloud.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx
Version	string	Versi Milvus.	2.4
AclId	string	ID daftar kontrol akses (ACL) untuk akses publik.	acl-123xxx
UserConfig	string	Konfigurasi kustom.	dataCoord:\n segment:\n maxSize: 1024
TemplateVersion	string	Versi tumpukan perangkat lunak.	2.4.1-1.0-0.0.1
ProductCode	string	Kode produk.	milvus_milvuspre_public_cn
ResourceGroupId	string	ID kelompok sumber daya.	rg-123xxx
MeasureConfig	object	Informasi konfigurasi.
ProxyNodeCuNum	integer	Jumlah CU untuk node proxy.	4
IndexNodeCuNum	integer	Jumlah CU untuk node index.	4
QueryNodeCuNum	integer	Jumlah CU untuk node query.	4
DataNodeCuNum	integer	Jumlah CU untuk node data.	4
MixCoodinatorNodeCuNum	integer	Jumlah CU untuk node MixCoordinator.	4
IndexNodeReplica	integer	Jumlah replika untuk node index.	2
QueryNodeReplica	integer	Jumlah replika untuk node query.	2
DataNodeReplica	integer	Jumlah replika untuk node data.	2
MixCoodinatorNodeReplica	integer	Jumlah replika untuk node MixCoordinator.	2
ProxyNodeReplica	integer	Jumlah replika untuk node proxy.	2
EnableHa	boolean	Menunjukkan apakah ketersediaan tinggi (HA) diaktifkan.	true
NodeType	string	Tipe node. Nilai yang valid: perf: Compute-optimized. cap: Storage-optimized.	perf
Tags	array<object>	Informasi tag.
	object	Informasi tag.
Key	string	Kunci tag.	key1
Value	string	Nilai tag.	value1
Encrypted	string
KmsKeyId	string
MultiZoneMode	string
VSwitches	array<object>
	object
VswId	string
ZoneId	string
HighAvailability	object
Mode	string
PrimaryZoneId	string
SecondaryZoneId	string
CurrentActiveAZ	string
AccessDeniedDetail	string	Detail tentang penolakan akses.	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "ABCD-1234-5678-EFGH",
  "Success": true,
  "ErrCode": "Instance.NotFound",
  "ErrMessage": "Failed to find instance c-123xxx",
  "Data": {
    "InstanceId": "c-123xxx",
    "BeginTime": 1716863508000,
    "RunningTime": 1743679,
    "ExpireTime": 1721664000000,
    "RegionId": "cn-beijing",
    "ZoneId": "cn-beijing-g",
    "InstanceStatus": "running",
    "PackageType": "standard",
    "ClusterInfo": {
      "MilvusResourceInfoList": [
        {
          "ComponentType": "standalone",
          "CuNum": 8,
          "CuRatio": 4,
          "Replica": 2,
          "DiskSize": 100,
          "DiskType": "essd",
          "ZoneId": ""
        }
      ],
      "IntranetUrl": "c-123xxx-internal.milvus.aliyuncs.com",
      "InternetUrl": "c-123xxx-.milvus.aliyuncs.com",
      "TotalCuNum": 24,
      "TotalDiskSize": 500,
      "ProxyPort": 19530,
      "AttuPort": 3000,
      "OssStorageTimestamp": 1718604000000,
      "OssStorageSize": "125.15 GB"
    },
    "VpcId": "vpc-123xxx",
    "VswId": "vsw-123xxx",
    "SgId": "sg-123xxx",
    "OpenPublicNet": true,
    "ClusterName": "aliyun-test",
    "PayType": 1,
    "BucketName": "milvus-test",
    "BucketPath": "https://oss.console.alibabacloud.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx",
    "Version": "2.4",
    "AclId": "acl-123xxx",
    "UserConfig": "dataCoord:\\n  segment:\\n    maxSize: 1024",
    "TemplateVersion": "2.4.1-1.0-0.0.1",
    "ProductCode": "milvus_milvuspre_public_cn",
    "ResourceGroupId": "rg-123xxx",
    "MeasureConfig": {
      "ProxyNodeCuNum": 4,
      "IndexNodeCuNum": 4,
      "QueryNodeCuNum": 4,
      "DataNodeCuNum": 4,
      "MixCoodinatorNodeCuNum": 4,
      "IndexNodeReplica": 2,
      "QueryNodeReplica": 2,
      "DataNodeReplica": 2,
      "MixCoodinatorNodeReplica": 2,
      "ProxyNodeReplica": 2
    },
    "EnableHa": true,
    "NodeType": "perf",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Encrypted": "",
    "KmsKeyId": "",
    "MultiZoneMode": "",
    "VSwitches": [
      {
        "VswId": "",
        "ZoneId": ""
      }
    ],
    "HighAvailability": {
      "Mode": "",
      "PrimaryZoneId": "",
      "SecondaryZoneId": "",
      "CurrentActiveAZ": ""
    }
  },
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.