サイト管理用のREST API

機械翻訳について

サイトのバニティ・ドメインの作成または置換

put

/sites/management/api/v1/sites/{id}/vanityDomain

RELATION

サイトのバニティ・ドメインを作成または置換します。デフォルトでは、サイトにはバニティ・ドメインがありません。

リリース21.5.1で導入されました。

認可

この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:

所有者
マネージャ

構成ステータスの読取り

バニティ・ドメインはすぐにサイトに設定されますが、構成が完了するまで新しいバニティ・ドメインを使用してサイトにアクセスできません。バニティ・ドメインの構成が完了したかどうかを確認するには、バニティ・ドメインを読み、configurationStatusフィールドの値を確認します。

詳細は、「サイトのバニティ・ドメインの読取り」を参照してください。

パス代替識別子

「サイト」リソースのデフォルトの識別子は、「サイト識別子」です。サイト・リソースは代替識別子をサポートしています。

nameサイト名

サイト識別子のかわりに、サイト名を使用してリソース・パスのサイトを一意に識別できます。サイトのデフォルトのリソース・パス・パラメータはサイト識別子ですが、サイトでの作業時には判読可能なサイト名が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/vanityDomain

リリース19.4.1.での導入。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK - Set the Vanity Domain on a Site

サイトでドメインを設定します。バニティ・ドメインはサイト上でただちに設定されます。既存のバニティ・ドメインが存在する場合、それはオーバーライドされ、古いバニティ・ドメインを使用してサイトにアクセスできなくなります。バニティ・ドメインの構成ステータスは最初はprocessingで、構成が完了するまで新しいバニティ・ドメインを使用してサイトにアクセスできません。

リクエスト

PUT https://api.example.com/sites/management/api/v1/sites/{id}/vanityDomain

リクエスト本文

{
  "name": "cloud.example.com"
}

レスポンス本文

{
  "name": "cloud.example.com",
  "configurationStatus": "processing"
}

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

400Bad Request - Invalid Site Vanity Domain

指定されたサイト・バニティ・ドメインには許可されていない文字が含まれているため、使用できません。

エラー・コード

OCE-SITEMGMT-009116

解決 - チェック文字

ドメイン名には、アルファベット文字(A-Z)、数字(0-9)、マイナス記号(-)およびピリオド(.)のみを使用できます。パスが含まれている場合は、有効なURI文字を含める必要があります。 RFC 3986のセクション2を参照してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名	説明
`name`	サイト・バニティ・ドメイン名が無効です。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidSiteVanityDomainExceptionDetailスキーマを参照してください。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Vanity Domain",
  "status": "400",
  "detail": "The site vanity domain name cannot be used because it contains characters that are not allowed.",
  "o:errorCode": "OCE-SITEMGMT-009116",
  "name": "example_domain.com"
}

リリース21.5.1で導入されました。

403Forbidden - Site Operation Forbidden

サイト内で共有ロールを持つユーザーは、この操作を実行できません。

エラー・コード

OCE-SITEMGMT-009026

解決 - 共有ロールの変更

認証ユーザーに付与された共有ロールを必要なロール以上に変更します。

解決 - アプリケーション・ロールの変更

ユーザーにStandardユーザーまたはエンタープライズ・ユーザー・アプリケーション・ロールがあることを確認します。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名	説明
`site`	操作が実行されているサイト。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteOperationForbiddenExceptionDetailスキーマを参照してください。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Operation Forbidden",
  "status": "403",
  "detail": "You do have a sharing role in this site, but your role does not allow you to use this operation.",
  "o:errorCode": "OCE-SITEMGMT-009026",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

リリース19.1.5.での導入。

404Not Found - Site Not Found

サイトが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションがサイトへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009003

解決 - 識別子のチェック

サイト識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証済ユーザーがサイトのメンバーまたはサイト管理者であることを確認します。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名	説明
`site`	存在しないか、認証されたユーザーが参照できないサイトです。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Not Found",
  "status": "404",
  "detail": "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-009003",
  "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"
}

409競合 - Starter Editionバニティ・ドメインはサポートされていません

Starter Editionでは、サイト・バニティ・ドメインを追加できません。

エラー・コード

OCE-SITEMGMT-009118

解決 - Premiumにアップグレード

Premiumにアップグレードして、サイト・バニティ・ドメインのサポートを有効にします。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Starter Edition Vanity Domain Not Supported",
  "status": "409",
  "detail": "Starter edition will not allow you to add a site vanity domain.",
  "o:errorCode": "OCE-SITEMGMT-009118"
}

リリース21.6.1で導入されました。

409競合 - インスタンス・バニティ・ドメインの競合

指定されたサイトのバニティ・ドメインは、インスタンス・レベルのバニティ・ドメインとして使用されているため使用できません。

エラー・コード

OCE-SITEMGMT-009120

解決 - 代替の使用

ドメインをインスタンス・レベルのバニティ・ドメインと同じにすることはできません。別のバニティ・ドメイン名を選択します。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Instance Vanity Domain Conflict",
  "status": "409",
  "detail": "The provided site vanity domain cannot be used because it is being used as the instance level vanity domain.",
  "o:errorCode": "OCE-SITEMGMT-009120"
}

リリース21.7.1で導入されました。

409競合 - バニティ・ドメイン構成はサポートされていません

バニティ・ドメイン構成は使用できません。

エラー・コード

OCE-SITEMGMT-009127

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Vanity Domain Configuration Not Supported",
  "status": "409",
  "detail": "Vanity domain configuration is only available in OCI-N environments.",
  "o:errorCode": "OCE-SITEMGMT-009127"
}

リリース21.9.1で導入されました。

このリソースは、サイトとバニティ・ドメイン・リソースの関係を表します。バニティ・ドメインが削除されているか、認証されたユーザーがリソースの読取りを承認されていない場合、レスポンス・ステータス・コードは「404見つかりません」になり、レスポンス本文に「関係が見つかりません」エラーが返されます。

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

id: string

サイトの不変の識別子。

設定するバニティ・ドメイン。

ルート・スキーマ: schema

型: object

ソースを表示

links(optional): array links

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
name: string

このサイトのバニティ・ドメイン。
リリース21.5.1で導入されました。

{
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "name":{
            "description":"<p>The vanity domain for this site.</p><small>Introduced in release 21.5.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "name":"cloud.example.com"
    }
}

例:

{
    "name":"cloud.example.com"
}

ネストされたスキーマ: links

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

ネストされたスキーマ: items

すべてに一致

認可

構成ステータスの読取り

パス代替識別子

nameサイト名

成功したレスポンスの例

200OK - Set the Vanity Domain on a Site

リクエスト

リクエスト本文

レスポンス本文

クライアント・エラー・レスポンスの例

400Bad Request - Invalid Site Vanity Domain

エラー・コード

解決 - チェック文字

例外詳細フィールド

レスポンス本文の例

403Forbidden - Site Operation Forbidden

エラー・コード

解決 - 共有ロールの変更

解決 - アプリケーション・ロールの変更

例外詳細フィールド

レスポンス本文の例

404Not Found - Site Not Found

エラー・コード

解決 - 識別子のチェック

解決 - メンバーシップのチェック

例外詳細フィールド

レスポンス本文の例

404Not Found - Relationship Not Found

エラー・コード

レスポンス本文の例

409競合 - Starter Editionバニティ・ドメインはサポートされていません

エラー・コード

解決 - Premiumにアップグレード

レスポンス本文の例

409競合 - インスタンス・バニティ・ドメインの競合

エラー・コード

解決 - 代替の使用

レスポンス本文の例

409競合 - バニティ・ドメイン構成はサポートされていません

エラー・コード

レスポンス本文の例

リクエスト

レスポンス

200レスポンス

400レスポンス

401レスポンス

403レスポンス

404レスポンス

406レスポンス

409レスポンス

413 レスポンス

415 レスポンス

416 レスポンス

429 レスポンス

500レスポンス

501レスポンス

502 レスポンス

503レスポンス

504レスポンス