ListParameters - CloudOps Orchestration Service - Alibaba Cloud ドキュメントセンター

パラメーターおよび共通パラメーターを照会します。複数のクエリ方法に対応しています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:ListParameters

list

*パラメーター。

acs:oos:{#regionId}:{#accountId}:parameter/*

oos:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
Name	string	任意	パラメーター名。この操作の Name パラメーターはあいまい一致に対応しています。	MyParameter
MaxResults	integer	任意	1 ページあたりのエントリ数。有効な値: 10～100。デフォルト値: 50。	50
NextToken	string	任意	ページネーショントークン。	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
SortField	string	任意	クエリ結果のソートに使用されるフィールド。有効な値: Name: パラメーター名。 CreatedDate: 作成時間。	Name
SortOrder	string	任意	ソート順序。有効な値: Ascending: 昇順。 Descending (デフォルト): 降順。	Descending
Type	string	任意	パラメータータイプ。有効な値: String StringList	String
Path	string	任意	パラメーターパス。たとえば、Name が /path/path1/Myparameter の場合、値にはパラメーターパスが含まれます。	/パス1/パス2/
Recursive	boolean	任意	パラメーターパスを再帰的にクエリするかどうかを指定します。デフォルト値: false。	false
Tags	object	任意	タグ。	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmxsn4m4******
ShareType	string	任意	パラメーターが共通パラメーターであるかどうかを指定します。有効な値: Public Private デフォルト値: Private。	‘Private’

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	ページネーショントークン。	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb
RequestId	string	リクエスト ID。	A81E4B2E-6B33-4BAE-9856-55DB7C893E01
TotalCount	integer	返されるエントリの総数。	5
MaxResults	integer	1 ページあたりのエントリ数。	50
Parameters	array<object>	パラメーター情報。
	array<object>
Type	string	パラメータータイプ。	String
UpdatedDate	string	パラメーターが更新された時間 (ISO 8601 フォーマット (協定世界時 (UTC)))。	2020-09-01T08:01:43Z
UpdatedBy	string	パラメーターを更新したユーザー。	root(130900000)
Tags	object	タグ。	{"k1": "v1", "k2": "v2"}
Description	string	パラメーターの説明。	パラメーター
CreatedBy	string	パラメーターを作成したユーザー。	root(130900000)
ResourceGroupId	string	リソースグループ。	rg-acfmxsn4m4******
CreatedDate	string	パラメーターが作成された時間 (ISO 8601 フォーマット (協定世界時 (UTC)))。	2020-09-01T08:01:43Z
ParameterVersion	string	パラメーターのバージョン番号。	1
Name	string	パラメーター名。	MyParameter
Id	string	パラメーター ID。	p-4c4b401cab6747xxxxxx
ShareType	string	パラメーターの共有タイプ。	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": "パラメーター",
      "CreatedBy": "root(130900000)",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedDate": "2020-09-01T08:01:43Z",
      "ParameterVersion": "1",
      "Name": "MyParameter",
      "Id": "p-4c4b401cab6747xxxxxx",
      "ShareType": "Private"
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。