サイトのバニティ・ドメインの読取り
/sites/management/api/v1/sites/{id}/vanityDomain
サイトのバニティ・ドメインが設定されている場合は、そのドメインを確認します。 デフォルトでは、サイトにはバニティ・ドメインがありません。 バニティ・ドメインの構成が完了したかどうかを確認するには、configurationStatus
フィールドを読み取ります。
リリース21.5.1で導入されました。
認可
この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:
- 所有者
- マネージャ
- 貢献者
- ダウンロード実行者
- ビューア
パス代替識別子
「サイト」リソースのデフォルトの識別子は、「サイト識別子」です。 サイト・リソースは代替識別子をサポートしています。
nameサイト名
サイト識別子のかわりに、サイト名を使用してリソース・パスのサイトを一意に識別できます。 サイトのデフォルトのリソース・パス・パラメータはサイト識別子ですが、サイトでの作業時には判読可能なサイト名が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/vanityDomain
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
200OK - Vanity Domain Configuration Completed
構成が完了したサイトのバニティ・ドメインを読み取ります。
リクエスト
GET https://api.example.com/sites/management/api/v1/sites/{id}/vanityDomain
レスポンス本文
{ "name": "cloud.example.com", "configurationStatus": "completed" }
200 OK - バニティ・ドメイン構成の処理
追加されているが構成されているサイトのバニティ・ドメインを読み取ります。 これは、設定後のバニティ・ドメインの初期状態になります。
リクエスト
GET https://api.example.com/sites/management/api/v1/sites/{id}/vanityDomain
レスポンス本文
{ "name": "cloud.example.com", "configurationStatus": "processing" }
200 OK - バニティ・ドメインの構成に失敗しました
構成に失敗したサイトのバニティ・ドメインを読み取ります。 構成が失敗した場合、バニティ・ドメインを再度設定して再試行できます。
リクエスト
GET https://api.example.com/sites/management/api/v1/sites/{id}/vanityDomain
レスポンス本文
{ "name": "cloud.example.com", "configurationStatus": "failed" }
クライアント・エラー・レスポンスの例
この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
404見つかりません - バニティ・ドメインが見つかりません
サイトにバニティ・ドメインがないか、サイトが存在しないか、サイトが削除されているか、認証されたユーザーまたはクライアント・アプリケーションにサイトへのアクセス権がありません。
エラー・コード
OCE-SITEMGMT-009114
解決 - バニティ・ドメインの追加
バニティ・ドメインをサイトに追加します。 デフォルトでは、サイトにはバニティ・ドメインがありません。
解決 - 識別子のチェック
サイト識別子が有効であることを確認してください。
解決 - メンバーシップのチェック
認証済ユーザーがサイトのメンバーまたはサイト管理者であることを確認します。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | バニティ・ドメインを読み取ることができないサイト。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのVanityDomainNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Vanity Domain Not Found", "status": "404", "detail": "Site does not have a vanity domain, or the site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.", "o:errorCode": "OCE-SITEMGMT-009114", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
404Not Found - Relationship Not Found
関係が存在しないため、関係を読み取ろうとしましたが失敗しました。 関係が存在しなくなった場合、または認証されたアイデンティティが関係の詳細の読取りを承認されていない場合に、関係の読取りが失敗する可能性があります。
エラー・コード
PAAS-005027
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Relationship Not Found", "status": "404", "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.", "o:errorCode": "PAAS-005027" }
このリソースは、サイトとバニティ・ドメイン・リソースの関係を表します。 バニティ・ドメインが削除されているか、認証されたユーザーがリソースの読取りを承認されていない場合、レスポンス・ステータス・コードは「404見つかりません」になり、レスポンス本文に「関係が見つかりません」エラーが返されます。
リクエスト
- id: string
サイトの不変の識別子。
- excludeFields(optional): string
レスポンスに含めないフィールド名のカンマ区切り文字列。
- excludeLinks(optional): string
レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。
- fields(optional): string
レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。
- includeDeleted(optional): boolean
削除対象としてマークされているリソースでは、この問合せパラメータが
true
に設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。includeDeleted
問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。 - links(optional): string
レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。
次のリンクは、このリソースにより提供されます:
リンク関係 説明 parent
親リソースが読取り可能な場所を示します。 このリンクは up
リンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。self
リソースの現在の戻り表現を示します。 リソース自体を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。 canonical
リクエストされたリソースの優先表現を示します。 リソースの標準的な形式を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。 describedBy
リソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。 スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。 - return(optional): string
レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。 表現が指定されない場合、
fields
、excludeFields
、links
、excludeLinks
およびexpand
問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。次の表現は、
return
問合せパラメータでサポートされています:表現 説明 representation
フル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。 default
デフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。 basic
基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。 minimal
最小リソース表現。必須プロパティとリンクなしが含まれます。
レスポンス
- application/json
- application/vnd.oracle.resource+json;type=singular
200レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- allOf VanityDomain
サイトのバニティ・ドメインを定義します。 構成すると、サイト・ドメインの代わりにバニティ・ドメインを使用してサイトにアクセスできます。
リリース21.5.1で導入されました。
サイトのバニティ・ドメインを定義します。 構成すると、サイト・ドメインの代わりにバニティ・ドメインを使用してサイトにアクセスできます。
リリース21.5.1で導入されました。- object SingularResource
すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
- object VanityDomain-allOf[1]
object
すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
- links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
object
- configurationStatus(optional): string
このバニティ・ドメインの構成ステータス。 ドメインは設定されるとすぐにユーザーが使用できなくなり、使用可能にするための構成が完了するまでに最大60分かかる場合があります。
有効な値は次のとおりです。
-
processing
- バニティ・ドメイン構成は処理中です -
completed
- バニティ・ドメインの構成が完了しました -
failed
- バニティ・ドメインの構成に失敗しました
-
- name(optional): string
このサイトのバニティ・ドメイン。
リリース21.5.1で導入されました。
array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
object
REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのself
リンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
- href(optional): string
ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。 値がURIテンプレートに設定されている場合、
templated
プロパティをtrue
に設定する必要があります。 - mediaType(optional): string
メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
- method(optional): string
リンクのターゲットをリクエストするためのHTTPメソッド。
有効な値は次のとおりです。
-
OPTIONS
- HTTP OPTIONS -
HEAD
- HTTP HEAD -
GET
- HTTP GET -
POST
- HTTP POST -
PUT
- HTTP PUT -
PATCH
- HTTP PATCH -
DELETE
- HTTP DELETE
-
- profile(optional): string(uri)
ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
- rel(optional): string
リンクの詳細を取得するために使用できるリンク・リレーションの名前。
- templated(optional): boolean
href
プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。 プロパティが存在しない場合、false
とみなすことができます。
{
"name":"cloud.example.com",
"configurationStatus":"completed"
}
400レスポンス
401レスポンス
403レスポンス
404レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object VanityDomainNotFoundExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- site(optional): string
バニティ・ドメインを読み取ることができないサイト。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Vanity Domain Not Found",
"status":"404",
"detail":"Site does not have a vanity domain, or the site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
"o:errorCode":"OCE-SITEMGMT-009114",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Relationship Not Found",
"status":"404",
"detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
"o:errorCode":"PAAS-005027"
}