Kueri resource namespace dengan DescribeNamespaceResources - SAE - Alibaba Cloud - Serverless App Engine

Mengkueri resource di namespace.

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

sae:DescribeNamespaceResources

get

*全部资源

*

None

Sintaks permintaan

GET /pop/v1/sam/namespace/describeNamespaceResources HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
NamespaceId	string	No	ID namespace. Formatnya adalah `ID Wilayah:Nama namespace`. Parameter ini dipertahankan untuk kompatibilitas mundur. Jika Anda menentukan parameter ini, `NameSpaceShortId` akan diabaikan. Kami menyarankan Anda menggunakan `NameSpaceShortId` untuk menyederhanakan permintaan.	cn-shanghai:test
NameSpaceShortId	string	No	ID namespace. ID wilayah tidak disertakan. Kami menyarankan Anda menggunakan parameter ini.	test

Elemen respons

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. Valid values: If the request is successful, success is returned. If the request fails, an error code is returned.	success
TraceId	string	The trace ID. You can use this ID to query the details of the call.	0a98a02315955564772843261e****
Data	object	The response data.
VpcId	string	The VPC ID.	vpc-2ze0i263cnn311nvj****
LastChangeOrderId	string	The release order ID.	afedb3c4-63f8-4a3d-aaa3-2c30363f****
BelongRegion	string	The region of the namespace.	cn-shanghai
NamespaceId	string	The namespace ID.	cn-shangha:test
SecurityGroupId	string	The security group ID.	sg-wz969ngg2e49q5i4****
UserId	string	The user ID.	test@aliyun.com
NamespaceName	string	The namespace name.	test
LastChangeOrderStatus	string	The status of the last release order. Valid values: READY: The release order is ready. RUNNING: The release order is running. SUCCESS: The release order was successful. FAIL: The release order failed. ABORT: The release order was aborted. WAIT_BATCH_CONFIRM: The release order is waiting for manual batch confirmation. AUTO_BATCH_WAIT: The release order is in an automatic batch-wait state. SYSTEM_FAIL: A system error occurred. WAIT_APPROVAL: The release order is pending approval. APPROVED: The release order is approved and pending execution.	SUCCESS
VpcName	string	The VPC name.	test
VSwitchId	string	The vSwitch ID.	vsw-2ze559r1z1bpwqxwp****
Description	string	The description of the namespace.	decs
LastChangeOrderRunning	boolean	Indicates whether a release order is running in the namespace. Valid values: true: A release order is running. false: No release order is running.	true
AppCount	integer	The number of applications.	1
VSwitchName	string	The vSwitch name.	test
NotificationExpired	boolean	Indicates whether the notification for the release order has expired. Valid values: true: The notification has expired. false: The notification has not expired.	true
TenantId	string	The tenant ID of the SAE namespace.	838cad95-973f-48fe-830b-2a8546d7****
JumpServerAppId	string	The ID of the jump server application.	5ec46468-6b26-4a3c-9f7c-bf88761a****
JumpServerIp	string	The IP address of the jump server.	120.78.XXX.XX
NameSpaceShortId	string	The short-format namespace ID.	test
ApmJavaAgentVersion	string	The version of the APM Java agent.
SlsConfigs	string	The configuration for collecting logs to Simple Log Service (SLS). To use SLS resources that are automatically created by SAE: `[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`. To use custom SLS resources: `[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`. The configuration includes the following parameters: projectName: The project name in SLS. logDir: The log path. logType: The log type. stdout indicates the standard output of the container. Only one stdout entry is allowed. If you omit this parameter, file logs are collected. logstoreName: The Logstore name in SLS. logtailName: The Logtail name in SLS. If you omit this parameter, SAE creates a Logtail. You do not need to set this parameter if the SLS log collection configuration is unchanged for subsequent deployments. To disable log collection, set this parameter to an empty string ("").
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section of this topic. A successful request does not return the ErrorCode field. A failed request returns the ErrorCode field. For more information, see the list of error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the namespace resources were queried successfully. true: The query was successful. false: The query failed.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "VpcId": "vpc-2ze0i263cnn311nvj****",
    "LastChangeOrderId": "afedb3c4-63f8-4a3d-aaa3-2c30363f****",
    "BelongRegion": "cn-shanghai",
    "NamespaceId": "cn-shangha:test",
    "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
    "UserId": "test@aliyun.com",
    "NamespaceName": "test",
    "LastChangeOrderStatus": "SUCCESS",
    "VpcName": "test",
    "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
    "Description": "decs",
    "LastChangeOrderRunning": true,
    "AppCount": 1,
    "VSwitchName": "test",
    "NotificationExpired": true,
    "TenantId": "838cad95-973f-48fe-830b-2a8546d7****",
    "JumpServerAppId": "5ec46468-6b26-4a3c-9f7c-bf88761a****",
    "JumpServerIp": "120.78.XXX.XX",
    "NameSpaceShortId": "test",
    "ApmJavaAgentVersion": "",
    "SlsConfigs": ""
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.