Skip to content

Latest commit

 

History

History
223 lines (141 loc) · 8.95 KB

InfraServicesAPI.md

File metadata and controls

223 lines (141 loc) · 8.95 KB
Raw

InfraServicesAPI

All URIs are relative to https://csp.infoblox.com/api/atcdfp/v1

Method HTTP request Description
CreateOrUpdateDfpService Put /dfp_services/{payload.service_id} Update DNS Forwarding Proxy services.
ListDfpServices Get /dfp_services List DNS Forwarding Proxy services.
ReadDfpService Get /dfp_services/{service_id} Read DNS Forwarding Proxy services.

CreateOrUpdateDfpService

DfpCreateOrUpdateResponse CreateOrUpdateDfpService(ctx, payloadServiceId).Body(body).Execute()

Update DNS Forwarding Proxy services.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/dfp"
)

func main() {
	payloadServiceId := "payloadServiceId_example" // string | The DNS Forwarding Proxy Service ID object identifier.
	body := *dfp.NewDfpCreateOrUpdatePayload() // DfpCreateOrUpdatePayload | The DNS Forwarding Proxy object.

	apiClient := dfp.NewAPIClient()
	resp, r, err := apiClient.InfraServicesAPI.CreateOrUpdateDfpService(context.Background(), payloadServiceId).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InfraServicesAPI.CreateOrUpdateDfpService``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateOrUpdateDfpService`: DfpCreateOrUpdateResponse
	fmt.Fprintf(os.Stdout, "Response from `InfraServicesAPI.CreateOrUpdateDfpService`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
payloadServiceId string The DNS Forwarding Proxy Service ID object identifier.

Other Parameters

Other parameters are passed through a pointer to a InfraServicesAPICreateOrUpdateDfpServiceRequest struct via the builder pattern

Name Type Description Notes
body DfpCreateOrUpdatePayload The DNS Forwarding Proxy object.

Return type

DfpCreateOrUpdateResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListDfpServices

DfpListResponse ListDfpServices(ctx).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Execute()

List DNS Forwarding Proxy services.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/dfp"
)

func main() {

	apiClient := dfp.NewAPIClient()
	resp, r, err := apiClient.InfraServicesAPI.ListDfpServices(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InfraServicesAPI.ListDfpServices``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListDfpServices`: DfpListResponse
	fmt.Fprintf(os.Stdout, "Response from `InfraServicesAPI.ListDfpServices`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a InfraServicesAPIListDfpServicesRequest struct via the builder pattern

Name Type Description Notes
filter string A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields: Name
fields string A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names.
offset int32 The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
limit int32 The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
pageToken string The service-defined string used to identify a page of resources. A null value indicates the first page.

Return type

DfpListResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadDfpService

DfpReadResponse ReadDfpService(ctx, serviceId).Id(id).Fields(fields).Name(name).Execute()

Read DNS Forwarding Proxy services.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/dfp"
)

func main() {
	serviceId := "serviceId_example" // string | The On-Prem Application Service identifier. For internal Use only

	apiClient := dfp.NewAPIClient()
	resp, r, err := apiClient.InfraServicesAPI.ReadDfpService(context.Background(), serviceId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InfraServicesAPI.ReadDfpService``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ReadDfpService`: DfpReadResponse
	fmt.Fprintf(os.Stdout, "Response from `InfraServicesAPI.ReadDfpService`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId string The On-Prem Application Service identifier. For internal Use only

Other Parameters

Other parameters are passed through a pointer to a InfraServicesAPIReadDfpServiceRequest struct via the builder pattern

Name Type Description Notes
id int32 The DNS Forwarding Proxy object identifier.
fields string A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names.
name string The name of the DNS Forwarding Proxy. Used only if the 'id' field is empty.

Return type

DfpReadResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]