GetParameter API によるパラメータのクエリ - OOS - Alibaba Cloud - CloudOps Orchestration Service

共通パラメーターまたはパブリックパラメーターを、パラメーター値を含めて取得します。

今すぐお試しください

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

get

*パラメーター。

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

oos:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
Name	string	必須	パラメーター名。名前には英字、数字、ハイフン、アンダースコアを使用でき、長さは 200 文字以内です。	MyParameter
ParameterVersion	integer	任意	パラメーターのバージョン番号。有効な値: 1～100。	1
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmxsn4m*****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	BA326372-2A10-4C3B-BE3E-6439DB7557CC
Parameter	object	パラメーター情報。
Type	string	パラメータータイプ。	String
UpdatedDate	string	パラメーターが最後に更新された時間 (ISO 8601 フォーマット、協定世界時 (UTC))。	2020-09-01T08:01:43Z
UpdatedBy	string	パラメーターを最後に更新したユーザー。	root(130900000)
Tags	object	タグ。	{"k1":"v1","k2":"v2"}
Value	string	パラメーターの値。	パラメーター
Description	string	パラメーターの説明。	パラメーター
Constraints	string	パラメーターの制約。	'{''AllowedValues":["パラメーター"],"AllowedPattern":"パラメーター","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	リソースグループの ID。	rg-acfmxsn4m*****
CreatedBy	string	パラメーターを作成したユーザー。	root(130900000)
CreatedDate	string	パラメーターが作成された時間 (ISO 8601 フォーマット、協定世界時 (UTC))。	2020-09-01T08:01:43Z
ParameterVersion	integer	パラメーターのバージョン番号。	1
Name	string	パラメーター名。	MyParameter
Id	string	パラメーターの ID。	p-4c4b401cab6747xxxxxx
ShareType	string	パラメーターの共有タイプ。	Private

例

成功レスポンス

JSONJSON

{
  "RequestId": "BA326372-2A10-4C3B-BE3E-6439DB7557CC",
  "Parameter": {
    "Type": "String",
    "UpdatedDate": "2020-09-01T08:01:43Z",
    "UpdatedBy": "root(130900000)",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Value": "パラメーター",
    "Description": "パラメーター",
    "Constraints": "'{''AllowedValues\":[\"パラメーター\"],\"AllowedPattern\":\"パラメーター\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m*****",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T08:01:43Z",
    "ParameterVersion": 1,
    "Name": "MyParameter",
    "Id": "p-4c4b401cab6747xxxxxx",
    "ShareType": "Private"
  }
}

エラーコード

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

変更履歴

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