共通パラメーターを照会します。共通パラメーターをフィルターするための複数の方法がサポートされています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
oos:ListParameters |
list |
*Parameter
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-hangzhou |
| Name |
string |
任意 |
共通パラメーターの名前。 |
MyParameter |
| MaxResults |
integer |
任意 |
ページあたりのエントリ数。有効な値: 10~100。デフォルト値: 50。 |
50 |
| NextToken |
string |
任意 |
次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。 |
MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA |
| SortField |
string |
任意 |
クエリ結果のソートに使用されるフィールド。有効な値:
|
Name |
| SortOrder |
string |
任意 |
エントリのソート注文。有効な値:
|
Descending |
| Type |
string |
任意 |
共通パラメーターのデータの型。 |
String |
| Path |
string |
任意 |
パラメーターのパス。たとえば、パラメーターの名前が /path/path1/Myparameter の場合、パラメーターのパスは /path/path1/ です。 |
/path1/path2/ |
| Recursive |
boolean |
任意 |
指定されたパスのすべてのレベルのディレクトリからパラメーターをクエリするかどうかを指定します。デフォルト値: false。 |
false |
| Tags |
object |
任意 |
タグ。 |
{"k1": "v1", "k2": "v2"} |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 |
rg-acfmxsn4m4****** |
| ShareType |
string |
任意 |
共通パラメーターの共有タイプ。有効な値:
デフォルト値: Private。 |
‘Private’ |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| NextToken |
string |
A pagination token. It can be used in the next request to retrieve a new page of results. |
gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb |
| RequestId |
string |
The ID of the request. |
A81E4B2E-6B33-4BAE-9856-55DB7C893E01 |
| TotalCount |
integer |
The total number of entries returned. |
5 |
| MaxResults |
integer |
The number of entries per page. Valid values: 10 to 100. Default value: 50. |
50 |
| Parameters |
array<object> |
The information about the common parameter. |
|
|
array<object> |
|||
| Type |
string |
The data type of the common parameter. |
String |
| UpdatedDate |
string |
The time when the common parameter was updated. |
2020-09-01T08:01:43Z |
| UpdatedBy |
string |
The user who updated the common parameter. |
root(130900000) |
| Tags |
object |
The tags added to the common parameter. |
{"k1": "v1", "k2": "v2"} |
| Description |
string |
The description of the common parameter. |
parameter |
| CreatedBy |
string |
The user who created the common parameter. |
root(130900000) |
| ResourceGroupId |
string |
The resource group ID. |
rg-acfmxsn4m4****** |
| CreatedDate |
string |
The time when the common parameter was created. |
2020-09-01T08:01:43Z |
| ParameterVersion |
string |
The version number of the common parameter. |
1 |
| Name |
string |
The name of the common parameter. |
MyParameter |
| Id |
string |
The common parameter ID. |
p-4c4b401cab6747xxxxxx |
| ShareType |
string |
The share type of the common parameter. |
Private |
例
成功レスポンス
JSONJSON
{
"NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb",
"RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
"TotalCount": 5,
"MaxResults": 50,
"Parameters": [
{
"Type": "String",
"UpdatedDate": "2020-09-01T08:01:43Z",
"UpdatedBy": "root(130900000)",
"Tags": {
"k1": "v1",
"k2": "v2"
},
"Description": "parameter",
"CreatedBy": "root(130900000)",
"ResourceGroupId": "rg-acfmxsn4m4******",
"CreatedDate": "2020-09-01T08:01:43Z",
"ParameterVersion": "1",
"Name": "MyParameter",
"Id": "p-4c4b401cab6747xxxxxx",
"ShareType": "Private"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。