Cisco UCS Director REST 開発者ガイド、リリース 5.2
API 要求パラメータ
API 要求パラメータ

API 要求パラメータ

この章は、次の内容で構成されています。

API 要求コンテキスト パラメータ

パラメータを必要とする Cisco UCS Director REST API の操作は通常パラメータとしてコンテキストを必要とします。 いくつかの例外があり、特にログイン情報からコンテキストを選択する操作がそれに該当します。

API 要求を作成する場合、使用する正確なコンテキスト パラメータを見つける方法には次の 2 つがあります。

  • 標準 Cisco UCS Director コンテキストのリストで正確なコンテキスト名の文字列を見つけ、API 要求の JSON パラメータの指定にそれをコピーします。

  • Cisco UCS Director で API を通じて要求する同じレポート データを表すレポートに移動します。 レポート メタデータで REST API URL を見つけ、そこに記載されたコンテキスト パラメータを使用します。


ワンポイント アドバイス


Cisco UCS Director で要求を送信するために使用される URL コードを見つけた場合、その API 要求データの一部または全部を使用して自分の要求を作成することができます。



(注)  


場合によっては、REST API URL のレポート メタデータ リストで提供される数字文字列ではなく、英語(人が判読可能な)名前の文字列を使用することもできます。


コンテキスト フィールド名および対応するパラメータ名

以下のリストで、最初の要素はフィールド名です。2 つ目の引用符に囲まれたものがコンテキストを表すパラメータに割り当てるコンテキスト値です。 ほとんどのレポートの要求では、param0 がコンテキストを提供します。 別のコンテキスト パラメータ(param1)値が必要な場合、REST API URL のレポート メタデータ リストでこのパラメータに対して提供された値を使用することができます。

管理のコンテキスト

  • CONTEXT_TYPE_GLOBAL= "global";

  • CONTEXT_TYPE_GLOBAL_ADMIN = "global_admin";

  • CONTEXT_TYPE_GLOBAL_SERVICES = "global-services";

  • CONTEXT_TYPE_CLOUD = "cloud";

  • CONTEXT_TYPE_HOSTNODE = "hostnode";

  • CONTEXT_TYPE_CLUSTER = "cluster";

エンド ユーザのコンテキスト

  • CONTEXT_TYPE_GROUP = "group";

  • CONTEXT_TYPE_VM = "vm";

  • CONTEXT_TYPE_VDC = "vdc";

  • CONTEXT_TYPE_SR = "servicerequest";

データセンターのコンテキスト

  • CONTEXT_TYPE_PHYSICAL_DATACENTER = "datacenter";

NetApp レポートのコンテキスト

  • CONTEXT_TYPE_STORAGE_ACCOUNTS= " storage_accounts";

  • CONTEXT_TYPE_STORAGE_FILERS = " netapp_filer";

  • CONTEXT_TYPE_STORAGE_AGGREGATES = " storage_aggregates";

  • CONTEXT_TYPE_STORAGE_VOLUMES = "storage_volumes";

  • CONTEXT_TYPE_STORAGE_LUNS = "luns";

  • CONTEXT_TYPE_STORAGE_VFLIERS = "netapp_v_flier";

UCS レポートのコンテキスト

  • CONTEXT_TYPE_INFRA_COMPUTE_UCSM_ACCOUNT= " ucsm";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_FABRIC_INTERCONNECT = " compute_fbi";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_CHASSIS = " compute_chassis";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_SERVER = "compute_server";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_SERVICE_PROFILE = "service_profile";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_PORT_CHANNEL = "ucs_portchannel";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_ORGANIZATION = "ucs_org";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_SERVICE_PROFILE_TEMPLATE = "ucs_service-profile-template";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_BOOT_POLICY = "ucs_boot_policy";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_VNIC_TEMPLATE = "ucs_vnictemplate";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_MAC_POOL = "ucs_mac";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_UUID_POOL = "ucs_uuid";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_WWNN_POOL = "ucs_wwnn";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_WWPN_POOL = "ucs_wwpn";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_SERVICE_PROFILE_VHBA = "ucs_sp_vhba";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_SERVICE_PROFILE_VNIC = "ucs_sp_vnic";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_IOMODULE = "ucs_iomodule";

  • CONTEXT_TYPE_INFRA_COMPUTE_UCS_SERVER_ADAPTER_UNIT = "compute_server_adapter_unit";

ネットワーク レポートのコンテキスト

  • CONTEXT_TYPE_INFRA_NETWORK_DEVICE= "network_device";

  • CONTEXT_TYPE_INFRA_NET_DEVICE_N1K = " net_device_n1k";

  • CONTEXT_TYPE_INFRA_NET_DEVICE_FAB_IC = " net_device_fab_ic";

  • CONTEXT_TYPE_INFRA_NET_DEVICE_N5K = "net_device_n5k";

  • CONTEXT_TYPE_INFRA_NETWORK_DEVICE_VLAN = "net_device_vlan";

  • CONTEXT_TYPE_INFRA_NETWORK_DEVICE_VSAN = "net_device_vsan";

  • CONTEXT_TYPE_INFRA_NETWORK_DEVICE_INTERFACE = "net_device_interface";

  • CONTEXT_TYPE_INFRA_NETWORK_DEVICE_PORT_PROFILE = "net_device_port_profile";

  • CONTEXT_TYPE_INFRA_NETWORK_DEVICE_ZONE = "net_device_zone";

  • CONTEXT_TYPE_INFRA_NET_QOS_POLICY = "net_device_qos_policy";

レポートまたは JSON オブジェクト用の API 要求パラメータ

特定のデータ フィールドの要求に加え、Cisco UCS Director の操作には応答の形式がレポートの一種(reportId によって識別される)または JSON オブジェクト(名前によって識別される)でなければならないと指定する要求パラメータを含めることができます。

API 要求で特定のレポートまたは指定のレポート形式、あるいは JSON オブジェクトを取得する必要がある場合、その条件が要求で使用する API の操作とパラメータの指定に役立つことがあります。

JSON オブジェクトを API 操作への入力または操作からの出力のいずれかとして処理する必要がある場合には、JSON オブジェクト パラメータ タイプを参照してください。