移動

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

使用可能なすべてのメトリック単位の詳細の取得

get

/monitoring/monitoring/{idDomainName}/.customer/api/v1/metricUnits

リクエスト

パス・パラメータ

• idDomainName: string
  Oracle Monitoring Cloud Serviceアカウントのアイデンティティ・ドメインID。

問合せパラメータ

• limit(optional): integer(int32)
  リクエストから返されるアイテムの最大数。
• offset(optional): integer(int32)
  返される最初の要素のオフセット(ページネーション目的)。
• orderBy(optional): string
  サポートされる値はdisplayNameです。

ヘッダー・パラメータ

• Authorization: string
  基本認証の資格証明。 ユーザーは、ヘッダーX-ID-TENANT-NAMEで指定されたアイデンティティ・ドメイン名に存在する必要があります。
• X-ID-TENANT-NAME: string
  認証ヘッダーで指定されたユーザーが存在するアイデンティティ・ドメインIDに設定します。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文 ()

ルート・スキーマ: MetricUnits

型: object

ソースの表示

• canonicalLink(optional): string(uri)
  リソースへの相対パス。
• hasMore(optional): boolean
  デフォルト値: false

  追加で返されるアイテムが存在する場合はtrue。
• items(optional): array items
• limit(optional): integer(int32)
  リクエストから返されるアイテムの最大数。
• nextLink(optional): string(uri)
  次のページへの相対パス。
• offset(optional): integer(int32)
  返される最初の要素のオフセット(ページネーション目的)。

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "description":"\tRelative path to the resource."
        },
        "nextLink":{
            "type":"string",
            "format":"uri",
            "description":"Relative path to the next page."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"Offset of the first element to return (for pagination purpose)."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum number of items that the request should return."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Is true if there are more items to return.",
            "default":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MetricUnit"
            }
        }
    }
}

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

型: array

ソースの表示

• Array of: object MetricUnit

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MetricUnit"
    }
}

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

型: object

ソースの表示

• canonicalLink(optional): string(uri)
  リソースへの相対パス。
• displayName(optional): string
  メトリック単位の表示名。
• id(optional): string
  メトリック単位の一意のID。 たとえば、BYTESのようになります。
• shortDisplayName(optional): string
  メトリック単位の短い表示名。

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "description":"Relative path to the resource."
        },
        "id":{
            "type":"string",
            "description":"Unique ID of the metric unit. For example, BYTES."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the metric unit."
        },
        "shortDisplayName":{
            "type":"string",
            "description":"Short display name for the metric unit."
        }
    }
}

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、使用可能なすべてのメトリック単位の詳細を取得する方法を示しています。 cURLの使用を参照してください。

curl -X GET -H "Authorization: Basic d2VibG9naWM6V2VsY29tZTE=" -H "X-ID-TENANT-NAME:mydomain" https://monitoring.us.oraclecloud.com/monitoring/mydomain/.customer/api/v1/metricUnits

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK
Date: Tue, 08 Mar 2016 12:20:49 GMT
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "items": [
    {
      "id": "BYTES",
      "displayName": "bytes",
      "shortDisplayName": "B",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/BYTES"
    },
    {
      "id": "BYTES_PER_SEC",
      "displayName": "bytes per Second",
      "shortDisplayName": "B/s",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/BYTES_PER_SEC"
    },
    {
      "id": "COUNT",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/COUNT"
    },
    {
      "id": "COUNT_PER_SEC",
      "displayName": "per second",
      "shortDisplayName": "/s",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/COUNT_PER_SEC"
    },
    {
      "id": "KILOBYTES",
      "displayName": "kilobytes",
      "shortDisplayName": "kb",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/KILOBYTES"
    },
    {
      "id": "KILOBYTES_PER_SEC",
      "displayName": "kilobytes per Second",
      "shortDisplayName": "kb/s",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/KILOBYTES_PER_SEC"
    },
    {
      "id": "PERCENT",
      "displayName": "percent",
      "shortDisplayName": "%",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/PERCENT"
    },
    {
      "id": "SECTORS",
      "displayName": "Virtual block device sectors",
      "shortDisplayName": "sectors",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/SECTORS"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "hasMore": false,
  "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits"
}

トップに戻る