Jump to

• Request
• Response
• Examples

View Resources of a Service

get

/metering/api/v1/resources/{serviceName}

Retrieve resources of a given service.

Request

Path Parameters

• serviceName: string
  Service name

Query Parameters

• applicableComponent: string
  Whether OPC public cloud or OCM private cloud
• entitlementId: string
  Service Entitlement Id

Back to Top

Response

Supported Media Types

• application/vnd.com.oracle.oraclecloud.metering.resources+json

200 Response

Success

Body ()

Root Schema : Resources

Type: object

Title: Resources

Show Source

• canonicalLink(optional): string
• items(optional): array items

{
    "type":"object",
    "title":"Resources",
    "properties":{
        "items":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_Resource"
                }
            }
        },
        "canonicalLink":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object Resource
  Title: Resource

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

Nested Schema : Resource

Type: object

Title: Resource

Show Source

• aggregationMultiplier(optional): string
• applicableComponent(optional): string
• canonicalLink(optional): string
• cloudCreditBillingConfig(optional): array cloudCreditBillingConfig
• conversionFactor(optional): number
• dailyUnitDisplayName(optional): string
• description(optional): string
• displayName(optional): string
• gsiProductId(optional): string
• gsiUsageUnit(optional): string
• hourlyUnitDisplayName(optional): string
• instanceType(optional): string
• name(optional): string
• rawUnitDisplayName(optional): string
• resourceHardLimit(optional): array resourceHardLimit
• resourceLimit(optional): array resourceLimit
• servicename(optional): string
• skuproductIds(optional): array skuproductIds
• usageDataType(optional): string

{
    "type":"object",
    "title":"Resource",
    "properties":{
        "dailyUnitDisplayName":{
            "description":"",
            "type":"string"
        },
        "hourlyUnitDisplayName":{
            "description":"",
            "type":"string"
        },
        "rawUnitDisplayName":{
            "description":"",
            "type":"string"
        },
        "usageDataType":{
            "description":"",
            "type":"string"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "servicename":{
            "description":"",
            "type":"string"
        },
        "canonicalLink":{
            "description":"",
            "type":"string"
        },
        "gsiProductId":{
            "description":"",
            "type":"string"
        },
        "aggregationMultiplier":{
            "description":"",
            "type":"string"
        },
        "gsiUsageUnit":{
            "description":"",
            "type":"string"
        },
        "resourceLimit":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_ResourceLimit"
                }
            }
        },
        "resourceHardLimit":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_ResourceHardLimit"
                }
            }
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "displayName":{
            "description":"",
            "type":"string"
        },
        "conversionFactor":{
            "description":"",
            "type":"number"
        },
        "instanceType":{
            "description":"",
            "type":"string"
        },
        "applicableComponent":{
            "description":"",
            "type":"string"
        },
        "cloudCreditBillingConfig":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_CloudCreditBillingConfig"
                }
            }
        },
        "skuproductIds":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_SkuProductIds"
                }
            }
        }
    },
    "description":""
}

Nested Schema : cloudCreditBillingConfig

Type: array

Show Source

• Array of: array items

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

Nested Schema : resourceHardLimit

Type: array

Show Source

• Array of: array items

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

Nested Schema : resourceLimit

Type: array

Show Source

• Array of: array items

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

Nested Schema : skuproductIds

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object CloudCreditBillingConfig
  Title: CloudCreditBillingConfig

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

Nested Schema : CloudCreditBillingConfig

Type: object

Title: CloudCreditBillingConfig

Show Source

• billingType(optional): string
• gsiPartNumber(optional): string

{
    "type":"object",
    "title":"CloudCreditBillingConfig",
    "properties":{
        "billingType":{
            "description":"",
            "type":"string"
        },
        "gsiPartNumber":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: object ResourceHardLimit
  Title: ResourceHardLimit

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

Nested Schema : ResourceHardLimit

Type: object

Title: ResourceHardLimit

Show Source

• limit(optional): string
• limitMultiplier(optional): number
• limitProperty(optional): string
• limitType(optional): string
• resourceBnumber(optional): string
• resourceName(optional): string
• serviceName(optional): string

{
    "type":"object",
    "title":"ResourceHardLimit",
    "properties":{
        "limitType":{
            "description":"",
            "type":"string"
        },
        "limit":{
            "description":"",
            "type":"string"
        },
        "resourceName":{
            "description":"",
            "type":"string"
        },
        "serviceName":{
            "description":"",
            "type":"string"
        },
        "limitMultiplier":{
            "description":"",
            "type":"number"
        },
        "limitProperty":{
            "description":"",
            "type":"string"
        },
        "resourceBnumber":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: object ResourceLimit
  Title: ResourceLimit

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

Nested Schema : ResourceLimit

Type: object

Title: ResourceLimit

Show Source

• dependentForLimits(optional): array dependentForLimits
• dependentOnLimits(optional): array dependentOnLimits
• direct(optional): string
• limit(optional): number
• limitType(optional): string
• resourceName(optional): string
• serviceName(optional): string

{
    "type":"object",
    "title":"ResourceLimit",
    "properties":{
        "limit":{
            "description":"",
            "type":"number"
        },
        "limitType":{
            "description":"",
            "type":"string"
        },
        "direct":{
            "description":"",
            "type":"string"
        },
        "resourceName":{
            "description":"",
            "type":"string"
        },
        "serviceName":{
            "description":"",
            "type":"string"
        },
        "dependentForLimits":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_ServiceResourceMap"
                }
            }
        },
        "dependentOnLimits":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_ServiceResourceMap"
                }
            }
        }
    },
    "description":""
}

Nested Schema : dependentForLimits

Type: array

Show Source

• Array of: array items

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

Nested Schema : dependentOnLimits

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object ServiceResourceMap
  Title: ServiceResourceMap

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

Nested Schema : ServiceResourceMap

Type: object

Title: ServiceResourceMap

Show Source

• canonicalLink(optional): string
• limit(optional): number
  Quantity set as limit.
• limitType(optional): string
  Soft or Hard limit.
• resourceName(optional): string
  Resource Name.
• serviceName(optional): string
  Service Name.

{
    "type":"object",
    "title":"ServiceResourceMap",
    "properties":{
        "resourceName":{
            "description":"Resource Name.",
            "type":"string"
        },
        "serviceName":{
            "description":"Service Name.",
            "type":"string"
        },
        "limit":{
            "description":"Quantity set as limit.",
            "type":"number"
        },
        "limitType":{
            "description":"Soft or Hard limit.",
            "type":"string"
        },
        "canonicalLink":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: object ServiceResourceMap
  Title: ServiceResourceMap

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

Nested Schema : items

Type: array

Show Source

• Array of: object SkuProductIds
  Title: SkuProductIds

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

Nested Schema : SkuProductIds

Type: object

Title: SkuProductIds

Show Source

• skuId(optional): string
  Sku Id.
• skuType(optional): string
  Metered or Commitment sku

{
    "type":"object",
    "title":"SkuProductIds",
    "properties":{
        "skuId":{
            "description":"Sku Id.",
            "type":"string"
        },
        "skuType":{
            "description":"Metered or Commitment sku",
            "type":"string"
        }
    },
    "description":""
}

Default Response

Unexpected error.

Back to Top

Examples

cURL Command

The following example shows how to retrieve information about all resources for an Oracle Cloud Service account using the Metering API by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -u [e-mail] 
     -H "X-ID-TENANT-NAME:myDomain" 
     "https://itra.oraclecloud.com/metering/api/v1/resources/Compute"

Example of Request Body

There is no request body to submit with the HTTP request.

Example of Response Body

The following example shows the response body in JSON format.

{ 
	"items":[ 
		{ 
		"dailyUnitDisplayName":"OCPU Hours",
		"hourlyUnitDisplayName":"OCPU Hours",
		"rawUnitDisplayName":"number",
		"name":"OCPU_GP",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/OCPU_GP",
		"description":"Oracle Compute Cloud Service - General Purpose - OCPU Per Hour"
		},
		{ 
		"dailyUnitDisplayName":"OCPU Hours (High Mem)",
		"hourlyUnitDisplayName":"OCPU Hours (High Mem)",
		"rawUnitDisplayName":"number",
		"name":"OCPU_HP",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/OCPU_HP",
		"description":"Oracle Compute Cloud Service Compute - High Memory - OCPU Per Hour"
		},
		{ 
		"dailyUnitDisplayName":"Static IP Hours",
		"hourlyUnitDisplayName":"Static IP Hours",
		"rawUnitDisplayName":"number",
		"name":"EIPs",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/EIPs",
		"description":"Oracle Compute Cloud Service - Static IP - Static IP Per Hour"
		},
		{ 
		"dailyUnitDisplayName":"Static IP Hours",
		"hourlyUnitDisplayName":"Static IP Hours",
		"rawUnitDisplayName":"number",
		"name":"EIPs_UNATTACHED",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/EIPs_UNATTACHED",
		"description":"Oracle Compute Cloud Service - Unattached Static IP - Unattached Static IP Per Hour"
		},
		{ 
		"dailyUnitDisplayName":"GB Months",
		"hourlyUnitDisplayName":"GB Months",
		"rawUnitDisplayName":"number",
		"name":"BLOCK_STORAGE",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/BLOCK_STORAGE",
		"description":"Oracle Compute Cloud Service - Block Storage Capacity - Gigabyte Storage Capacity per Month"
		},
		{ 
		"dailyUnitDisplayName":"OCPU Hours",
		"hourlyUnitDisplayName":"OCPU Hours",
		"rawUnitDisplayName":"number",
		"name":"OCPU",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/OCPU",
		"description":"Oracle Compute Cloud Service - OCPU Per Hour"
		},
		{ 
		"dailyUnitDisplayName":"GB Months",
		"hourlyUnitDisplayName":"GB Months",
		"rawUnitDisplayName":"number",
		"name":"MEMORY_GB",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/MEMORY_GB",
		"description":"Oracle Compute Cloud Service - Instance Memory in GB per Month"
		},
		{ 
		"dailyUnitDisplayName":"High I/O OCPU Hours",
		"hourlyUnitDisplayName":"High I/O OCPU Hours",
		"rawUnitDisplayName":"number",
		"name":"OCPU_IO",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/OCPU_IO",
		"description":"Oracle Compute Cloud Service - High I/O Compute Capacity"
		},
		{ 
		"dailyUnitDisplayName":"GB Months",
		"hourlyUnitDisplayName":"GB Months",
		"rawUnitDisplayName":"number",
		"name":"BLOCK_STORAGE_SSD",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/BLOCK_STORAGE_SSD",
		"description":"Oracle Compute Cloud Service - High Performance Block Storage Capacity - Gigabyte Storage Capacity per Month"
		},
		{ 
		"dailyUnitDisplayName":"GCPU Hours",
		"hourlyUnitDisplayName":"GCPU Hours",
		"rawUnitDisplayName":"number",
		"name":"OCPU_GPU",
		"servicename":"Compute",
		"canonicalLink":"/metering/api/v1/resources/Compute/OCPU_GPU",
		"description":"Oracle Compute Cloud Service - Compute Capacity - GPU Instance - Metered - GCPU Per Hour"
		}
	],
"canonicalLink":"/metering/api/v1/resources/Compute"
}

Back to Top