Path Energy Traffic Ratio API (PETRA)

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶

This Internet-Draft will expire on 17 March 2024.¶

Copyright Notice

Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved.¶

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

3. Path Energy Traffic Ratio API (PETRA)

This section describes an API to query a network about the Energy Traffic Ratio for a given path. It takes as input the source and destination of a path along with the traffic throughput between and returns the Energy Traffic Ratio in Watts per Gigabit. This is energy computed by the infrastructure that is dynamically part of the traffic path. This document only describes the API, the computation of the Watts per Gigabit to return is out of the scope of this document. The API is modeled following the OpenAPI Specification.¶

openapi: 3.0.3
info:
  title: Energy API
  version: 1.0.0
paths:
  /energy:
    get:
      tags:
        - energy
      summary: Query the network for energy consupmtion
      description: ''
      operationId: energyQuery
      parameters:
        - name: src-ip
          in: query
          description: Source IP address
          required: true
          schema:
            type: string
        - name: dst-ip
          in: query
          description: Destination IP address
          required: true
          schema:
            type: string
        - name: throughput
          in: query
          description: Throughput between source and destination (in gigabits per second)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/energy'
        '400':
          description: Invalid source/destination IP address supplied
components:
  schemas:
    energy:
      type: object
      properties:
        watts-per-gigabit:
          type: number
          format: float

4. Security Considerations

TBD¶

5. Acknowledgments

Kudos to Elis Lulja for his help with the OpenAPI specification. Thanks to Fernando Sanz Garcia and Lori Jakab for their help and support on this work. The contribution of Telefonica to this work has been supported by the HORIZON-JU-SNS2022 Research and Innovation Action project 6Green (Grant Agreement no. 101096925).¶

6. IANA Considerations

This document makes no request to IANA.¶

Authors' Addresses