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

These APIs are deprecated. See Cost Analysis Overview, Using the API for more information on how to track and optimize your Oracle Cloud Infrastructure spending. See the Deprecated Notices (Endpoints) to see if there is a replacement endpoint.

Back to Top