blob: 0bf444c8e83e66f021f7d50756615ffc928e6b57 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="domainsrdap_v1.html">Domains RDAP API</a> . <a href="domainsrdap_v1.ip.html">ip</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(ipId, ipId1, x__xgafv=None)</a></code></p>
79<p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="get">get(ipId, ipId1, x__xgafv=None)</code>
83 <pre>The RDAP API recognizes this command from the RDAP specification but
84does not support it. The response is a formatted 501 error.
85
86Args:
87 ipId: string, A parameter (required)
88 ipId1: string, A parameter (required)
89 x__xgafv: string, V1 error format.
90 Allowed values
91 1 - v1 error format
92 2 - v2 error format
93
94Returns:
95 An object of the form:
96
97 { # Response to a general RDAP query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070098 &quot;notices&quot;: [ # Notices applying to this response.
99 { # Notices object defined in [section 4.3 of RFC
100 # 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700101 &quot;description&quot;: [ # Description of the notice.
102 &quot;A String&quot;,
103 ],
104 &quot;type&quot;: &quot;A String&quot;, # Type values defined in [section 10.2.1 of RFC
105 # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a
106 # whole response: &quot;result set truncated due to authorization&quot;, &quot;result set
107 # truncated due to excessive load&quot;, &quot;result set truncated due to
108 # unexplainable reasons&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109 &quot;title&quot;: &quot;A String&quot;, # Title of a notice. Example: &quot;Terms of Service&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700110 &quot;links&quot;: [ # Link to a document containing more information.
111 { # Links object defined in [section 4.2 of RFC
112 # 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700113 &quot;media&quot;: &quot;A String&quot;, # Media type of the link destination. Example: &quot;screen&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700114 &quot;href&quot;: &quot;A String&quot;, # Target URL of a link. Example: &quot;http://example.com/previous&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700115 &quot;value&quot;: &quot;A String&quot;, # URL giving context for the link. Example: &quot;http://example.com/current&quot;.
116 &quot;title&quot;: &quot;A String&quot;, # Title of this link. Example: &quot;title&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700117 &quot;hreflang&quot;: &quot;A String&quot;, # Language code of a link. Example: &quot;en&quot;.
118 &quot;type&quot;: &quot;A String&quot;, # Content type of the link. Example: &quot;application/json&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700119 &quot;rel&quot;: &quot;A String&quot;, # Relation type of a link. Example: &quot;previous&quot;.
120 },
121 ],
122 },
123 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 &quot;jsonResponse&quot;: { # Message that represents an arbitrary HTTP body. It should only be used for # HTTP response with content type set to &quot;application/json+rdap&quot;.
125 # payload formats that can&#x27;t be represented as JSON, such as raw binary or
126 # an HTML page.
127 #
128 #
129 # This message can be used both in streaming and non-streaming API methods in
130 # the request as well as the response.
131 #
132 # It can be used as a top-level request field, which is convenient if one
133 # wants to extract parameters from either the URL or HTTP template into the
134 # request fields and also want access to the raw HTTP body.
135 #
136 # Example:
137 #
138 # message GetResourceRequest {
139 # // A unique request id.
140 # string request_id = 1;
141 #
142 # // The raw HTTP body is bound to this field.
143 # google.api.HttpBody http_body = 2;
144 # }
145 #
146 # service ResourceService {
147 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
148 # rpc UpdateResource(google.api.HttpBody) returns
149 # (google.protobuf.Empty);
150 # }
151 #
152 # Example with streaming methods:
153 #
154 # service CaldavService {
155 # rpc GetCalendar(stream google.api.HttpBody)
156 # returns (stream google.api.HttpBody);
157 # rpc UpdateCalendar(stream google.api.HttpBody)
158 # returns (stream google.api.HttpBody);
159 # }
160 #
161 # Use of this type only changes how the request and response bodies are
162 # handled, all other features will continue to work unchanged.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700163 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
Bu Sun Kim65020912020-05-20 12:08:20 -0700164 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
165 # for streaming APIs.
166 {
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168 },
169 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700170 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
171 },
172 &quot;errorCode&quot;: 42, # Error HTTP code. Example: &quot;501&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700173 &quot;lang&quot;: &quot;A String&quot;, # Error language code. Error response info fields are defined in [section 6
174 # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
175 &quot;description&quot;: [ # Error description.
176 &quot;A String&quot;,
177 ],
178 &quot;title&quot;: &quot;A String&quot;, # Error title.
179 &quot;rdapConformance&quot;: [ # RDAP conformance level.
180 &quot;A String&quot;,
181 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700182 }</pre>
183</div>
184
185</body></html>