Dela via

Ersätt ett erbjudande

Om du vill ersätta en hel erbjudanderesurs utför du en PUT-åtgärd på den specifika erbjudanderesursen. Mer information om det högsta och lägsta etablerade dataflödet som kan anges för en container eller en databas finns i artikeln Etablera dataflöde för containrar och databaser .

Begäran

Metod Begäran om URI Beskrivning
LÄGG https://{databaseaccount}.documents.azure.com/offers/{_rid-offer} {databaseaccount} är namnet på det Azure Cosmos DB-konto som du skapade under din prenumeration. Värdet {_rid-offer} är det systemgenererade resurs-ID:t för erbjudandet.

Tips/Råd

Om du vill hitta _rid för erbjudandet som är associerat med en databas eller samling hämtar du först databasen eller hämtar samlingen och noterar resursens _rid egenskap. Fråga sedan erbjudandena för att hitta det _rid-erbjudande som motsvarar databasen eller samlingens _rid. Vanligtvis är en databas_rid längd 8, en samling _rid är längd 12 och ett erbjudande _rid är längd 4.

Rubriker

Se vanliga Azure Cosmos DB REST-begärandehuvuden för rubriker som används av alla Cosmos DB begäranden

Kropp

Fastighet Krävs Beskrivning
erbjudandeVersion Krävs Det kan vara V1 för de äldre S1-, S2- och S3-nivåerna och V2 för användardefinierade dataflödesnivåer (rekommenderas).
erbjudandetyp Valfritt Den här egenskapen gäller endast i V1-erbjudandeversionen. Ställ in den på S1, S2 eller S3 för V1-erbjudandetyper. Den är ogiltig för användardefinierade prestandanivåer eller etablerad dataflödesbaserad modell.
innehåll Krävs Innehåller information om erbjudandet – för V2-erbjudanden innehåller det här värdet samlingens dataflöde.
resurs Krävs När du skapar en ny samling anges den här egenskapen till samlingens självlänk, till exempel dbs/pLJdAA==/colls/pLJdAOlEdgA=/.
offerResourceId Krävs När du skapar en samling associeras den här egenskapen automatiskt med resurs-ID:t, det vill säga _rid för samlingen. I föregående exempel är _rid för samlingen pLJdAOlEdgA=.
ID Krävs Det är en systemgenererad egenskap. ID:t för erbjudanderesursen genereras automatiskt när den skapas. Den har samma värde som _rid för erbjudandet.
_rid Krävs Det är en systemgenererad egenskap. Resurs-ID :t (_rid) är en unik identifierare som också är hierarkisk per resursstacken i resursmodellen. Den används internt för placering och navigering av erbjudandet. 
{   
  "offerVersion": "V2",   
  "offerType": "Invalid",   
  "content": {   
    "offerThroughput": 4000   
  },   
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",   
  "offerResourceId": "rgkVAMHcJww=",   
  "id": "uT2L",   
  "_rid": "uT2L",   
}

Svar

Returnerar den uppdaterade erbjudanderesursen.

Rubriker

Se vanliga Azure Cosmos DB REST-svarshuvuden för rubriker som returneras av alla Cosmos DB svar.

Statuskoder

I följande tabell visas vanliga statuskoder som returneras av den här åtgärden. En fullständig lista över statuskoder finns i HTTP-statuskoder.

HTTP-statuskod Beskrivning
200 Okej Ersättningsåtgärden lyckades.
400 Felaktig begäran JSON-datan är ogiltig. Kontrollera om det saknas klammerparenteser eller citattecken.
401 Inte auktoriserad Rubriken Authorization eller x-ms-date har inte angetts. 401 returneras också när auktoriseringshuvudet är inställt på en ogiltig auktoriseringstoken.
404 – Hittades inte Erbjudandet är inte längre en resurs, d.v.s. resursen har tagits bort.
429 För många förfrågningar Ersättningserbjudandet begränsas eftersom nedskalningsåtgärden för erbjudandet görs inom tidsgränsen för inaktivitet som är 4 timmar. Se rubriken "x-ms-retry-after-ms response" för att se hur länge du bör vänta innan du försöker utföra den här åtgärden igen.

Kropp

Fastighet Beskrivning
erbjudandeVersion Det här värdet kan vara V1 för fördefinierade dataflödesnivåer och V2 för användardefinierade dataflödesnivåer.
erbjudandetyp Fördefinierade prestandanivåer S1, S2 eller S3 för V1-erbjudanden. Den är inställd på Ogiltig för användardefinierade prestandanivåer.
innehåll Den innehåller information om erbjudandet. För V2-erbjudanden innehåller den dataflödet för samlingen.
resurs När du skapar en ny samling anges den här egenskapen till samlingens självlänk, till exempel dbs/pLJdAA==/colls/pLJdAOlEdgA=/.
offerResourceId När du skapar en samling associeras den här egenskapen automatiskt med resurs-ID:t, det vill säga _rid för samlingen. I föregående exempel är _rid för samlingen pLJdAOlEdgA=.
ID Det är en systemgenererad egenskap. ID:t för erbjudanderesursen genereras automatiskt när den skapas. Den har samma värde som _rid för erbjudandet.
_rid Det är en systemgenererad egenskap. Resurs-ID :t (_rid) är en unik identifierare som också är hierarkisk per resursstacken i resursmodellen. Den används internt för placering och navigering av erbjudandet.
_ts Det är en systemgenererad egenskap. Den anger resursens senast uppdaterade tidsstämpel. Värdet är en tidsstämpel.
_själv Det är en systemgenererad egenskap. Det är den unika adresserbara URI:n för resursen.
_etag Det är en systemgenererad egenskap som anger den resurs-etag som krävs för optimistisk samtidighetskontroll. 
{  
  "offerVersion": "V2",  
  "_rid": "uT2L",
   "content": {  
    "offerThroughput": 4000
  }, 
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "offerResourceId": "rgkVAMHcJww=",  
  "id": "uT2L",  
  "_self": "offers/uT2L/"
}

Exempel 1

Det här exemplet visar hur du ändrar det manuella dataflödet (RU/s) för en samling till 1000 RU/s.

PUT https://querydemo.documents.azure.com/offers/uT2L HTTP/1.1 

x-ms-date: Tue, 29 Mar 2016 17:50:18 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dRdNwi9H3molMOsEoHXCUHa56N8U5eFDlfuewcSoiHgc%3d  
Cache-Control: no-cache  
User-Agent: contoso/1.0  
x-ms-version: 2015-12-16  
Accept: application/json  
Host: querydemo.documents.azure.com  
Content-Length: 234  
Expect: 100-continue  
  
{  
  "id": "uT2L",  
  "_rid": "uT2L",  
  "_self": "offers/uT2L/",  
  "offerVersion": "V2",  
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "content": {  
    "offerThroughput": 1000 
   }, 
  "offerResourceId": "rgkVAMHcJww="  
}

Här är ett exempel på ett svar.

HTTP/1.1 200 Ok  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Content-Location: https://querydemo.documents.azure.com/offers/uT2L  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Fri, 25 Mar 2016 22:54:09.213 GMT  
etag: "0000a900-0000-0000-0000-56fac05a0000"  
x-ms-schemaversion: 1.1  
x-ms-quorum-acked-lsn: 8110  
x-ms-current-write-quorum: 3  
x-ms-current-replica-set-size: 4  
x-ms-request-charge: 9.9  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: fa543c39-a64e-44bd-ba9a-c4f313a9d7d4  
x-ms-session-token: M:8111  
x-ms-gatewayversion: version=1.6.52.5  
Date: Tue, 29 Mar 2016 17:50:20 GMT  
  
{  
  "offerVersion": "V2",
  "_rid": "uT2L",  
  "content": {  
    "offerThroughput": 1000
  },
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "offerResourceId": "rgkVAMHcJww=",  
  "id": "uT2L",  
  "_self": "offers/uT2L/",  
  "_etag": "\"0000a900-0000-0000-0000-56fac05a0000\"",  
  "_ts": 1459273818  
}

Exempel 2

Det här exemplet visar hur du ändrar det maximala dataflödet (RU/s) för ett erbjudande med dataflöde för automatisk skalning till 8000 RU/s (skalar mellan 800 och 8000 RU/s)

PUT https://querydemo.documents.azure.com/offers/uT2L HTTP/1.1

x-ms-version: 2018-12-31
x-ms-date: Thu, 23 Jul 2020 00:04:41 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dRdNwi9H3molMOsEoHXCUHa56N8U5eFDlfuewcSoiHgc%3d  
Accept: application/json
Content-Type: application/json
User-Agent: contoso/1.0
Host: querydemo.documents.azure.com:443
Connection: keep-alive
Content-Length: 278

{   
  "offerVersion": "V2",   
  "offerType": "Invalid",   
  "content": {   
    "offerAutopilotSettings": {"maxThroughput": 8000}
  },
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "offerResourceId": "rgkVAMHcJww="  
  "id": "uT2L",  
  "_rid": "uT2L"
}

Exempel 3

Det här exemplet visar hur du migrerar ett erbjudande med manuellt dataflöde till dataflöde för automatisk skalning. Rubriken x-ms-cosmos-migrate-offer-to-autopilot med värdet true är obligatorisk.

Vid migrering avgör Azure Cosmos DB automatiskt det nya maximala antalet RU/s för autoskalning baserat på de aktuella resursinställningarna. Egenskapen maxThroughput i svarsobjektet representerar standardvärdet för maximalt antal RU:er för autoskalning som angetts av systemet.

I brödtexten content krävs egenskapen med en definierad offerThroughput , men värdet ignoreras av tjänsten. I följande exempel används -1.

När ändringen är klar kan du följa exempel 2 för att ändra max RU/s för autoskalning till ett anpassat värde.

Läs mer om att migrera till autoskalning.

PUT https://querydemo.documents.azure.com/offers/uT2L HTTP/1.1

x-ms-version: 2018-12-31
x-ms-date: Wed, 22 Jul 2020 23:33:41 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dRdNwi9H3molMOsEoHXCUHa56N8U5eFDlfuewcSoiHgc%3d  
Accept: application/json
x-ms-cosmos-migrate-offer-to-autopilot: true
Content-Type: application/json
User-Agent: contoso/1.0  
Host: querydemo.documents.azure.com  
Connection: keep-alive
Content-Length: 254

{   
  "offerVersion": "V2",   
  "offerType": "Invalid",   
  "content": {   
    "offerThroughput": -1  
  },
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "offerResourceId": "rgkVAMHcJww=",  
  "id": "uT2L",   
  "_rid": "uT2L"
}

Här är ett exempel på en svarstext.

Egenskapen maxThroughput representerar det maximala antalet RU:er för autoskalning som angetts av systemet. Egenskapen offerThroughput representerar de RU/s som systemet för närvarande skalas till.

{
    "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
    "offerType": "Invalid",
    "offerResourceId": "rgkVAMHcJww=",
    "offerVersion": "V2",
    "content": {
        "offerThroughput": 400,
        "offerIsRUPerMinuteThroughputEnabled": false,
        "offerMinimumThroughputParameters": {
            "maxThroughputEverProvisioned": 4000,
            "maxConsumedStorageEverInKB": 0
        },
        "offerLastReplaceTimestamp": 1595460122,
        "offerAutopilotSettings": {
            "maxThroughput": 4000
        }
    },
    "id": "uT2L",
    "_rid": "uT2L",
    "_self": "offers/uT2L/",
    "_etag": "\"2d002059-0000-0800-0000-5f18cbf80000\"",
    "_ts": 1595460600
}

Exempel 4

Det här exemplet visar hur du migrerar ett erbjudande med dataflöde för autoskalning till manuellt dataflöde. Rubriken x-ms-cosmos-migrate-offer-to-manual-throughput med värdet true är obligatorisk.

Vid migrering avgör Azure Cosmos DB automatiskt det nya manuella dataflödet (RU/s) baserat på de aktuella resursinställningarna. När ändringen är klar kan du följa exempel 1 för att ändra de manuella RU:erna till ett anpassat värde.

I brödtexten content krävs egenskapen med en definierad offerAutopilotSettings och maxThroughput , men värdet ignoreras av tjänsten. Här passerar vi i -1.

Läs mer om att migrera till manuellt dataflöde.

PUT https://querydemo.documents.azure.com/offers/uT2L HTTP/1.1  
x-ms-version: 2018-12-31
x-ms-date: Wed, 22 Jul 2020 23:43:03 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dRdNwi9H3molMOsEoHXCUHa56N8U5eFDlfuewcSoiHgc%3d  
Accept: application/json
x-ms-cosmos-migrate-offer-to-manual-throughput: true
Content-Type: application/json
User-Agent: contoso/1.0  
Host: querydemo.documents.azure.com
Connection: keep-alive
Content-Length: 280

{
  "offerVersion": "V2",
  "offerType": "Invalid",
  "content": {
    "offerAutopilotSettings": {"maxThroughput": -1}
  },
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "offerResourceId": "rgkVAMHcJww=",  
  "id": "uT2L",
  "_rid": "uT2L"
}

Här är ett exempel på en svarstext. Egenskapen offerThroughput representerar det manuella dataflödet (RU/s) som angetts för resursen.

{
    "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
    "offerType": "Invalid",
    "offerResourceId": "rgkVAMHcJww=",
    "offerVersion": "V2",
    "content": {
        "offerThroughput": 4000,
        "offerIsRUPerMinuteThroughputEnabled": false,
        "offerMinimumThroughputParameters": {
            "maxThroughputEverProvisioned": 4000,
            "maxConsumedStorageEverInKB": 0
        },
        "offerLastReplaceTimestamp": 1595461384
    },
    "id": "uT2L",
    "_rid": "uT2L",
    "_self": "offers/uT2L/",
    "_etag": "\"2d002359-0000-0800-0000-5f18cf080000\"",
    "_ts": 1595461384
}

Anmärkningar

När du ändrar dataflödet för manuell eller automatisk skalning på en databas eller container tillämpar systemet begränsningar för de RU/s som kan anges för resursen. Mer information om det lägsta och högsta etablerade dataflödet (RU/s) som kan anges med manuellt dataflöde finns i artikeln Etablera dataflöde för containrar och databaser . Mer information om det minsta antalet RU:er för autoskalning som du kan ange finns i vanliga frågor och svar om autoskalning.

Om du vill hämta det minsta dataflöde som kan anges för databasen eller containern utför du GET på erbjudanderesursen. Svarshuvudet x-ms-cosmos-min-throughput anger det minsta dataflöde som systemet har fastställt. Detta representerar det minsta värde som du kan ange för RU/s på en resurs med manuellt dataflöde, eller det lägsta värde som du kan ange för maximalt antal RU:er för autoskalning på en resurs med dataflöde för autoskalning.

Se även