すべてのプロダクト
Search
ドキュメントセンター

CloudOps Orchestration Service:ListParameters

最終更新日:Jun 10, 2026

共通パラメーターを照会します。共通パラメーターをフィルターするための複数の方法がサポートされています。

今すぐお試しください

この 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

*Parameter

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

  • oos:TLSVersion
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

リージョン ID。

cn-hangzhou

Name

string

任意

共通パラメーターの名前。

MyParameter

MaxResults

integer

任意

ページあたりのエントリ数。有効な値: 10~100。デフォルト値: 50。

50

NextToken

string

任意

次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA

SortField

string

任意

クエリ結果のソートに使用されるフィールド。有効な値:

  • Name

  • CreatedDate。

Name

SortOrder

string

任意

エントリのソート注文。有効な値:

  • Ascending

  • Descending (デフォルト)。

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

任意

共通パラメーターの共有タイプ。有効な値:

  • Public

  • Private

デフォルト値: 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"
    }
  ]
}

エラーコード

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

変更履歴

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