機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

アクセス・ガードレールのリストの取得

get

/access-governance/access-controls/20250331/accessGuardrails

ページ区切りをサポートしているすべての使用可能なアクセス・ガードレールの詳細を返します。

リクエスト

問合せパラメータ

• keywordContains: string
  フィルタするキーワード。 指定できるキーワードは1つのみです。 デフォルトは空の文字列です。
• limit: integer
  最小値: 1

  最大値: 1000

  返されるアイテムの最大数。

  デフォルト値: 10
• name: string
  最大長: 100

  結果をフィルタする名前
• ownerId: string
  フィルタ条件とする所有者ID
• page: string
  最小長: 1

  結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
• sortOrder: string
  使用するソート順(ASCまたはDESC)。

  許容値: [ "ASC", "DESC" ]

ヘッダー・パラメータ

• opc-request-id: string
  トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

アクセス・ガードレール・サマリーのリスト

ヘッダー

• opc-next-page: string
  アイテム・リストのページ区切り。 リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。 この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : AccessGuardrailCollection

型: object

AccessGuardrail検索の結果。 AccessGuardrailSummaryアイテムとその他のデータの両方が含まれます。

ソースを表示

• items(必須): array items
  アクセス・ガードレールのリスト。

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of access guardrail.",
            "items":{
                "$ref":"#/definitions/AccessGuardrailSummary"
            }
        }
    },
    "description":"Results of a AccessGuardrail search. Contains both AccessGuardrailSummary items and other data."
}

ネストされたスキーマ: items

型: array

アクセス・ガードレールのリスト。

ソースを表示

• Array of: object AccessGuardrailSummary
  AccessGuardrailのサマリー。

{
    "type":"array",
    "description":"List of access guardrail.",
    "items":{
        "$ref":"#/definitions/AccessGuardrailSummary"
    }
}

ネストされたスキーマ : AccessGuardrailSummary

型: object

AccessGuardrailのサマリー。

ソースを表示

• id(必須): string
  作成時に変更できない一意の識別子
• lifecycleState(required): string
  許容値: [ "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" ]

  AccessGuardrailの現在の状態。
• name: string
  アクセス・ガードレール識別子。名前を変更できます
• primaryOwnerDisplayName: string
  プライマリ所有者のDisplayName。
• tags: array tags
  AccessGuardrailのタグ。
• timeCreated: string(date-time)
  AccessGuardrailが作成された時間。 「An RFC3339」書式設定日時文字列
• timeUpdated: string(date-time)
  AccessGuardrailが更新された時間。 「An RFC3339」書式設定日時文字列

{
    "type":"object",
    "required":[
        "id",
        "lifecycleState"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Access Guardrail Identifier, can be renamed"
        },
        "lifecycleState":{
            "type":"string",
            "description":"The current state of the AccessGuardrail.",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "INACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccessGuardrailLifecycleState"
        },
        "tags":{
            "type":"array",
            "description":"Tags for the AccessGuardrail.",
            "items":{
                "type":"string"
            }
        },
        "primaryOwnerDisplayName":{
            "type":"string",
            "description":"DisplayName of the primary owner."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The time the the AccessGuardrail was created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The time the the AccessGuardrail was updated. An RFC3339 formatted datetime string"
        }
    },
    "description":"Summary of the AccessGuardrail."
}

ネストされたスキーマ: tags

型: array

AccessGuardrailのタグ。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Tags for the AccessGuardrail.",
    "items":{
        "type":"string"
    }
}

400レスポンス

不正なリクエスト

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401レスポンス

未認可

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404レスポンス

見つかりません

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429レスポンス

リクエストが多すぎます

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500レスポンス

内部サーバー・エラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

デフォルト・レスポンス

不明なエラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

トップに戻る

例

次の例は、GETリクエストを発行してアクセス・ガードレールのリストを取得する方法を示しています

cURL例 - 問合せパラメータなし

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<host>/access-governance/access-controls/20250331/accessGuardrails'

cURL例 - 問合せパラメータあり

アクセス・ガードレールのリストを制限するcURLコマンド。

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<host>/access-governance/access-controls/20250331/accessGuardrails?limit=1'

レスポンス本文の例

次の例は、使用可能なすべてのアクセス・ガードレールのリストを含む、JSON形式のレスポンス本文の内容を示しています:

{
"items":[
{
"id": "01ffca11-xxxx-4d8f-bd89-b043e018axx",
"name": "AD Access Guardrails API Sample",
"lifecycleState": "ACTIVE",
"tags":[
],
"primaryOwnerDisplayName": "Amel Maclead",
"timeCreated": "2025-03-25T06:31:58.548Z",
"timeUpdated": "2025-03-25T06:31:58.548Z"
}
]
}

先頭に戻る