DescribeEnvironment - Application Real-Time Monitoring Service

Mengkueri detail lingkungan.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah.	cn-hangzhou
EnvironmentId	string	Yes	ID instans lingkungan.	env-xxxxx

Elemen respons

Element	Type	Description	Example
	object	Skema tanggapan.
RequestId	string	ID permintaan.	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	Kode status. Nilai 200 menunjukkan keberhasilan. Nilai lain menunjukkan error.	200
Data	object	Struktur tanggapan.
EnvironmentId	string	ID instans lingkungan.	env-xxxxx
EnvironmentType	string	Tipe lingkungan. Nilai valid: CS: Layanan kontainer. ECS. Cloud: layanan cloud.	CS
EnvironmentName	string	Nama lingkungan.	env1
EnvironmentSubType	string	Subtipe lingkungan. Nilai valid: CS: ACK didukung. ECS: ECS didukung. Cloud: Cloud didukung.	ACK
RegionId	string	ID wilayah.	cn-hangzhou
UserId	string	ID pengguna.	13002222xxxx
BindResourceId	string	ID sumber daya yang terikat ke lingkungan, termasuk ID instans kontainer atau ID VPC.	vpc-xxxxx
BindResourceType	string	Tipe sumber daya yang terikat.	ECS
BindResourceStatus	string	Status sumber daya yang terikat.	running
BindResourceProfile	string	Profil sumber daya yang terikat.	Default
BindVpcCidr	string	Blok CIDR VPC yang terikat.	192.168.0.0/16
PrometheusInstanceId	string	ID instans Prometheus yang dilampirkan.	xxxxyyyyyzzzzz
PrometheusInstanceName	string	Nama instans Prometheus yang terikat.	name1
GrafanaWorkspaceId	string	ID ruang kerja Grafana.	grafana-cn-i7m2qn9xa01
GrafanaFolderUid	string	ID unik folder Grafana.	xyz
GrafanaDatasourceUid	string	ID unik sumber data Grafana.	zuvw
VpcId	string	ID VPC.	vpc-8vb02uk57qbcktqcvqqqj
GrafanaFolderUrl	string	URL folder Grafana.	https://gnew.console.alibabacloud.com/dashboards/f/xxx/yyyy
BindResourceStoreDuration	string	Durasi penyimpanan sumber daya yang terikat, dalam hari.	15
GrafaDataSourceName	string	Nama sumber data Grafana.	datasource1
GrafanaFolderTitle	string	Nama folder Grafana.	folder1
ManagedType	string	Tipe pengelolaan. Nilai valid: none: tidak dikelola. Ini adalah nilai default untuk kluster ACK. agent: agen terkelola (termasuk KSM). Ini adalah nilai default untuk kluster ASK, ACS, dan AckOne. agent-exporter: agen terkelola dan exporter. Ini adalah nilai default untuk tipe layanan cloud. Valid values: agent : Agen terkelola. agent-exporter : Agen terkelola dan exporter. none : Tidak dikelola.	none
FeePackage	string	Paket penagihan. Nilai valid: Jika EnvironmentType adalah CS, nilainya dapat berupa CS_Basic atau CS_Pro. Jika EnvironmentType diatur ke nilai lain, parameter ini kosong. Valid values: CS_Pro : Edisi Pro pemantauan kontainer. CS_Basic : Edisi dasar pemantauan kontainer.	CS_Basic
DbInstanceStatus	string	Status database instans Prometheus yang terikat. Valid values: UNINSTALLING : UNINSTALLING. INSTALLING : INSTALLING. UNINSTALLED : UNINSTALLED. RUNNING : RUNNING. MODIFYING : MODIFYING.	RUNNING
SecurityGroupId	string	ID grup keamanan yang terikat ke lingkungan.	sg-8vbdgmf4nraiqa9bx0jo
VswitchId	string	ID vSwitch yang terikat ke lingkungan.	vsw-2ze7yr3f1x8snryaioo7u
ResourceGroupId	string	ID kelompok sumber daya.	rg-aek2vezare****
Tags	array<object>	Tag.
	object	Tag.
Key	string	The tag key.	user1
Value	string	The tag value.	p_运维
Message	string	Paket yang dikembalikan untuk permintaan.	message

Contoh

Respons sukses

JSONformat

{
  "RequestId": "C21AB7CF-B7AF-410F-BD61-82D1567F****",
  "Code": 200,
  "Data": {
    "EnvironmentId": "env-xxxxx",
    "EnvironmentType": "CS",
    "EnvironmentName": "env1",
    "EnvironmentSubType": "ACK",
    "RegionId": "cn-hangzhou",
    "UserId": "13002222xxxx",
    "BindResourceId": "vpc-xxxxx",
    "BindResourceType": "ECS",
    "BindResourceStatus": "running",
    "BindResourceProfile": "Default",
    "BindVpcCidr": "192.168.0.0/16",
    "PrometheusInstanceId": "xxxxyyyyyzzzzz",
    "PrometheusInstanceName": "name1",
    "GrafanaWorkspaceId": "grafana-cn-i7m2qn9xa01",
    "GrafanaFolderUid": "xyz",
    "GrafanaDatasourceUid": "zuvw",
    "VpcId": "vpc-8vb02uk57qbcktqcvqqqj",
    "GrafanaFolderUrl": "https://gnew.console.alibabacloud.com/dashboards/f/xxx/yyyy",
    "BindResourceStoreDuration": "15",
    "GrafaDataSourceName": "datasource1",
    "GrafanaFolderTitle": "folder1",
    "ManagedType": "none",
    "FeePackage": "CS_Basic",
    "DbInstanceStatus": "RUNNING",
    "SecurityGroupId": "sg-8vbdgmf4nraiqa9bx0jo",
    "VswitchId": "vsw-2ze7yr3f1x8snryaioo7u",
    "ResourceGroupId": "rg-aek2vezare****",
    "Tags": [
      {
        "Key": "user1",
        "Value": "p_运维"
      }
    ]
  },
  "Message": "message"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.