API DescribeSecurityIPGroup & Template Whitelist Lintas Produk - DAS - Alibaba Cloud - Database Autonomy Service

Melihat detail templat daftar putih lintas-produk.

Deskripsi operasi

Note the following before you call this operation:

Use the latest version of the Alibaba Cloud software development kit (SDK) or DAS SDK.
When you use an SDK to call the DAS Service, set the region to cn-shanghai.

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

hdm:DescribeSecurityIPGroup

get

*全部资源

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionName	string	Yes	ID Wilayah.	cn-shanghai

Elemen respons

Element	Type	Description	Example
	object	The response schema.
Code	string	The status code returned.	200
Data	object	ListResult
SecurityIpGroups	array<object>	A list of all cross-product whitelist templates in the specified region.
	array<object>
DbInstances	array	The database instances that are attached to the whitelist template.
	string	The database instance ID.	["r-2ze9g6mnhu1*", "pc-2zew5qn1m", "r-2ze9g6mn*", "pc-2zew5qh41***"]
SecurityIpType	string	The IP address type.	ipv4
Uid	string	The account ID. You can obtain the ID of your logon account on the Security Settings page of Account Management.	160-79abe3f4****
RegionId	string	The region ID.	cn-hangzhou
GEcsSgIdList	string	The ID of the ECS security group. This parameter is deprecated and is retained for compatibility. It will be removed in a future version.	null
GlobalIgName	string	The name of the IP address whitelist template. The name must meet the following requirements: It must consist of lowercase letters, digits, and underscores (_). It must start with a letter and end with a letter or a digit. It must be 2 to 120 characters in length.	test_123
GlobalSecurityGroupId	string	The ID of the IP address whitelist template.	g-1no2rzybnqcv****
WhitelistNetType	string	The network type of the whitelist.	mix
EngineInfoList	array<object>	The information about the instances of each product that are attached to the template.
	object
InstanceNum	integer	The number of instances that belong to the current logon account.	10
EngineName	string	The database type of the destination instance.	PolarDBMySQL
InstanceIds	array	A list of database instance IDs.
	string	The database instance ID. Catatan The value is a JSON array, such as `['Instance ID1','Instance ID2']`. Separate multiple instance IDs with commas (,).	rm-2ze8ygcc****
UserId	string	The user ID.	641***
GIpList	string	The IP addresses in the whitelist template. Catatan Separate multiple IP addresses with commas (,).	192.168.1.28/32
Message	string	The message returned for the request. Catatan If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.	Successful
RequestId	string	The request ID.	CAC553F1-C669-53F1-A295-2CF050E****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Data": {
    "SecurityIpGroups": [
      {
        "DbInstances": [
          "[\"r-2ze9g6mnhu1***\",\n\"pc-2zew5qn1m***\",\n\"r-2ze9g6mn****\",\n\"pc-2zew5qh41*****\"]"
        ],
        "SecurityIpType": "ipv4",
        "Uid": "160-79abe3f4****",
        "RegionId": "cn-hangzhou",
        "GEcsSgIdList": " null",
        "GlobalIgName": "test_123",
        "GlobalSecurityGroupId": "g-1no2rzybnqcv****",
        "WhitelistNetType": "mix",
        "EngineInfoList": [
          {
            "InstanceNum": 10,
            "EngineName": "PolarDBMySQL",
            "InstanceIds": [
              "rm-2ze8ygcc****"
            ]
          }
        ],
        "UserId": "641***",
        "GIpList": "192.168.1.28/32"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "CAC553F1-C669-53F1-A295-2CF050E****",
  "Success": "true"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.