| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.v1.html">v1</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#getDomains">getDomains(x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#getEntities">getEntities(x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#getHelp">getHelp(x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Get help information for the RDAP API, including links to documentation.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#getIp">getIp(x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#getNameservers">getNameservers(x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="getDomains">getDomains(x__xgafv=None)</code> |
| 95 | <pre>The RDAP API recognizes this command from the RDAP specification but |
| 96 | does not support it. The response is a formatted 501 error. |
| 97 | |
| 98 | Args: |
| 99 | x__xgafv: string, V1 error format. |
| 100 | Allowed values |
| 101 | 1 - v1 error format |
| 102 | 2 - v2 error format |
| 103 | |
| 104 | Returns: |
| 105 | An object of the form: |
| 106 | |
| 107 | { # Response to a general RDAP query. |
| 108 | "lang": "A String", # Error language code. Error response info fields are defined in [section 6 |
| 109 | # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6). |
| 110 | "jsonResponse": { # Message that represents an arbitrary HTTP body. It should only be used for # HTTP response with content type set to "application/json+rdap". |
| 111 | # payload formats that can't be represented as JSON, such as raw binary or |
| 112 | # an HTML page. |
| 113 | # |
| 114 | # |
| 115 | # This message can be used both in streaming and non-streaming API methods in |
| 116 | # the request as well as the response. |
| 117 | # |
| 118 | # It can be used as a top-level request field, which is convenient if one |
| 119 | # wants to extract parameters from either the URL or HTTP template into the |
| 120 | # request fields and also want access to the raw HTTP body. |
| 121 | # |
| 122 | # Example: |
| 123 | # |
| 124 | # message GetResourceRequest { |
| 125 | # // A unique request id. |
| 126 | # string request_id = 1; |
| 127 | # |
| 128 | # // The raw HTTP body is bound to this field. |
| 129 | # google.api.HttpBody http_body = 2; |
| 130 | # } |
| 131 | # |
| 132 | # service ResourceService { |
| 133 | # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| 134 | # rpc UpdateResource(google.api.HttpBody) returns |
| 135 | # (google.protobuf.Empty); |
| 136 | # } |
| 137 | # |
| 138 | # Example with streaming methods: |
| 139 | # |
| 140 | # service CaldavService { |
| 141 | # rpc GetCalendar(stream google.api.HttpBody) |
| 142 | # returns (stream google.api.HttpBody); |
| 143 | # rpc UpdateCalendar(stream google.api.HttpBody) |
| 144 | # returns (stream google.api.HttpBody); |
| 145 | # } |
| 146 | # |
| 147 | # Use of this type only changes how the request and response bodies are |
| 148 | # handled, all other features will continue to work unchanged. |
| 149 | "extensions": [ # Application specific response metadata. Must be set in the first response |
| 150 | # for streaming APIs. |
| 151 | { |
| 152 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 153 | }, |
| 154 | ], |
| 155 | "data": "A String", # The HTTP request/response body as raw binary. |
| 156 | "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| 157 | }, |
| 158 | "errorCode": 42, # Error HTTP code. Example: "501". |
| 159 | "title": "A String", # Error title. |
| 160 | "notices": [ # Notices applying to this response. |
| 161 | { # Notices object defined in [section 4.3 of RFC |
| 162 | # 7483](https://tools.ietf.org/html/rfc7483#section-4.3). |
| 163 | "type": "A String", # Type values defined in [section 10.2.1 of RFC |
| 164 | # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a |
| 165 | # whole response: "result set truncated due to authorization", "result set |
| 166 | # truncated due to excessive load", "result set truncated due to |
| 167 | # unexplainable reasons". |
| 168 | "links": [ # Link to a document containing more information. |
| 169 | { # Links object defined in [section 4.2 of RFC |
| 170 | # 7483](https://tools.ietf.org/html/rfc7483#section-4.2). |
| 171 | "title": "A String", # Title of this link. Example: "title". |
| 172 | "href": "A String", # Target URL of a link. Example: "http://example.com/previous". |
| 173 | "hreflang": "A String", # Language code of a link. Example: "en". |
| 174 | "type": "A String", # Content type of the link. Example: "application/json". |
| 175 | "media": "A String", # Media type of the link destination. Example: "screen". |
| 176 | "value": "A String", # URL giving context for the link. Example: "http://example.com/current". |
| 177 | "rel": "A String", # Relation type of a link. Example: "previous". |
| 178 | }, |
| 179 | ], |
| 180 | "title": "A String", # Title of a notice. Example: "Terms of Service". |
| 181 | "description": [ # Description of the notice. |
| 182 | "A String", |
| 183 | ], |
| 184 | }, |
| 185 | ], |
| 186 | "description": [ # Error description. |
| 187 | "A String", |
| 188 | ], |
| 189 | "rdapConformance": [ # RDAP conformance level. |
| 190 | "A String", |
| 191 | ], |
| 192 | }</pre> |
| 193 | </div> |
| 194 | |
| 195 | <div class="method"> |
| 196 | <code class="details" id="getEntities">getEntities(x__xgafv=None)</code> |
| 197 | <pre>The RDAP API recognizes this command from the RDAP specification but |
| 198 | does not support it. The response is a formatted 501 error. |
| 199 | |
| 200 | Args: |
| 201 | x__xgafv: string, V1 error format. |
| 202 | Allowed values |
| 203 | 1 - v1 error format |
| 204 | 2 - v2 error format |
| 205 | |
| 206 | Returns: |
| 207 | An object of the form: |
| 208 | |
| 209 | { # Response to a general RDAP query. |
| 210 | "lang": "A String", # Error language code. Error response info fields are defined in [section 6 |
| 211 | # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6). |
| 212 | "jsonResponse": { # Message that represents an arbitrary HTTP body. It should only be used for # HTTP response with content type set to "application/json+rdap". |
| 213 | # payload formats that can't be represented as JSON, such as raw binary or |
| 214 | # an HTML page. |
| 215 | # |
| 216 | # |
| 217 | # This message can be used both in streaming and non-streaming API methods in |
| 218 | # the request as well as the response. |
| 219 | # |
| 220 | # It can be used as a top-level request field, which is convenient if one |
| 221 | # wants to extract parameters from either the URL or HTTP template into the |
| 222 | # request fields and also want access to the raw HTTP body. |
| 223 | # |
| 224 | # Example: |
| 225 | # |
| 226 | # message GetResourceRequest { |
| 227 | # // A unique request id. |
| 228 | # string request_id = 1; |
| 229 | # |
| 230 | # // The raw HTTP body is bound to this field. |
| 231 | # google.api.HttpBody http_body = 2; |
| 232 | # } |
| 233 | # |
| 234 | # service ResourceService { |
| 235 | # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| 236 | # rpc UpdateResource(google.api.HttpBody) returns |
| 237 | # (google.protobuf.Empty); |
| 238 | # } |
| 239 | # |
| 240 | # Example with streaming methods: |
| 241 | # |
| 242 | # service CaldavService { |
| 243 | # rpc GetCalendar(stream google.api.HttpBody) |
| 244 | # returns (stream google.api.HttpBody); |
| 245 | # rpc UpdateCalendar(stream google.api.HttpBody) |
| 246 | # returns (stream google.api.HttpBody); |
| 247 | # } |
| 248 | # |
| 249 | # Use of this type only changes how the request and response bodies are |
| 250 | # handled, all other features will continue to work unchanged. |
| 251 | "extensions": [ # Application specific response metadata. Must be set in the first response |
| 252 | # for streaming APIs. |
| 253 | { |
| 254 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 255 | }, |
| 256 | ], |
| 257 | "data": "A String", # The HTTP request/response body as raw binary. |
| 258 | "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| 259 | }, |
| 260 | "errorCode": 42, # Error HTTP code. Example: "501". |
| 261 | "title": "A String", # Error title. |
| 262 | "notices": [ # Notices applying to this response. |
| 263 | { # Notices object defined in [section 4.3 of RFC |
| 264 | # 7483](https://tools.ietf.org/html/rfc7483#section-4.3). |
| 265 | "type": "A String", # Type values defined in [section 10.2.1 of RFC |
| 266 | # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a |
| 267 | # whole response: "result set truncated due to authorization", "result set |
| 268 | # truncated due to excessive load", "result set truncated due to |
| 269 | # unexplainable reasons". |
| 270 | "links": [ # Link to a document containing more information. |
| 271 | { # Links object defined in [section 4.2 of RFC |
| 272 | # 7483](https://tools.ietf.org/html/rfc7483#section-4.2). |
| 273 | "title": "A String", # Title of this link. Example: "title". |
| 274 | "href": "A String", # Target URL of a link. Example: "http://example.com/previous". |
| 275 | "hreflang": "A String", # Language code of a link. Example: "en". |
| 276 | "type": "A String", # Content type of the link. Example: "application/json". |
| 277 | "media": "A String", # Media type of the link destination. Example: "screen". |
| 278 | "value": "A String", # URL giving context for the link. Example: "http://example.com/current". |
| 279 | "rel": "A String", # Relation type of a link. Example: "previous". |
| 280 | }, |
| 281 | ], |
| 282 | "title": "A String", # Title of a notice. Example: "Terms of Service". |
| 283 | "description": [ # Description of the notice. |
| 284 | "A String", |
| 285 | ], |
| 286 | }, |
| 287 | ], |
| 288 | "description": [ # Error description. |
| 289 | "A String", |
| 290 | ], |
| 291 | "rdapConformance": [ # RDAP conformance level. |
| 292 | "A String", |
| 293 | ], |
| 294 | }</pre> |
| 295 | </div> |
| 296 | |
| 297 | <div class="method"> |
| 298 | <code class="details" id="getHelp">getHelp(x__xgafv=None)</code> |
| 299 | <pre>Get help information for the RDAP API, including links to documentation. |
| 300 | |
| 301 | Args: |
| 302 | x__xgafv: string, V1 error format. |
| 303 | Allowed values |
| 304 | 1 - v1 error format |
| 305 | 2 - v2 error format |
| 306 | |
| 307 | Returns: |
| 308 | An object of the form: |
| 309 | |
| 310 | { # Message that represents an arbitrary HTTP body. It should only be used for |
| 311 | # payload formats that can't be represented as JSON, such as raw binary or |
| 312 | # an HTML page. |
| 313 | # |
| 314 | # |
| 315 | # This message can be used both in streaming and non-streaming API methods in |
| 316 | # the request as well as the response. |
| 317 | # |
| 318 | # It can be used as a top-level request field, which is convenient if one |
| 319 | # wants to extract parameters from either the URL or HTTP template into the |
| 320 | # request fields and also want access to the raw HTTP body. |
| 321 | # |
| 322 | # Example: |
| 323 | # |
| 324 | # message GetResourceRequest { |
| 325 | # // A unique request id. |
| 326 | # string request_id = 1; |
| 327 | # |
| 328 | # // The raw HTTP body is bound to this field. |
| 329 | # google.api.HttpBody http_body = 2; |
| 330 | # } |
| 331 | # |
| 332 | # service ResourceService { |
| 333 | # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| 334 | # rpc UpdateResource(google.api.HttpBody) returns |
| 335 | # (google.protobuf.Empty); |
| 336 | # } |
| 337 | # |
| 338 | # Example with streaming methods: |
| 339 | # |
| 340 | # service CaldavService { |
| 341 | # rpc GetCalendar(stream google.api.HttpBody) |
| 342 | # returns (stream google.api.HttpBody); |
| 343 | # rpc UpdateCalendar(stream google.api.HttpBody) |
| 344 | # returns (stream google.api.HttpBody); |
| 345 | # } |
| 346 | # |
| 347 | # Use of this type only changes how the request and response bodies are |
| 348 | # handled, all other features will continue to work unchanged. |
| 349 | "extensions": [ # Application specific response metadata. Must be set in the first response |
| 350 | # for streaming APIs. |
| 351 | { |
| 352 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 353 | }, |
| 354 | ], |
| 355 | "data": "A String", # The HTTP request/response body as raw binary. |
| 356 | "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| 357 | }</pre> |
| 358 | </div> |
| 359 | |
| 360 | <div class="method"> |
| 361 | <code class="details" id="getIp">getIp(x__xgafv=None)</code> |
| 362 | <pre>The RDAP API recognizes this command from the RDAP specification but |
| 363 | does not support it. The response is a formatted 501 error. |
| 364 | |
| 365 | Args: |
| 366 | x__xgafv: string, V1 error format. |
| 367 | Allowed values |
| 368 | 1 - v1 error format |
| 369 | 2 - v2 error format |
| 370 | |
| 371 | Returns: |
| 372 | An object of the form: |
| 373 | |
| 374 | { # Message that represents an arbitrary HTTP body. It should only be used for |
| 375 | # payload formats that can't be represented as JSON, such as raw binary or |
| 376 | # an HTML page. |
| 377 | # |
| 378 | # |
| 379 | # This message can be used both in streaming and non-streaming API methods in |
| 380 | # the request as well as the response. |
| 381 | # |
| 382 | # It can be used as a top-level request field, which is convenient if one |
| 383 | # wants to extract parameters from either the URL or HTTP template into the |
| 384 | # request fields and also want access to the raw HTTP body. |
| 385 | # |
| 386 | # Example: |
| 387 | # |
| 388 | # message GetResourceRequest { |
| 389 | # // A unique request id. |
| 390 | # string request_id = 1; |
| 391 | # |
| 392 | # // The raw HTTP body is bound to this field. |
| 393 | # google.api.HttpBody http_body = 2; |
| 394 | # } |
| 395 | # |
| 396 | # service ResourceService { |
| 397 | # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| 398 | # rpc UpdateResource(google.api.HttpBody) returns |
| 399 | # (google.protobuf.Empty); |
| 400 | # } |
| 401 | # |
| 402 | # Example with streaming methods: |
| 403 | # |
| 404 | # service CaldavService { |
| 405 | # rpc GetCalendar(stream google.api.HttpBody) |
| 406 | # returns (stream google.api.HttpBody); |
| 407 | # rpc UpdateCalendar(stream google.api.HttpBody) |
| 408 | # returns (stream google.api.HttpBody); |
| 409 | # } |
| 410 | # |
| 411 | # Use of this type only changes how the request and response bodies are |
| 412 | # handled, all other features will continue to work unchanged. |
| 413 | "extensions": [ # Application specific response metadata. Must be set in the first response |
| 414 | # for streaming APIs. |
| 415 | { |
| 416 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 417 | }, |
| 418 | ], |
| 419 | "data": "A String", # The HTTP request/response body as raw binary. |
| 420 | "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| 421 | }</pre> |
| 422 | </div> |
| 423 | |
| 424 | <div class="method"> |
| 425 | <code class="details" id="getNameservers">getNameservers(x__xgafv=None)</code> |
| 426 | <pre>The RDAP API recognizes this command from the RDAP specification but |
| 427 | does not support it. The response is a formatted 501 error. |
| 428 | |
| 429 | Args: |
| 430 | x__xgafv: string, V1 error format. |
| 431 | Allowed values |
| 432 | 1 - v1 error format |
| 433 | 2 - v2 error format |
| 434 | |
| 435 | Returns: |
| 436 | An object of the form: |
| 437 | |
| 438 | { # Response to a general RDAP query. |
| 439 | "lang": "A String", # Error language code. Error response info fields are defined in [section 6 |
| 440 | # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6). |
| 441 | "jsonResponse": { # Message that represents an arbitrary HTTP body. It should only be used for # HTTP response with content type set to "application/json+rdap". |
| 442 | # payload formats that can't be represented as JSON, such as raw binary or |
| 443 | # an HTML page. |
| 444 | # |
| 445 | # |
| 446 | # This message can be used both in streaming and non-streaming API methods in |
| 447 | # the request as well as the response. |
| 448 | # |
| 449 | # It can be used as a top-level request field, which is convenient if one |
| 450 | # wants to extract parameters from either the URL or HTTP template into the |
| 451 | # request fields and also want access to the raw HTTP body. |
| 452 | # |
| 453 | # Example: |
| 454 | # |
| 455 | # message GetResourceRequest { |
| 456 | # // A unique request id. |
| 457 | # string request_id = 1; |
| 458 | # |
| 459 | # // The raw HTTP body is bound to this field. |
| 460 | # google.api.HttpBody http_body = 2; |
| 461 | # } |
| 462 | # |
| 463 | # service ResourceService { |
| 464 | # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| 465 | # rpc UpdateResource(google.api.HttpBody) returns |
| 466 | # (google.protobuf.Empty); |
| 467 | # } |
| 468 | # |
| 469 | # Example with streaming methods: |
| 470 | # |
| 471 | # service CaldavService { |
| 472 | # rpc GetCalendar(stream google.api.HttpBody) |
| 473 | # returns (stream google.api.HttpBody); |
| 474 | # rpc UpdateCalendar(stream google.api.HttpBody) |
| 475 | # returns (stream google.api.HttpBody); |
| 476 | # } |
| 477 | # |
| 478 | # Use of this type only changes how the request and response bodies are |
| 479 | # handled, all other features will continue to work unchanged. |
| 480 | "extensions": [ # Application specific response metadata. Must be set in the first response |
| 481 | # for streaming APIs. |
| 482 | { |
| 483 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 484 | }, |
| 485 | ], |
| 486 | "data": "A String", # The HTTP request/response body as raw binary. |
| 487 | "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| 488 | }, |
| 489 | "errorCode": 42, # Error HTTP code. Example: "501". |
| 490 | "title": "A String", # Error title. |
| 491 | "notices": [ # Notices applying to this response. |
| 492 | { # Notices object defined in [section 4.3 of RFC |
| 493 | # 7483](https://tools.ietf.org/html/rfc7483#section-4.3). |
| 494 | "type": "A String", # Type values defined in [section 10.2.1 of RFC |
| 495 | # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a |
| 496 | # whole response: "result set truncated due to authorization", "result set |
| 497 | # truncated due to excessive load", "result set truncated due to |
| 498 | # unexplainable reasons". |
| 499 | "links": [ # Link to a document containing more information. |
| 500 | { # Links object defined in [section 4.2 of RFC |
| 501 | # 7483](https://tools.ietf.org/html/rfc7483#section-4.2). |
| 502 | "title": "A String", # Title of this link. Example: "title". |
| 503 | "href": "A String", # Target URL of a link. Example: "http://example.com/previous". |
| 504 | "hreflang": "A String", # Language code of a link. Example: "en". |
| 505 | "type": "A String", # Content type of the link. Example: "application/json". |
| 506 | "media": "A String", # Media type of the link destination. Example: "screen". |
| 507 | "value": "A String", # URL giving context for the link. Example: "http://example.com/current". |
| 508 | "rel": "A String", # Relation type of a link. Example: "previous". |
| 509 | }, |
| 510 | ], |
| 511 | "title": "A String", # Title of a notice. Example: "Terms of Service". |
| 512 | "description": [ # Description of the notice. |
| 513 | "A String", |
| 514 | ], |
| 515 | }, |
| 516 | ], |
| 517 | "description": [ # Error description. |
| 518 | "A String", |
| 519 | ], |
| 520 | "rdapConformance": [ # RDAP conformance level. |
| 521 | "A String", |
| 522 | ], |
| 523 | }</pre> |
| 524 | </div> |
| 525 | |
| 526 | </body></html> |