Referensi API DescribeConfigMap & Parameter - SAE - Alibaba Cloud - Serverless App Engine

Mengkueri detail instans ConfigMap.

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:DescribeConfigMap

get

*全部资源

*

None

Sintaks permintaan

GET /pop/v1/sam/configmap/configMap HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
ConfigMapId	integer	Yes	ID ConfigMap. Anda dapat memanggil operasi ListNamespacedConfigMaps untuk mendapatkan ID.	1

Elemen respons

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. The value is success if the request succeeds. The value is an error code if the request fails.	success
TraceId	string	The trace ID. You can use it to locate the call details.	0a98a02315955564772843261e****
Data	object	The returned data.
UpdateTime	integer	The time when the instance was last updated.	1593747274195
Data	object	The key-value pairs of the ConfigMap. The data is in the following format: {"k1":"v1", "k2":"v2"} For more information about configuration items, see Manage and use configuration items.	{"k1":"v1","k2":"v2"}
NamespaceId	string	The namespace ID.	cn-hangzhou
Description	string	The description of the ConfigMap instance.	test-desc
CreateTime	integer	The time when the instance was created.	1593746835111
RelateApps	array<object>	The associated applications.
	object	The application details.
AppName	string	The name of the application.	test-app
AppId	string	The ID of the application.	f16b4000-9058-4c22-a49d-49a28f0b****
ConfigMapId	integer	The ID of the ConfigMap instance.	1
Name	string	The name of the ConfigMap instance.	test-configmap
ErrorCode	string	The error code returned if the request fails. This parameter is empty if the request succeeds. This parameter contains an error code if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. Valid values: 2xx: success 3xx: redirection 4xx: client error 5xx: server error	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "UpdateTime": 1593747274195,
    "Data": {
      "k1": "v1",
      "k2": "v2"
    },
    "NamespaceId": "cn-hangzhou",
    "Description": "test-desc",
    "CreateTime": 1593746835111,
    "RelateApps": [
      {
        "AppName": "test-app",
        "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****"
      }
    ],
    "ConfigMapId": 1,
    "Name": "test-configmap"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	NotFound.ConfigMap	The ConfigMap object (ID: %s) does not exist.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.