Kaynakları sorgular.
Operation description
Kaynak belgelerini görüntülemek ve Cloud Control API'yi test etmek için OpenAPI Explorer sayfasına gidebilirsiniz.
Bu API, farklı istek URI'leri kullanarak çağırabileceğiniz kaynaklar için Get ve List işlemleri sağlar.
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/providers/{provider}/products/{product}/resources/* HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| requestPath |
string |
No |
İstek URL'si. İstek URL'si, List veya Get işleminin çağrılıp çağrılmayacağını belirler.
İstek URL'si aşağıdaki değişkenleri içerir:
|
List(无父资源): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance List(有父资源): /api/v1/providers/aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account Get(无父资源): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo**** Get(有父资源): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user**** |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| regionId |
string |
No |
Bölge kimliği. Bulut ürünü bölgeye özgüyse bu parametre gereklidir. |
cn-beijing |
| filter |
object |
No |
Kaynaklar için filtre koşulları. Kaynakları filtrelemek için JSON biçiminde birden fazla anahtar-değer çifti belirtin. Bir bulut ürününe yönelik List veya Get işlemi belirli özelliklere göre filtrelemeyi destekliyorsa, bu özellikleri bu parametre için filtre koşulları olarak kullanabilirsiniz. Not
Desteklenen filtre alanları farklı kaynak türleri için değişiklik gösterebilir. Desteklenen alanlar hakkında daha fazla bilgi için ilgili kaynağın OpenAPI belgelerine bakın. Örneğin, DBInstance kaynakları |
{ "EditionType": "Community", "PaymentType": "PostPaid" } |
| nextToken |
string |
No |
Sayfalama belirteci.
Not
Bu parametre yalnızca rakam içeriyorsa, Cloud Control API bunu sayfalama için |
AAAAAdDWBF2**** |
| maxResults |
integer |
No |
Sayfalanmış bir sorgu için her sayfada döndürülecek maksimum kayıt sayısı. Maksimum değer: 100. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Yanıt yapısı. |
||
| maxResults |
integer |
Mevcut istek için döndürülen maksimum kayıt sayısı. Bu parametre List işlemi tarafından döndürülür. |
10 |
| nextToken |
string |
Mevcut çağrının okumayı bitirdiği konum. Boş bir değer, tüm verilerin okunduğunu gösterir. Bu parametre List işlemi tarafından döndürülür. |
AAAAAdDWBF2**** |
| requestId |
string |
İstek kimliği. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| resource |
object |
Belirtilen kaynak. Bu parametre Get işlemi tarafından döndürülür. |
|
| resourceAttributes |
object |
JSON biçimindeki kaynak özellikleri. |
{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"} |
| resourceId |
string |
Kaynak kimliği. |
cctest |
| resources |
array<object> |
Kaynak listesi. Bu parametre List işlemi tarafından döndürülür. |
|
|
array<object> |
Bir kaynak. |
||
| resourceAttributes |
object |
JSON biçimindeki kaynak özellikleri. |
{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"} |
| resourceId |
string |
Kaynak kimliği. |
cctest |
| totalCount |
integer |
Sorgu koşullarıyla eşleşen toplam giriş sayısı. Bu parametre List işlemi tarafından döndürülür. |
20 |
Examples
Success response
JSON format
{
"maxResults": 10,
"nextToken": "AAAAAdDWBF2****",
"requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"resource": {
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-2ze8v41uei31lo****",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
},
"resources": [
{
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-2ze8v41uei31lo****",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
}
],
"totalCount": 20
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.